...
| Code Block | ||
|---|---|---|
| ||
{
"uuid": "3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a",
"zoneUuid": "3c9000a9-3eb6-41fe-a11b-5a5859020c65",
"clientId": "64ed6954-3987-4020-9553-54d9e4e7d258",
"clientSecret": "76e33a67-8e8c-4209-ae38-5e4fa59fd452"
} |
Configuring an Adaptor
Properties from the above response body and other information need to be added to the adaptor's TODO file:
TODO: TABLE of KEY: VALUES
Example:
...
The following is a list of the minimum properties needed by an adaptor. Consult the adaptors documentation for a defnitive list and property names since they can change from adaptor to adaptor:
| Property | Description | Example Value |
|---|---|---|
| className | Transport implementation class | com.younite.adaptor.sdk.transport.amq.AMQConnect |
| zoneUuid | UUID of the zone this adaptor belongs to | 6ab9380f-d7f2-477c-b93c-3a762e70095e |
| adaptorUuid | UUID of the adaptor | de02e3fa-d7f2-477c-aed6-5665a16e73d3 |
| 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 Server to validate adaptor access credentials | http://oauth-server-uri |
Example:
| Code Block | ||
|---|---|---|
| ||
# Configuration
# Transport implementation class
className: com.younite.adaptor.sdk.transport.amq.AMQConnect
# UUID of the zone this adaptor belongs to
zoneUuid: 6ab9380f-d7f2-477c-b93c-3a762e70095e
# Adaptor UUID
adaptorUuid: de02e3fa-d7f2-477c-aed6-5665a16e73d3
# ClientID and Secret to be used by JMS to verify adaptor has valid access to message bus (and API)
clientId: 8c9167a6-bb83-4f77-bdfc-1947a946f77b
clientSecret: de02e3fa-4b23-46cb-aed6-5665a16e73d3
# Message Broker URL
brokerUrl: nio+ssl://192.2.200.25:61617
# OAUTH Server to validate adaptor access credentials
oauthServerUrl: http://192.2.200.15 |
Adaptors States
Once an adaptor is added it is in the "Posted" state. The adaptors moves between states as follows:
...
| 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 adaptors had a:
|
| Pause | The adaptors 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. |
Start the Adaptor - Connect to the Hub
...