What is a YOUnite Adaptor
YOUnite Adaptors are essentially extensions to the YOUnite DataHub, allowing access to where managed data is delivered to and retrieved from. 3rd . Third parties implement these adaptors using the YOUnite Adaptor SDK. Adaptors are a fundamental component to federated data domains.
...
For more information on YOUnite adaptors see:
Introductions to Adaptors Adaptors can be found on the Introduction to YOUnite page and the Adaptors page.
...
The YOUnite API Documentation can be found at https://younite.us/api
...
How to Get Started
An adaptor is implemented using To implement an adaptor you use the YOUnite Adaptor SDK (SDK). The SDK takes care of quite a bit of the complexity behind the scenes, but there are still a few things developers will need to be aware of... namely some handles much of the behind-the-scenes complexity, but developers still need to manage: configuration elements, the life cycle, and the proper use of the SDK Annotations.The first step is to get
- Get the actual YOUnite Adaptor SDK. For Java, the most common
...
- method is to use the YOUnite-provided Maven artifact
...
- . If you don't use Maven, you can optionally download the SDK library directly. <TODO Kevin: Link here to latest sdk jar file>.
...
- Use the following Maven configuration
...
- :
| Code Block |
|---|
<dependencies>
<dependency>
<groupId>com.younite</groupId>
<artifactId>adaptor-sdk</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
</dependencies> |
3. You will also need to add a server to your project POM to access the YOUnite Maven Repository: <TODO KEVIN: ONCE YOUNITE MAVEN REPO IS WORKING... INSERT INFO BELOW>
| Code Block |
|---|
<repositories> <repository> <id>younite-snapshots</id> <name>younite</name> <url>https://younite.bintray.com/</url> </repository> </repositories> |
4. Once you have these configured in your project POM, the YOUnite Adaptor SDK will be available for you to get started with.
Dependencies
The YOUnite Adaptor SDK aims to be a very small, easy-to-use library. As such, it has been part of the design goal to avoid depending on external libraries as much as possible. But sometimes , it is better to use well-designed and tested libraries to perform menial work than attempting to roll your own. As such, the YOUnite Adaptor SDK depends on only has one library it depends on (the Google Reflections library) so as to have a minimal impact on integrating integration within existing applications that may use the same libraries, possibly of different versions. The This dependency is the Google Reflections library. This library provides run-time reflection capabilities needed to find and resolve classes and methods.
...
Once an adaptor is connected to the YOUnite DataHub through the YOUnite Message Bus, it is able to send and receive data and ops messages. However, to streamline an adaptor developers time, the SDK has a minimal configuration step so that developers can focus on the business logic their adaptor is being built for and not the inner workings of sending and receiving messages, parsing those messages, and so on. To facilitate this, the YOUnite Adaptor SDK makes use of annotations developers use to define the capabilities related to the data their adaptor can produce and/or consume. These capabilities loosely translate into a Pub/Sub configuration on the YOUnite DataHub. Essentially they indicate to the YOUnite DataHub the specific domain properties they are interested in receiving changes for, and which of their own domain properties they will push out to the YOUnite DataHub when a change occurs within the associated local service(s) the adaptor is implemented to work with or domain properties requested by the YOUnite DataHub. These local services could be direct database data, an FTP server, in-memory data, or a remote service with data. In fact, the dynamic nature of YOUnite domains leave the details to individual adaptor implementations to determine how they access and retrieve domain property data and any transformations they may want to apply to the data.
...