Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejs
{
	"name": "My First Adaptor"
}

Adaptor configuration (metadata) and capabilities can be added. Most adaptors self-register their capabilities but there may be a need to override them. The metadata must be in JSON format and the capabilities JSON schema can be seen below (TODO - More on capabilities):

Code Block
languagejava
{
	"name": "My First Adaptor",
	"description": "Our very first adaptor",
	"metadata": {
		"jdbcDriver": "com.mysql.jdbc.Driver",
		"dbUrl": "jdbc: mysql: //localhost/EMP"
	},
	"capabilities": [{
		"action": "GET",
		"direction": "IN",
		"domainVersionUuid": "cf7a0ad4-efe5-4618-8590-ae9c670da9c6"
	}, {
		"action": "PUT",
		"direction": "IN",
		"domainVersionUuid": "cf7a0ad4-efe5-4618-8590-ae9c670da9c6"
	}, {
		"action": "PUT",
		"direction": "IN",
		"domainVersionUuid": "cf7a0ad4-efe5-4618-8590-ae9c670da9c6"
	}, {
		"action": "GET",
		"direction": "OUT",
		"domainVersionUuid": "cf7a0ad4-efe5-4618-8590-ae9c670da9c6"
	}, {
		"action": "PUT",
		"direction": "OUT",
		"domainVersionUuid": "cf7a0ad4-efe5-4618-8590-ae9c670da9c6"
	}, {
		"action": "POST",
		"direction": "OUT",
		"domainVersionUuid": "cf7a0ad4-efe5-4618-8590-ae9c670da9c6"
	}, {
		"action": "DELETE",
		"direction": "OUT",
		"domainVersionUuid": "cf7a0ad4-efe5-4618-8590-ae9c670da9c6"
	}]
}

The response would look similar to:

...

StateDescription
PostedAdaptor is successfully POSTed. An API consumer can make this request or it can be done through the YOUnite UI.
Configured

The adaptor has:

  • Connected successfully to the YOUnite Datahub via the message bus/broker
  • Subscribed to the appropriate message broker topics
  • Created its message broker queue
PauseThe adaptor is running but not accepting adaptor (read/write) requests.

Play Read-Only

The adaptor is accepting read requests only.
PlayThe adaptor is accepting read and write requests.


An adaptor state can be changed using the request:

Anchor
opsAdaptorState
opsAdaptorState

...

Code Block
languagejs
DELETE /zones/661f5d76-6bc7-4fc0-97fd-f331ab683379/adaptors/3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a

Note: When you delete an adaptor it is a soft delete (meaning the adaptor's "active" setting will be set to false). A soft-delete for entities avoids purging important information, including that which can be used to associate past activity in the system, such as logged events, zone, and adaptor type.

However, the linking (mapping) between the (YOUnite) Data Record and the source entities in the source system attached to the deleted adaptor will be hard deletes. Linking for deleted adaptors is hard-deleted as this particular data carries no useful additional data or metadata (the link entities are just an adaptorUuid and a drUuid).  Post-delete, an adaptor's linking history can still be viewed in system logs that should include all the relevant details about that link, as well as a log timestamp.


Get Credentials for an Adaptor

...