<< Click to Display Table of Contents >> Navigation: Development > Client > Redis/JSON > Project Command |
Project Commands are perform operations on DTS projects. Clients can use Project Commands to Open and Close projects.
•The Open Project Command is sent by the Client to the Controller to request access to resources belonging to a specific DTS project. It also triggers the Controller to initialize producers and setup support structures for managing and serving requests for that project.
•The Close Project Command is sent by the Client to the Controller to inform it that it no longer needs a certain project. The Controller will only discard the project resources if no Clients require them for a set amount of time.
Request |
|
Outgoing |
|
Target channel |
"DTS:MIDDLEWARE:CHANNEL" |
Payload Class Key |
"DTS_PRJ_COMMAND_REQ" |
{
"name" : "",
"projectName" : ""
}
Attribute |
Value |
Note |
name |
The name of the command |
For Clients, either "DTS_PRJ_OPEN_COMMAND" or "DTS_PRJ_CLOSE_COMMAND" |
projectName |
The name of the project the command targets |
|
Response |
|
Incoming |
|
Target channel: |
request replyToChannel |
Payload Class Key: |
"STRING" or array of "STRING" |
Open Project Commands are responded to with an array of strings representing the names of the connectors the project contains. This does not imply that the connectors are now ready for usage, simply that they are recognized and are being initialized if they are not yet available. Each connector's availability is announced to the client by an individual Connector Command, outlined below.
Close Project Commands are simply responded to with the "DONE" acknowledgment string.
For error responses, the payload will be null and the error details will be included in the response message's error attribute.