modified the document to remove errors 05/19105/1
authorrn509j <rn509j@att.com>
Mon, 16 Oct 2017 16:10:35 +0000 (12:10 -0400)
committerrn509j <rn509j@att.com>
Mon, 16 Oct 2017 16:14:19 +0000 (12:14 -0400)
DMAAP-149
Signed-off-by: rn509j <rn509j@att.com>
Change-Id: I563ae63f2724cbd0c973d61f106ffa3a81deabc8

docs/Filter/Filter.rst
docs/message-router/message-router.rst

index dca8682..7b93694 100644 (file)
@@ -424,165 +424,166 @@ server.
 \r
 Remember, only Highland Park standard library filter components can be\r
 used -- no plug-ins are available in the Cambria server context.\r
+       \r
+       .. code:: bash\r
+               package org.onap.sa.highlandPark.integration;\r
 \r
-package org.onap.sa.highlandPark.integration;\r
+               import java.io.IOException;\r
 \r
-import java.io.IOException;\r
+               import java.util.UUID;\r
 \r
-import java.util.UUID;\r
+               import org.onap.nsa.cambria.client.CambriaClientFactory;\r
 \r
-import org.onap.nsa.cambria.client.CambriaClientFactory;\r
+               import org.onap.nsa.cambria.client.CambriaConsumer;\r
 \r
-import org.onap.nsa.cambria.client.CambriaConsumer;\r
+               import org.onap.sa.highlandPark.processor.HpEvent;\r
 \r
-import org.onap.sa.highlandPark.processor.HpEvent;\r
+               import org.onap.sa.highlandPark.stdlib.filters.FilterIo;\r
 \r
-import org.onap.sa.highlandPark.stdlib.filters.FilterIo;\r
+               import org.onap.sa.highlandPark.stdlib.filters.OneOf;\r
 \r
-import org.onap.sa.highlandPark.stdlib.filters.OneOf;\r
+               public class ExampleFilteringConsumer\r
 \r
-public class ExampleFilteringConsumer\r
+               {\r
 \r
-{\r
+               public static void main ( String[] args ) throws IOException,\r
+               InterruptedException\r
 \r
-public static void main ( String[] args ) throws IOException,\r
-InterruptedException\r
+               {\r
 \r
-{\r
+               // Cambria clients take a set of 1 or more servers to use in round-robin\r
+               fashion.\r
 \r
-// Cambria clients take a set of 1 or more servers to use in round-robin\r
-fashion.\r
+               // If a server becomes unreachable, another in the group is used.\r
 \r
-// If a server becomes unreachable, another in the group is used.\r
+               final String\r
+               serverGroup="ueb01hydc.it.att.com,ueb02hydc.it.att.com,ueb03hydc.it.att.com";\r
 \r
-final String\r
-serverGroup="ueb01hydc.it.att.com,ueb02hydc.it.att.com,ueb03hydc.it.att.com";\r
+               // choose a topic\r
 \r
-// choose a topic\r
+               final String topic = "TEST-TOPIC";\r
 \r
-final String topic = "TEST-TOPIC";\r
+               // Cambria clients can run in a cooperative group to handle high-volume\r
+               topics.\r
 \r
-// Cambria clients can run in a cooperative group to handle high-volume\r
-topics.\r
+               // Here, we create a random group name, which means this client is not\r
+               re-startable.\r
 \r
-// Here, we create a random group name, which means this client is not\r
-re-startable.\r
+               final String consumerGroup = UUID.randomUUID ().toString ();\r
 \r
-final String consumerGroup = UUID.randomUUID ().toString ();\r
+               final String consumerId = "0";\r
 \r
-final String consumerId = "0";\r
+               // Cambria clients can sit in a tight loop on the client side, using a\r
+               long-poll\r
 \r
-// Cambria clients can sit in a tight loop on the client side, using a\r
-long-poll\r
+               // to wait for messages, and a limit to tell the server the most to send\r
+               at a time.\r
 \r
-// to wait for messages, and a limit to tell the server the most to send\r
-at a time.\r
+               final int longPollMs = 30\*1000;\r
 \r
-final int longPollMs = 30\*1000;\r
+               final int limit = -1;\r
 \r
-final int limit = -1;\r
+               // The Cambria server can filter the returned message stream using\r
+               filters from the\r
 \r
-// The Cambria server can filter the returned message stream using\r
-filters from the\r
+               // Highland Park system. Here, we create a simple filter to test for the\r
+               AlarmID\r
 \r
-// Highland Park system. Here, we create a simple filter to test for the\r
-AlarmID\r
+               // value being one of the Mobility power alarms.\r
 \r
-// value being one of the Mobility power alarms.\r
+               final OneOf oneOf = new OneOf ( "AlarmId", kPowerAlarms );\r
 \r
-final OneOf oneOf = new OneOf ( "AlarmId", kPowerAlarms );\r
+               // create the consumer\r
 \r
-// create the consumer\r
+               final CambriaConsumer cc = CambriaClientFactory.createConsumer (\r
+               serverGroup, topic,\r
 \r
-final CambriaConsumer cc = CambriaClientFactory.createConsumer (\r
-serverGroup, topic,\r
+               consumerGroup, consumerId, longPollMs, limit, FilterIo.write ( oneOf )\r
+               );\r
 \r
-consumerGroup, consumerId, longPollMs, limit, FilterIo.write ( oneOf )\r
-);\r
+               // now loop reading messages. Note that cc.fetch() will wait in its HTTP\r
+               receive\r
 \r
-// now loop reading messages. Note that cc.fetch() will wait in its HTTP\r
-receive\r
+               // method for up to 30 seconds (longPollMs) when nothing's available at\r
+               the server.\r
 \r
-// method for up to 30 seconds (longPollMs) when nothing's available at\r
-the server.\r
+               long count = 0;\r
 \r
-long count = 0;\r
+               while ( true )\r
 \r
-while ( true )\r
+               {\r
 \r
-{\r
+               for ( String msg : cc.fetch () )\r
 \r
-for ( String msg : cc.fetch () )\r
+               {\r
 \r
-{\r
+               System.out.println ( "" + (++count) + ": " + msg );\r
 \r
-System.out.println ( "" + (++count) + ": " + msg );\r
+               }\r
 \r
-}\r
+               }\r
 \r
-}\r
+               }\r
 \r
-}\r
+               private static final String[] kPowerAlarms =\r
 \r
-private static final String[] kPowerAlarms =\r
+               {\r
 \r
-{\r
+               "HUB COMMERCIAL POWER FAIL\_FWD",\r
 \r
-"HUB COMMERCIAL POWER FAIL\_FWD",\r
+               "HUB COMMERCIAL POWER FAIL",\r
 \r
-"HUB COMMERCIAL POWER FAIL",\r
+               "RBS COMMERCIAL POWER FAIL - Fixed\_FWD",\r
 \r
-"RBS COMMERCIAL POWER FAIL - Fixed\_FWD",\r
+               "RBS COMMERCIAL POWER FAIL\_FWD",\r
 \r
-"RBS COMMERCIAL POWER FAIL\_FWD",\r
+               "RBS COMMERCIAL POWER FAIL - No Generator\_FWD",\r
 \r
-"RBS COMMERCIAL POWER FAIL - No Generator\_FWD",\r
+               "RBS COMMERCIAL POWER FAIL - Portable\_FWD",\r
 \r
-"RBS COMMERCIAL POWER FAIL - Portable\_FWD",\r
+               "RBS COMMERCIAL POWER FAIL - Shared\_FWD",\r
 \r
-"RBS COMMERCIAL POWER FAIL - Shared\_FWD",\r
+               "RBS COMMERCIAL POWER FAIL - Yes\_FWD",\r
 \r
-"RBS COMMERCIAL POWER FAIL - Yes\_FWD",\r
+               "RBS COMMERCIAL POWER FAIL - YES\_FWD",\r
 \r
-"RBS COMMERCIAL POWER FAIL - YES\_FWD",\r
+               "RBS COMMERCIAL POWER FAIL - Fixed",\r
 \r
-"RBS COMMERCIAL POWER FAIL - Fixed",\r
+               "RBS COMMERCIAL POWER FAIL - No Generator",\r
 \r
-"RBS COMMERCIAL POWER FAIL - No Generator",\r
+               "RBS COMMERCIAL POWER FAIL - Portable",\r
 \r
-"RBS COMMERCIAL POWER FAIL - Portable",\r
+               "RBS COMMERCIAL POWER FAIL - Shared",\r
 \r
-"RBS COMMERCIAL POWER FAIL - Shared",\r
+               "RBS COMMERCIAL POWER FAIL - YES",\r
 \r
-"RBS COMMERCIAL POWER FAIL - YES",\r
+               "RBS COMMERCIAL POWER FAIL - Yes",\r
 \r
-"RBS COMMERCIAL POWER FAIL - Yes",\r
+               "RBS COMMERCIAL POWER FAIL",\r
 \r
-"RBS COMMERCIAL POWER FAIL",\r
+               "HUB COMMERCIAL POWER FAIL - Fixed",\r
 \r
-"HUB COMMERCIAL POWER FAIL - Fixed",\r
+               "HUB COMMERCIAL POWER FAIL - No Generator",\r
 \r
-"HUB COMMERCIAL POWER FAIL - No Generator",\r
+               "HUB COMMERCIAL POWER FAIL - Portable",\r
 \r
-"HUB COMMERCIAL POWER FAIL - Portable",\r
+               "HUB COMMERCIAL POWER FAIL - Shared",\r
 \r
-"HUB COMMERCIAL POWER FAIL - Shared",\r
+               "HUB COMMERCIAL POWER FAIL - Fixed\_FWD",\r
 \r
-"HUB COMMERCIAL POWER FAIL - Fixed\_FWD",\r
+               "HUB COMMERCIAL POWER FAIL - No Generator\_FWD",\r
 \r
-"HUB COMMERCIAL POWER FAIL - No Generator\_FWD",\r
+               "HUB COMMERCIAL POWER FAIL - Portable\_FWD",\r
 \r
-"HUB COMMERCIAL POWER FAIL - Portable\_FWD",\r
+               "HUB COMMERCIAL POWER FAIL - Shared\_FWD",\r
 \r
-"HUB COMMERCIAL POWER FAIL - Shared\_FWD",\r
+               };\r
 \r
-};\r
-\r
-}\r
+               }\r
 \r
  \r
 \r
-** Filter Builder**\r
+**Filter Builder**\r
 \r
  MR server-side filtering allows a consumer to filter the stream of\r
 messages returned from the GET call.  The following link provide details\r
index d8c597b..8bc94b2 100644 (file)
@@ -33,15 +33,11 @@ HTTP URL
 \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
@@ -97,7 +93,7 @@ Request Parameters
 ==================\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
@@ -210,28 +206,27 @@ Request URL:
 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 subscriber               |                  |            |              |      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