|
<< Click to Display Table of Contents >> Navigation: Development > Client > Redis/JSON > Registration Command |
The Registration Command is the first message any DTS component must send to the Controller. Its purpose is to make the component known to the Controller, to request further communication parameters and to authenticate if the DTS environment is secured.
Request |
|
Outgoing |
|
Target channel |
"DTS:MIDDLEWARE:CHANNEL" |
Payload Class Key |
"DTS_REGISTER_COMPONENT_REQ_COMMAND" |
{
"projectName" : "",
"sessionName" : "",
"authentication" : "",
"component" : {
"componentType" : "",
"category" : "",
"variety" : "",
"connectorName" : "",
"threadCount" : "",
"metadataProducer" : false
}
}
Attribute |
Value |
Note |
|
projectName |
The name of the project this component will serve |
Not applicable for Client Registration |
|
sessionName |
The human readable name of this session |
Standard for clients is "[given_name]@[hostname]" |
|
authentication |
The authentication package |
Only required for secured deployments - content must be in the format shown in Registration and Authentication |
|
component |
Wrapper for the component description |
|
|
|
componentType |
The type of component being registered |
For clients, this is "DTS:CLIENT:CONSUMER" |
|
category |
|
For clients, this is "DTS:INTERNAL" |
|
variety |
|
Not applicable for Client Registration |
|
connectorName |
|
Not applicable for Client Registration |
|
threadCount |
|
Not applicable for Client Registration |
|
metadataProducer |
|
Not applicable for Client Registration |
Response |
|
Incoming |
|
Target channel: |
request replyToChannel |
Payload Class Key: |
"DTS_REGISTER_COMPONENT_RESPONSE" |
{
"id" : "",
"channel" : "",
"controllerKey" : "",
"componentKey" : "",
"securitySignature" : ""
}
Attribute |
Value |
Note |
id |
The id the Controller assigns to the Component |
|
channel |
The Redis channel the Controller assigns to the component |
This is the channel that the Controller will use to send requests to the component from here on |
controllerKey |
The AES key for the controller channel (DTS:MIDDLEWARE:CHANNEL) - encrypted using the component's public key and Base64 encoded |
Only for secured deployments. All messages sent by the client on the controller channel will need to be encrypted using this key |
componentKey |
The AES key for the component's channel (i.e. channel) - encrypted using the component's public key and Base64 encoded |
Only for secured deployments. All messages sent to the client on its channel will be encrypted using this key |
securitySignature |
The RSA signature included in the request's authentication package - encrypted using the component's public key and Base64 encoded |
Only for secured deployments. The purpose of returning the security signature in this way is for the component to know it is dealing with an authentic Controller |