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
5 ========================
\r
7 DMaaP connection objects are JSON objects that:
\r
9 1. Components should expect at runtime in their application
\r
10 configuration and is to be used to connect to the appropriate DMaaP
\r
12 2. Developers must provide through the command-line argument
\r
13 ``--dmaap-file`` to test their component with manually provisioned
\r
16 This page is a reference to the specific structure that each type of
\r
17 DMaaP stream requires.
\r
19 Note for #1 that components should expect the entire object with all
\r
20 properties at runtime where the default will be ``null`` unless
\r
21 specified otherwise.
\r
23 Note for #2 that developers are not required to provide the entire
\r
24 object. The required properties will be labeled with “*required as
\r
27 .. _dmaap-message-router:
\r
32 Publishers and subscribers both have the same JSON object structure.
\r
38 "type": "message_router",
\r
39 "aaf_username": "some-user",
\r
40 "aaf_password": "some-password",
\r
42 "client_role": "com.dcae.member",
\r
43 "client_id": "1500462518108",
\r
44 "location": "mtc00",
\r
45 "topic_url": "https://we-are-message-router.us:3905/events/some-topic"
\r
52 +-------------+----+--------------------+
\r
53 | Property | Ty\| Descript\ |
\r
55 +=============+====+====================+
\r
56 | type | st\| *Require\ |
\r
61 | | | ``message_router`` |
\r
66 +-------------+----+--------------------+
\r
67 | aaf_usernam\| st\| AAF |
\r
68 | e | ri\| username |
\r
78 +-------------+----+--------------------+
\r
79 | aaf_passwor\| st\| AAF |
\r
80 | d | ri\| password |
\r
90 +-------------+----+--------------------+
\r
91 | dmaap_info | JS\| *Require\ |
\r
101 +-------------+----+--------------------+
\r
103 The ``dmaap_info`` object contains:
\r
105 +-------------+----+----------+
\r
106 | Property | Ty\| Descript\|
\r
107 | Name | pe | ion |
\r
108 +=============+====+==========+
\r
109 | client_role | st\| AAF |
\r
122 +-------------+----+----------+
\r
123 | client_id | st\| Client |
\r
128 +-------------+----+----------+
\r
129 | location | st\| DCAE |
\r
130 | | ri\| location |
\r
140 +-------------+----+----------+
\r
141 | topic_url | st\| *Require\|
\r
154 +-------------+----+----------+
\r
156 Here’s an example of the minimal JSON that must be provided as an input:
\r
161 "type": "message_router",
\r
163 "topic_url": "https://we-are-message-router.us:3905/events/some-topic"
\r
167 .. _dmaap-data-router:
\r
175 Here’s an example of what the JSON object connection for data router
\r
176 publisher looks like:
\r
181 "type": "data_router",
\r
183 "location": "mtc00",
\r
184 "publish_url": "https://we-are-data-router.us/feed/xyz",
\r
185 "log_url": "https://we-are-data-router.us/feed/xyz/logs",
\r
186 "username": "some-user",
\r
187 "password": "some-password",
\r
188 "publisher_id": "123456"
\r
194 +-------------+----+----------------+
\r
195 | Property | Ty\| Descript\ |
\r
196 | Name | pe | ion |
\r
197 +=============+====+================+
\r
198 | type | st\| *Require\ |
\r
203 | | | ``data_router``|
\r
207 +-------------+----+----------------+
\r
208 | dmaap_info | JS\| *Require\ |
\r
212 | | ct | Contains |
\r
218 +-------------+----+----------------+
\r
220 The ``dmaap_info`` object contains:
\r
222 +-------------+----+----------+
\r
223 | Property | Ty\| Descript\|
\r
224 | Name | pe | ion |
\r
225 +=============+====+==========+
\r
226 | location | st\| DCAE |
\r
227 | | ri\| location |
\r
234 +-------------+----+----------+
\r
235 | publish_url | st\| *Require\|
\r
249 +-------------+----+----------+
\r
250 | log_url | st\| URL from |
\r
252 | | ng | log data |
\r
257 +-------------+----+----------+
\r
258 | username | st\| Username |
\r
260 | | ng | publishe\|
\r
267 +-------------+----+----------+
\r
268 | password | st\| Password |
\r
270 | | ng | publishe\|
\r
277 +-------------+----+----------+
\r
278 | publisher_i | st\| Publishe\|
\r
283 +-------------+----+----------+
\r
285 Here’s an example of the minimal JSON that must be provided as an input:
\r
290 "type": "data_router",
\r
292 "publish_url": "https://we-are-data-router.us/feed/xyz"
\r
299 Here’s an example of what the JSON object connection for data router
\r
300 subscriber looks like:
\r
305 "type": "data_router",
\r
307 "location": "mtc00",
\r
308 "delivery_url": "https://my-subscriber-app.dcae:8080/target-path",
\r
309 "username": "some-user",
\r
310 "password": "some-password",
\r
311 "subscriber_id": "789012"
\r
317 +-------------+----+----------------+
\r
318 | Property | Ty\| Descript\ |
\r
319 | Name | pe | ion |
\r
320 +=============+====+================+
\r
321 | type | st\| *Require\ |
\r
326 | | | ``data_router``|
\r
330 +-------------+----+----------------+
\r
331 | dmaap_info | JS\| *Require\ |
\r
335 | | ct | Contains |
\r
341 +-------------+----+----------------+
\r
343 The ``dmaap_info`` object contains:
\r
345 +--------------+----+----------+
\r
346 | Property | Ty\| Descript\|
\r
347 | Name | pe | ion |
\r
348 +==============+====+==========+
\r
349 | location | st\| DCAE |
\r
350 | | ri\| location |
\r
357 +--------------+----+----------+
\r
358 | delivery_ur\ | st\| URL to |
\r
360 | | ng | the Data |
\r
365 +--------------+----+----------+
\r
366 | username | st\| Username |
\r
379 +--------------+----+----------+
\r
380 | password | st\| Password |
\r
393 +--------------+----+----------+
\r
394 | subscriber_i\| st | Subscrib\|
\r
399 +--------------+----+----------+
\r
401 Here’s an example of the minimal JSON that must be provided as an input:
\r
406 "type": "data_router",
\r
411 Developers are recommended to use ``username`` and ``password`` since
\r
412 this is the recommended security practice.
\r
414 Note that the dcae-cli will construct the ``delivery_url`` when
\r
415 deploying the component since this can only be known at deployment time.
\r
Code Review / dcaegen2.git / blob