diff options
| author |   rn509j <rn509j@att.com> | 2017-10-10 12:22:25 -0400 |
|---|---|---|
| committer | rn509j <rn509j@att.com> | 2017-10-10 12:24:10 -0400 |
| commit | cf86a1ca9b936ee3313614b5ff3b465971dff899 (patch) | |
| tree | bd0b3d4a39ace9c279f652d915cb879046990206 /docs | |
| parent | 7d02385ddc5a94b34c5918e38cb773594979e097 (diff) | |
commiting code for document changes
DMAAP-153
Signed-off-by: rn509j <rn509j@att.com>
Change-Id: I55c02ec2b963fa1721ffca83d2f6bbd9551be103
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/message router.jpg | bin | 0 -> 38995 bytes | |||
| -rw-r--r-- | docs/message-router/message-router.rst | 60 |
2 files changed, 55 insertions, 5 deletions
diff --git a/docs/message router.jpg b/docs/message router.jpg Binary files differnew file mode 100644 index 0000000..100973d --- /dev/null +++ b/docs/message router.jpg diff --git a/docs/message-router/message-router.rst b/docs/message-router/message-router.rst index 4289a61..fbd7015 100644 --- a/docs/message-router/message-router.rst +++ b/docs/message-router/message-router.rst @@ -1,6 +1,18 @@ ============================================
Message Router (MR) API Guide
============================================
+Architecture
+-------------
+
+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.
+
+|image0|
+
+.. |image0| image:: message router.jpg
+ :height: 600px
+ :width: 800px
+
+
HTTP Service APIs
------------------
@@ -206,7 +218,7 @@ Request Parameters: +-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+
| Name | Description | Param Type | data type | MaxLen | Req’d | Format | Valid/Example Values |
| | | | | | | | |
-+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+
++=============+=================================+==================+============+==============+=============+=============+=================================================+
| Topicname | topic name to be posted | Path | String | 40 | Y | namespace. | |
| | | | | | | String | |
+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-------------------------------------------------+
@@ -259,7 +271,7 @@ Response Parameters: |
+-------------------------+-----------------+----------------------------+----------------------------------------------------------------------------------------------------+
| Error code | HTTP Code | Description |Issue reason |
-+-------------------------+-----------------+----------------------------+----------------------------------------------------------------------------------------------------+
++=========================+=================+============================+====================================================================================================+
| DMaaP\_MR\_ERR\_3008 | 413 | Request Entity too large | Message size exceeds the batch limit <limit>.Reduce the batch size and try again | +-------------------------+-----------------+----------------------------+----------------------------------------------------------------------------------------------------+
| DMaaP\_MR\_ERR\_3009 | 500 | Internal Server Error | Unable to publish messages. Please contact administartor | +-------------------------+-----------------+----------------------------+----------------------------------------------------------------------------------------------------+
| DMaaP\_MR\_ERR\_3010 | 400 | Bad Request | Incorrect Batching format. Please correct the batching format and try again | +-------------------------+-----------------+----------------------------+----------------------------------------------------------------------------------------------------+
@@ -295,7 +307,7 @@ Request Parameters: +----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+
| Name | Description | Param Type | data type | MaxLen | Req’d | Format | Valid/Example Values |
| | | | | | | | |
-+----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+
++================+=================================+==================+============+==============+=============+=============+===================================+
| Topicname | topicname to be created in MR | Body | String | 20 | Y | Json | com.att.dmaap.mr.metrics |
+----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+
|topicDescription| description for topic | Body | String | 15 | Y | | |
@@ -323,7 +335,7 @@ Request Parameters: +-------------------------+-----------------+--------------------------------------------------+
| Error code | HTTP Code | Description |
-+-------------------------+-----------------+--------------------------------------------------+
++=========================+=================+==================================================+
| DMaaP\_MR\_ERR\_5001 | 500 | Failed to retrieve list of all topics | +-------------------------+-----------------+--------------------------------------------------+
| DMaaP\_MR\_ERR\_5002 | 500 | Failed to retrieve details of topic:<topicName> | |+-------------------------+----------------+--------------------------------------------------+
| DMaaP\_MR\_ERR\_5003 | 500 |Failed to create topic:<topicName> | +-------------------------+-----------------+--------------------------------------------------+
@@ -466,7 +478,45 @@ ex: http://<hostname>:3904/dmaap/v1/topics/com.att.dmaap.mr.testopic +-------------------------+---------------------------------------------+----------------------+
| Error code | Description |HTTP code |
-+-------------------------+---------------------------------------------+----------------------+
++=========================+=============================================+======================+
| DMaaP\_MR\_ERR\_5004 | Failed to delete topic:<topicName> | 500 |
+-------------------------+---------------------------------------------+----------------------+
+API Inventory
+-------------
+
++-----------+-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+
+| | API Name | API Method | REST API Path | | Comments |
++===========+===================+=========================================+=======================================+================+==================================+
+| Topics | GetAll Topics List| getTopics() | /topics | GET | |
+| +-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+
+| | Get All Topics | | | | |
+| |List with details | getAllTopics() | /topics/listAll | GET | |
+| +-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+
+| | Get individual | | | | |
+| | Topic Details | getTopic(String topicName) | /topics/{topicName} | GET | |
+| +-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+
+| | Create Topic | createTopic(TopicBean topicBean) | /topics/create | POST | |
+| +-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+
+| | Delete Topic | deleteTopicString topicName) | /topics/{topicName} | DELETE | Not used in current MR version |
+| +-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+
+| | Get Publishers for| getPublishersByTopicName | | | |
+| | a Topic | (String topicName) | /topics/{topicName}/producers | GET | UEB Backward Compatibility |
+| +-------------------+-----------------------------------------+---------------------------------------+----------------+ |
+| | Add a Publisher to|permitPublisherForTopic(String topicName,| /topics/{topicName}/producers/ | | |
+| |write ACLon a Topic| String producerId) | {producerId} | PUT | |
+| +-------------------+-----------------------------------------+---------------------------------------+----------------+ |
+| | Remove a Publisher|denyPublisherForTopic(String topicName,|/topics/{topicName}/producers/ | | |
+| |from write ACL on|String producerId) |{producerId} | DELETE | |
+| | a Topic | | | | |
+| +-------------------+-----------------------------------------+---------------------------------------+----------------+ |
+| |Get Consumers for a| getConsumersByTopicName | /topics/{topicName}/consumers | GET | |
+| | Topic | (String topicName) | | | |
+| +-------------------+-----------------------------------------+---------------------------------------+----------------+ |
+| | Add a Consumer to | permitConsumerForTopic(String topicName,| /topics/{topicName}/consumers/ | PUT | |
+| |read ACL on a Topic| String consumerId) | {consumerId} | | |
+| +-------------------+-----------------------------------------+---------------------------------------+----------------+ |
+| | Remove a consumer |denyPublisherForTopic(String topicName,|/topics/{topicName}/consumers/ | | |
+| |from write ACL on|String consumerId) |{consumerId} | | |
+| | a Topic | | | DELETE | |
++-----------+-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+
|
