Beacon Adapter API is a component of the Java Beacon Development Kit (JBDK) which is used by developers to implement GA4GH's beacon specification found here. It enables developers to create adapter components that can easily be swapped out of a REST-Implementation to configure different data sources with minimal configuration.
The project consists of a single interface, with supporting exceptions and utility classes. The interface exposes the adapter-api that developers can use to create their own custom adapters with minimal configuration to the rest of the JBDK.
An adapter works as a bridge between the rest service layer and a data source, meaning that the service layer does not need to know any details about where the data comes from, or how its implemented. By decoupling these two components the user can effectually "swap in" any adapter to their REST implementation with zero additional configuration!
Implementing a custom adapter is easy:
- Add this project as a dependency to your project's pom
- Implement the BeaconAdapter
- Add your project as a dependency to the beacon-java-rest project's pom