1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
\r
2 .. http://creativecommons.org/licenses/by/4.0
\r
4 .. _dmaap-connection-objects:
\r
6 DMaaP connection objects
\r
7 ========================
\r
9 DMaaP Connection objects are generated by the DCAE Platform at runtime
\r
10 and passed to the component in its application_configuration
\r
12 .. _dmaap-message-router:
\r
17 Publishers and subscribers have the same generated
\r
18 ``Dmaap Connection Object`` structure. Here’s an example for any given
\r
19 config-key: (This is what will be in application_configuration)
\r
24 "type": "message_router",
\r
25 "aaf_username": "some-user",
\r
26 "aaf_password": "some-password",
\r
28 "client_role": "com.dcae.member",
\r
29 "client_id": "1500462518108",
\r
30 "location": "mtc00",
\r
31 "topic_url": "https://we-are-message-router.us:3905/events/some-topic"
\r
37 +--------------------------------+---------+---------------------------+
\r
38 | Property Name | Type | Description |
\r
39 +================================+=========+===========================+
\r
40 | type | string | *Required as input*. Must |
\r
41 | | | be ``message_router`` for |
\r
42 | | | message router topics |
\r
43 +--------------------------------+---------+---------------------------+
\r
44 | aaf_username | string | AAF username message |
\r
45 | | | router clients use to |
\r
46 | | | authenticate with secure |
\r
48 +--------------------------------+---------+---------------------------+
\r
49 | aaf_password | string | AAF password message |
\r
50 | | | router clients use to |
\r
51 | | | authenticate with secure |
\r
53 +--------------------------------+---------+---------------------------+
\r
54 | dmaap_info | JSON | *Required as input*. |
\r
55 | | object | Contains the topic |
\r
56 | | | connection details |
\r
57 +--------------------------------+---------+---------------------------+
\r
59 The ``dmaap_info`` object contains:
\r
61 +--------------------------------+---------+---------------------------+
\r
62 | Property Name | Type | Description |
\r
63 +================================+=========+===========================+
\r
64 | client_role | string | AAF client role that’s |
\r
65 | | | requesting publish or |
\r
66 | | | subscribe access to the |
\r
68 +--------------------------------+---------+---------------------------+
\r
69 | client_id | string | Client id for given AAF |
\r
71 +--------------------------------+---------+---------------------------+
\r
72 | location | string | DCAE location for the |
\r
73 | | | publisher or subscriber, |
\r
74 | | | used to set up routing |
\r
75 +--------------------------------+---------+---------------------------+
\r
76 | topic_url | string | *Required as input*. URL |
\r
77 | | | for accessing the topic |
\r
78 | | | to publish or receive |
\r
80 +--------------------------------+---------+---------------------------+
\r
84 .. _dmaap-data-router:
\r
92 Here’s an example of what the generated ``Dmaap Connection Object`` for
\r
93 Data Router Publisher looks like: (This is what will be in
\r
94 application_configuration)
\r
99 "type": "data_router",
\r
101 "location": "mtc00",
\r
102 "publish_url": "https://we-are-data-router.us/feed/xyz",
\r
103 "log_url": "https://we-are-data-router.us/feed/xyz/logs",
\r
104 "username": "some-user",
\r
105 "password": "some-password",
\r
106 "publisher_id": "123456"
\r
112 +--------------------------------+---------+---------------------------+
\r
113 | Property Name | Type | Description |
\r
114 +================================+=========+===========================+
\r
115 | type | string | *Required as input*. Must |
\r
116 | | | be ``data_router`` for |
\r
117 | | | data router feeds |
\r
118 +--------------------------------+---------+---------------------------+
\r
119 | dmaap_info | JSON | *Required as input*. |
\r
120 | | object | Contains the feed |
\r
121 | | | connection details |
\r
122 +--------------------------------+---------+---------------------------+
\r
124 The ``dmaap_info`` object contains:
\r
126 +--------------------------------+---------+---------------------------+
\r
127 | Property Name | Type | Description |
\r
128 +================================+=========+===========================+
\r
129 | location | string | DCAE location for the |
\r
130 | | | publisher, used to set up |
\r
132 +--------------------------------+---------+---------------------------+
\r
133 | publish_url | string | *Required as input*. URL |
\r
134 | | | to which the publisher |
\r
135 | | | makes Data Router publish |
\r
137 +--------------------------------+---------+---------------------------+
\r
138 | log_url | string | URL from which log data |
\r
139 | | | for the feed can be |
\r
141 +--------------------------------+---------+---------------------------+
\r
142 | username | string | Username the publisher |
\r
143 | | | uses to authenticate to |
\r
144 | | | Data Router |
\r
145 +--------------------------------+---------+---------------------------+
\r
146 | password | string | Password the publisher |
\r
147 | | | uses to authenticate to |
\r
148 | | | Data Router |
\r
149 +--------------------------------+---------+---------------------------+
\r
150 | publisher_id | string | Publisher id in Data |
\r
152 +--------------------------------+---------+---------------------------+
\r
158 Here’s an example of what the generated ``Dmaap Connection Object`` for
\r
159 a Data Router Subscriber looks like: (This is what will be passed in
\r
160 application_configuration)
\r
165 "type": "data_router",
\r
167 "location": "mtc00",
\r
168 "delivery_url": "https://my-subscriber-app.dcae:8080/target-path",
\r
169 "username": "some-user",
\r
170 "password": "some-password",
\r
171 "subscriber_id": "789012"
\r
177 +--------------------------------+---------+---------------------------+
\r
178 | Property Name | Type | Description |
\r
179 +================================+=========+===========================+
\r
180 | type | string | *Required as input*. Must |
\r
181 | | | be ``data_router`` for |
\r
182 | | | data router feeds |
\r
183 +--------------------------------+---------+---------------------------+
\r
184 | dmaap_info | JSON | *Required as input*. |
\r
185 | | object | Contains the feed |
\r
186 | | | connection details |
\r
187 +--------------------------------+---------+---------------------------+
\r
189 The ``dmaap_info`` object contains:
\r
191 +--------------------------------+---------+---------------------------+
\r
192 | Property Name | Type | Description |
\r
193 +================================+=========+===========================+
\r
194 | location | string | DCAE location for the |
\r
195 | | | subscriber, used to set |
\r
197 +--------------------------------+---------+---------------------------+
\r
198 | delivery_url | string | URL to which the Data |
\r
199 | | | Router should deliver |
\r
201 +--------------------------------+---------+---------------------------+
\r
202 | username | string | Username Data Router uses |
\r
203 | | | to authenticate to the |
\r
204 | | | subscriber when |
\r
205 | | | delivering files |
\r
206 +--------------------------------+---------+---------------------------+
\r
207 | password | string | Password Data Router uses |
\r
208 | | | to authenticate to the |
\r
209 | | | subscriber when |
\r
210 | | | delivering files |
\r
211 +--------------------------------+---------+---------------------------+
\r
212 | subscriber_id | string | Subscriber id in Data |
\r
214 +--------------------------------+---------+---------------------------+
\r