\r
In DMaaP Message Router, Restful web service is exposed to client to perform any needed action with Kafka. After getting the request it calls the Message router service layer which is created using AJSC ( AT&T Java Service Container) . AJSC finally calls Kafka services and response is sent back.\r
\r
-|image0|\r
-\r
-.. |image0| image:: message router.jpg\r
- :height: 600px\r
- :width: 800px\r
-\r
+ |image0|\r
\r
+ .. |image0| image:: image1.png\r
+ \r
\r
HTTP Service APIs\r
------------------\r
\r
http[s]://Username:Password@serverBaseURL{/routing}{resourcePath}\r
\r
-- The Username:Password utilizes HTTP Basic Authentication and HTTPS/TLS\r
-to securely transmit the authorization and authentication credentials\r
-that AAF needs to validate the client's access to the requested\r
-resource.\r
-- The serverBaseURL points to DMaaP Message Router host/port that will\r
-service the request. Optionally DME2 service end points for Message\r
-Router can be used.\r
-- The resourcePath specifies the specific service, or Topic, that the\r
-client is attempting to reach\r
+- The Username:Password utilizes HTTP Basic Authentication and HTTPS/TLS to securely transmit the authorization and authentication credentials that AAF needs to validate the client's access to the requested resource.\r
+\r
+- The serverBaseURL points to DMaaP Message Router host/port that will service the request. Optionally DME2 service end points for Message Router can be used.\r
+\r
+- The resourcePath specifies the specific service, or Topic, that the client is attempting to reach\r
\r
HTTP Header\r
===========\r
==================\r
\r
+--------------------------+---------------------------------+------------------+------------+-----------+-------------+--------------------------------+-----------------------------+\r
-| Name | Description | Param Type | Data type | Max Len | Req\92d | Format | Valid/EXample values |\r
+| Name | Description | Param Type | Data type | Max Len | Required | Format | Valid/EXample values |\r
+==========================+=================================+==================+============+===========+=============+================================+=============================+\r
| Topicname | topic name to be posted | Path | String | 40 | Y | <app namespace>.<topicname> | org.onap.crm.empdetails |\r
+--------------------------+---------------------------------+------------------+------------+-----------+-------------+--------------------------------+-----------------------------+\r
GET http(s)://{HOST:PORT}}/events/{topicname}/{consumegroup}/{consumerid}/{timeout=x}\r
\r
Request Parameters:\r
-==================\r
+===================\r
\r
+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+\r
-| Name | Description | Param Type | data type | MaxLen | Req\92d | Format | Valid/Example Values |\r
+| Name | Description | Param Type | data type | MaxLen | Required | Format | Valid/Example Values |\r
+=============+=================================+==================+============+==============+=============+=============+=================================================+\r
| Topicname | topic name to be posted | Path | String | 40 | Y | namespace. | |\r
| | | | | | | String | |\r
-+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+ \r
++-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+\r
|Consumergroup| A name that uniquely identifies | Path | String | | | | |\r
-| | your subscriber's | | | | Y | | CG1 |\r
+| | your subscribers | | | | Y | | CG1 |\r
+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+\r
-| consumerId | Within your subscriber's group, | | | | | | |\r
+| consumerId | Within your subscribers group, | | | | | | |\r
| | a name that uniquely identifies | Path | String | | y | | C1 |\r
-| | your subscriber's process | | | | | | | \r
-+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+\r
+| | your subscribers process | | | | | | | +-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+\r
| content-type| To specify type of message | | | | | |aplication/json |\r
| | content(json,text or cambria) | Header | String | 20 | N | | |\r
+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+\r
|Username | userid | Header | String | 1 | N | | |\r
+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+\r
| Password | | Header | String | 1 | N | | |\r
-+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+ \r
++-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+ \r
\r
**NOTE1**:Subscribers /user should have access on the topics. The user () and\r
permissions details needs to be in AAF.\r
Code Review / dmaap / messagerouter / messageservice.git / blobdiff