...
- Register an Adaptor using the YOUnite API, which will generate the necessary configuration details the Adaptor will need at startup time.
- Develop an adaptor in your development environment using a YOUnite Adaptor SDK (see YOUnite Adaptor Guide for Java Developers).
- Deploy the adaptor on a server (e.g. on a physical server, virtual server, instance, container, etc.) that has access to the YOUnite message bus.
- Connect the adaptor to the native data store or service that it is connect to YOUnite (e.g. CRM, MIS, SIS, DB, etc.).
- Configure the adaptor with the details from step 1 "Register an Adaptor" above.
- Start the adaptor so it can connect to the YOUnite DataHub over the YOUnite Message Bus.
- Change an adaptor's state.
- Pause
- Play
- Play Read Only
- Manage the adaptor.
- Delete an Adaptor
- Get new Credentials for an adaptor
Step 1 ("Adding an Adaptor") and steps 5 through 8 are covered on this page, as steps 2 . Steps 2 through 4 are implementation-specific.
...
Adding an adaptor merely informs the data hub Data Hub that there is an intention to add an adaptor to a zone. Only users with POST /zones/zone-uuid/adaptors permissions can add in adaptor to a zone. By default only the Zone Data Steward (ZDS) has this permission.
...
| Code Block | ||
|---|---|---|
| ||
{
"uuid": "3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a",
"zoneUuid": "3c9000a9-3eb6-41fe-a11b-5a5859020c65",
"clientId": "8c9167a6-bb83-4f77-bdfc-1947a946f77b",
"clientSecret": "de02e3fa-4b23-46cb-aed6-5665a16e73d3"
} |
Note: Steps 2 through 4 are implementation specific. After they are completed, continue on to step 5, below.
5. Configuring an Adaptor
...
| Property | Description | Example Value |
|---|---|---|
| className | Transport implementation class (should be a constant value if using the YOUnite Java SDK). | com.younite.adaptor.sdk.transport.amq.AMQConnect |
| zoneUuid | UUID of the zone this adaptor belongs to | 3c9000a9-3eb6-41fe-a11b-5a5859020c65 |
| adaptorUuid | UUID of the adaptor | 3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a |
| clientId | ClientID returned from POST /adaptors used to connect to message broker | 8c9167a6-bb83-4f77-bdfc-1947a946f77b |
| clientSecret | Secret returned from POST /adaptors used to connect to message broker | de02e3fa-4b23-46cb-aed6-5665a16e73d3 |
| brokerUrl | Message Broker URL | nio+ssl://message-broker-uri:61617 |
| oauthServerUrl | OAUTH OAuth Server to validate adaptor access credentials. YOUnite runs an embedded OAuth server that your implementation may be using. By default it runs on port 8080 so, in this case the value would be http://ip-address-of-the-YOUnite-datahub:8080 | http://oauth-server-uri |
...
| State | Description |
|---|---|
| Posted | Adaptor is successfully POSTed. An API consumer can make this request or it can be done through the YOUnite UI. |
| Configured | The adaptor has:
|
| Pause | The adaptor is running but not accepting adaptor (read/write) requests. |
Play Read-Only | The adaptor is accepting read requests only. |
| Play | The adaptor is accepting read and write requests. |
An adaptor state can be changed using the request:
...