docs/Filter/Filter.rst

   1 =======\r
   2 Filter\r
   3 ======= \r
   4 \r
   5 A filter examine an event and decides if it matches or doesn't.  Filters\r
   6 are mainly used in rules to decide if the processing entries should be\r
   7 executed on the given event. They're also used for settings, and systems\r
   8 like the Graph Correlator re-use Highland Park's filter mechanism to\r
   9 specify which alarms fit in a correlation.  Some publishers may produce\r
  10 topics with a lot of volume and a subscriber may want only a portion of\r
  11 those messages. The subscriber can certainly filter messages after\r
  12 receiving them, but it may be substantially more efficient to ask the\r
  13 API server to filter the messages before sending them to the\r
  14 subscriber.The standard library includes a number of simple filters. The\r
  15 Equals filter, for example, compares a field's value with some other\r
  16 value and returns true if the values match.  The standard library also\r
  17 includes filter classes called And, Or, and Not, so you can compose more\r
  18 complex filters. For example, written in the standard JSON config\r
  19 format: \r
  20 \r
  21 +-----------------------------------------+\r
  22 | "filter":{                              |\r
  23 | "class":"And",                          |\r
  24 | "filters":                              |\r
  25 | [                                       |\r
  26 | { "class":"Equals", "foo":"abc" },      |\r
  27 | { "class":"Assigned", "field":"bar" }   |\r
  28 | ]                                       |\r
  29 | }                                       |\r
  30 +-----------------------------------------+\r
  31 \r
  32 - This filter matches events in which the field "foo" has value "abc"\r
  33   and the field "bar" is assigned to some value (as opposed to not being\r
  34   present on the event). Filters are used by the consumers to filter out\r
  35   data and consume only specific set of data which matches the\r
  36   conditions mentioned in filter. Filters can be passed as a query\r
  37   parameter by the consumer in consume request as mentioned below:\r
  38   **http://localhost:8080/DMaaP/dmaaprest/events/DMaaP/consumergroup/mHOeNFY4XiWx4CBa?filter=\\{"class":"Equals",\r
  39   "field":"email", "value":"test@abc.com" }** \r
  40 - Filters can be applied only on data in JSON format i.e. if applied,\r
  41   filters will automatically ignore any non-json data.  While consuming,\r
  42   request CONTENT\_TYPE is not relevant to filter.\r
  43 \r
  44 All the supported filter can be found below.\r
  45 \r
  46 Types of Filters \r
  47 ----------------\r
  48 \r
  49 - DMaaP Message Router supports all the filters which were supported by\r
  50   DMaaP Message Router and are mentioned below:- \r
  51 - **All Alarms:**\r
  52   - Match all alarms. \r
  53 - **And:**\r
  54   - Create a set of filters. This filter matches when all of them matches.\r
  55 \r
  56 +-------------+--------------------+------------+---------------------+\r
  57 | **Field**   | **Description**    | **Type**   | **Notes**           |\r
  58 +=============+====================+============+=====================+\r
  59 | filters     | Combined Filters   | LIST       | A list of filters   |\r
  60 +-------------+--------------------+------------+---------------------+\r
  61 |             |                    |            |                     |\r
  62 +-------------+--------------------+------------+---------------------+\r
  63 \r
  64 - **Assigned:**\r
  65   - Choose a field from the event to check for assignment. This filter\r
  66     matches when the field is assigned.\r
  67 \r
  68 +-------------------+--------------------------------------------------------+------------+-----------------+\r
  69 | **Field**         | **Description**                                        | **Type**   | **Notes**       |\r
  70 +===================+========================================================+============+=================+\r
  71 | field             | The field to check for on the event.                   | STRING     | A field name    |\r
  72 +-------------------+--------------------------------------------------------+------------+-----------------+\r
  73 | emptyIsAssigned   | If true, an empty value is considered an assignment.   | BOOLEAN    | True or False   |\r
  74 +-------------------+--------------------------------------------------------+------------+-----------------+\r
  75 \r
  76 - **Contains:**\r
  77    - Check if a search string contains another string.\r
  78 \r
  79 +-------------+---------------------------------------------------+------------+--------------+\r
  80 | **Field**   | **Description**                                   | **Type**   | **Notes**    |\r
  81 +=============+===================================================+============+==============+\r
  82 | String      | The value to search. Supports ${} notation.       | STRING     | Any string   |\r
  83 +-------------+---------------------------------------------------+------------+--------------+\r
  84 | Value       | The value to search for. Supports ${} notation.   | STRING     | Any string   |\r
  85 +-------------+---------------------------------------------------+------------+--------------+\r
  86 |             |                                                   |            |              |\r
  87 +-------------+---------------------------------------------------+------------+--------------+\r
  88 \r
  89 -  **EndsWith**:\r
  90    -  Check if a search string ends with another string.\r
  91 \r
  92 +-------------+---------------------------------------------------+------------+--------------+\r
  93 | **Field**   | **Description**                                   | **Type**   | **Notes**    |\r
  94 +=============+===================================================+============+==============+\r
  95 | string      | The value to search. Supports ${} notation.       | STRING     | Any string   |\r
  96 +-------------+---------------------------------------------------+------------+--------------+\r
  97 | value       | The value to search for. Supports ${} notation.   | STRING     | Any string   |\r
  98 +-------------+---------------------------------------------------+------------+--------------+\r
  99 \r
 100 -  **Equals:**\r
 101   - Choose a field from the event and a value to check for equality.\r
 102 \r
 103 +-------------+----------------------------------------------+------------+--------------+\r
 104 | **Field**   | **Description**                              | **Type**   | **Notes**    |\r
 105 +=============+==============================================+============+==============+\r
 106 | field       | The field to check. Supports ${} notation.   | STRING     | Any string   |\r
 107 +-------------+----------------------------------------------+------------+--------------+\r
 108 | value       | The value to match. Supports ${} notation.   | STRING     | Any string   |\r
 109 +-------------+----------------------------------------------+------------+--------------+\r
 110 \r
 111 -  **FlatironObjectExists**\r
 112   -  Matches when the given object exists in the given Flatiron instance.\r
 113 \r
 114 +-------------+---------------------------------------------+------------+--------------+\r
 115 | **Field**   | **Description**                             | **Type**   | **Notes**    |\r
 116 +=============+=============================================+============+==============+\r
 117 | oid         | The OID of the object to look for.          | STRING     | Any string   |\r
 118 +-------------+---------------------------------------------+------------+--------------+\r
 119 | flatiron    | The name of the Flatiron client instance.   | STRING     | Any string   |\r
 120 +-------------+---------------------------------------------+------------+--------------+\r
 121 \r
 122 - **IsAging**\r
 123   -  Choose a field to test. This filter matches if the expression is\r
 124      numeric.\r
 125 \r
 126 +-------------+---------------------------------------------+------------+--------------+\r
 127 | **Field**   | **Description**                             | **Type**   | **Notes**    |\r
 128 +=============+=============================================+============+==============+\r
 129 | field       | The field to test. Supports ${} notation.   | STRING     | Any string   |\r
 130 +-------------+---------------------------------------------+------------+--------------+\r
 131 \r
 132 - **IsNumeric**\r
 133   - Choose a field to test. This filter matches if the expression is\r
 134   numeric.\r
 135 \r
 136 +-------------+---------------------------------------------+------------+--------------+\r
 137 | **Field**   | **Description**                             | **Type**   | **Notes**    |\r
 138 +=============+=============================================+============+==============+\r
 139 | field       | The field to test. Supports ${} notation.   | STRING     | Any string   |\r
 140 +-------------+---------------------------------------------+------------+--------------+\r
 141 \r
 142 -  **MathCondition**\r
 143   - Choose a field from the event and a value for logical math conditions.\r
 144 \r
 145 +-------------+-------------------------------------------------+------------+-----------------------------------+\r
 146 | **Field**   | **Description**                                 | **Type**   | **Notes**                         |\r
 147 +=============+=================================================+============+===================================+\r
 148 | Field       | The field to check. Supports ${} notation.      | STRING     | Any string                        |\r
 149 +-------------+-------------------------------------------------+------------+-----------------------------------+\r
 150 | Value       | The value to consider. Supports ${} notation.   | STRING     | Any string                        |\r
 151 +-------------+-------------------------------------------------+------------+-----------------------------------+\r
 152 | operator    | The operation.                                  | STRING     | One of { "<=", ">=", ">", "<" }   |\r
 153 +-------------+-------------------------------------------------+------------+-----------------------------------+\r
 154 |             |                                                 |            |                                   |\r
 155 +-------------+-------------------------------------------------+------------+-----------------------------------+\r
 156 \r
 157 - **NoAlarms**\r
 158   -  Don't match any alarms. \r
 159 - **Not**\r
 160   -  Negate the configured filter.\r
 161 \r
 162 +-------------+-------------------------+------------+-------------+\r
 163 | **Field**   | **Description**         | **Type**   | **Notes**   |\r
 164 +=============+=========================+============+=============+\r
 165 | filter      | The filter to negate.   | FILTER     | A filter    |\r
 166 +-------------+-------------------------+------------+-------------+\r
 167 \r
 168 -  **NotEqual**\r
 169   -  Choose a field from the event and a value to check for inequality.\r
 170 \r
 171 +-------------+----------------------------------------------+------------+--------------+\r
 172 | **Field**   | **Description**                              | **Type**   | **Notes**    |\r
 173 +=============+==============================================+============+==============+\r
 174 | field       | The field to check. Supports ${} notation.   | STRING     | Any string   |\r
 175 +-------------+----------------------------------------------+------------+--------------+\r
 176 | value       | The value to match. Supports ${} notation.   | STRING     | Any string   |\r
 177 +-------------+----------------------------------------------+------------+--------------+\r
 178 \r
 179 -  **NotOneOf**\r
 180   -  Match when the specified field does not have a value from the given\r
 181      list.\r
 182 \r
 183 +-------------+---------------------------------------------+------------+---------------------+\r
 184 | **Field**   | **Description**                             | **Type**   | **Notes**           |\r
 185 +=============+=============================================+============+=====================+\r
 186 | field       | The field to test. Supports ${} notation.   | STRING     | Any string          |\r
 187 +-------------+---------------------------------------------+------------+---------------------+\r
 188 | values      | The matching values.                        | LIST       | A list of strings   |\r
 189 +-------------+---------------------------------------------+------------+---------------------+\r
 190 \r
 191 -  **OneOf**\r
 192   -  Match when the specified field has a value from the given list.\r
 193 \r
 194 +-------------+---------------------------------------------+------------+---------------------+\r
 195 | **Field**   | **Description**                             | **Type**   | **Notes**           |\r
 196 +=============+=============================================+============+=====================+\r
 197 | field       | The field to test. Supports ${} notation.   | STRING     | Any string          |\r
 198 +-------------+---------------------------------------------+------------+---------------------+\r
 199 | values      | The matching values.                        | LIST       | A list of strings   |\r
 200 +-------------+---------------------------------------------+------------+---------------------+\r
 201 \r
 202 - **Or**\r
 203    - Create a set of filters. This filter matches when any one of them\r
 204      matches.\r
 205 \r
 206 +-------------+--------------------+------------+---------------------+\r
 207 | **Field**   | **Description**    | **Type**   | **Notes**           |\r
 208 +=============+====================+============+=====================+\r
 209 | filters     | Combined Filters   | LIST       | A list of filters   |\r
 210 +-------------+--------------------+------------+---------------------+\r
 211 \r
 212 - **RegEx**\r
 213    - Choose a field from the event to match against the regular expression\r
 214      you provide.\r
 215 \r
 216 +-------------+---------------------------------------------------------+------------+--------------+\r
 217 | **Field**   | **Description**                                         | **Type**   | **Notes**    |\r
 218 +=============+=========================================================+============+==============+\r
 219 | field       | The text to check for a match. Supports ${} notation.   | STRING     | Any string   |\r
 220 +-------------+---------------------------------------------------------+------------+--------------+\r
 221 | value       | The regular expression (pattern) to match.              | STRING     | Any string   |\r
 222 +-------------+---------------------------------------------------------+------------+--------------+\r
 223 \r
 224 - **StartsWith**\r
 225   - Check if a search string starts with another string.\r
 226 \r
 227 +-------------+---------------------------------------------------+------------+--------------+\r
 228 | **Field**   | **Description**                                   | **Type**   | **Notes**    |\r
 229 +=============+===================================================+============+==============+\r
 230 | string      | The value to search. Supports ${} notation.       | STRING     | Any string   |\r
 231 +-------------+---------------------------------------------------+------------+--------------+\r
 232 | Value       | The value to search for. Supports ${} notation.   | STRING     | Any string   |\r
 233 +-------------+---------------------------------------------------+------------+--------------+\r
 234 \r
 235 - **Unassigned**\r
 236    - Choose a field from the event to check for assignment. This filter\r
 237      matches when the field is not assigned.\r
 238 \r
 239 +-------------------+--------------------------------------------------------+------------+-----------------+\r
 240 | **Field**         | **Description**                                        | **Type**   | **Notes**       |\r
 241 +===================+========================================================+============+=================+\r
 242 | field             | The field to check for on the event.                   | STRING     | A field name    |\r
 243 +-------------------+--------------------------------------------------------+------------+-----------------+\r
 244 | emptyIsAssigned   | If true, an empty value is considered an assignment.   | BOOLEAN    | True or False   |\r
 245 +-------------------+--------------------------------------------------------+------------+-----------------+\r
 246 \r
 247 - **WithinSecondsFrom**\r
 248   - This filter matches when the specified epoch time value is within the\r
 249     given number of seconds from the baseline time value. Both time values\r
 250     are assumed to be in seconds. If a value is in milliseconds, set\r
 251     baselineTimeInMillis and/or eventTimeInMillis to true.\r
 252 \r
 253 +------------------------+------------------------------------------------------------+------------+-----------------+\r
 254 | **Field**              | **Description**                                            | **Type**   | **Notes**       |\r
 255 +========================+============================================================+============+=================+\r
 256 | field                  | The time value to test. Supports ${}                       | STRING     | A field name    |\r
 257 +------------------------+------------------------------------------------------------+------------+-----------------+\r
 258 | eventTimeInMillis      | Whether to convert the event value from milliseconds.      | BOOLEAN    | True or False   |\r
 259 +------------------------+------------------------------------------------------------+------------+-----------------+\r
 260 | seconds                | The number of seconds.                                     | NUMBER     | A number        |\r
 261 +------------------------+------------------------------------------------------------+------------+-----------------+\r
 262 | baselineTimeInMillis   | Whether to convert the baseline value from milliseconds.   | BOOLEAN    | True or False   |\r
 263 +------------------------+------------------------------------------------------------+------------+-----------------+\r
 264 | baseline               | The baseline time value. Supports ${}.                     | STRING     | Any string      |\r
 265 +------------------------+------------------------------------------------------------+------------+-----------------+\r
 266 \r
 267 - **WithinTimeFromNow**\r
 268   - This filter matches when the named field has an epoch time value\r
 269     within the given number of seconds from the current time. The event's\r
 270     time value is assumed to be in seconds. If it's in milliseconds, set\r
 271     eventTimeInMillis to true.\r
 272 \r
 273 +---------------------+---------------------------------------------------------+------------+-----------------+\r
 274 | **Field**           | **Description**                                         | **Type**   | **Notes**       |\r
 275 +=====================+=========================================================+============+=================+\r
 276 | field               | The field to check on the event.                        | STRING     | A field name    |\r
 277 +---------------------+---------------------------------------------------------+------------+-----------------+\r
 278 | eventTimeInMillis   | Whether to convert the event value from milliseconds.   | BOOLEAN    | True or False   |\r
 279 +---------------------+---------------------------------------------------------+------------+-----------------+\r
 280 | seconds             | The number of seconds.                                  | NUMBER     | A number        |\r
 281 +---------------------+---------------------------------------------------------+------------+-----------------+\r
 282 \r
 283 - **Limit:** \r
 284 \r
 285   -  Limit is the integer value and DMaaP Message Router will consumes\r
 286      only that set of message which are specified in limit.\r
 287          \r
 288   .. code:: bash\r
 289   \r
 290         Suppose if we set limit=2, then only 2 sets of data will be consumed. \r
 291         *Get \ **<<topicName>>/group/2?limit=4*** \r
 292         Let us suppose if \r
 293         **No of data available** = 4\r
 294         **Set limit** = 6\r
 295         i.e. limit>no of data\r
 296         In this scenario all 4 sets of data will be consumed. \r
 297 \r
 298 -  If limit is not passed with the url then by default limit is set to\r
 299    4096.\r
 300    \r
 301    .. code:: bash\r
 302 \r
 303         i.e. 4096 sets of data will be consumed. \r
 304         **Timeout and Long Poll:** \r
 305 \r
 306 -  Timeout is the integer value which will be treated by DMaaP Message\r
 307    Router as time in millisecond.\r
 308 \r
 309  \r
 310 \r
 311 -  Get\r
 312 \r
 313 +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
 314 | `***http://localhost/DMaaP/dmaaprest/events/<<topicName>>/group/2?timeout=20000*** <http://localhost/DMaaP/dmaaprest/events/%3c%3ctopicName%3e%3e/group/2?timeout=20000>`__   |\r
 315 +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
 316 \r
 317 -  If there is no data available to be consumed, then DMaaP Message\r
 318    Router will poll for the particular period of time specified in\r
 319    timeout this mechanism is known as Long Poll.\r
 320 \r
 321 -  If timeout is not passed with url then DMaaP Message Router will set\r
 322    the value of timeout =10000\r
 323 \r
 324 -  i.e. if no set of data are available then DMaaP Message Router will\r
 325    poll for 10000 ms.\r
 326 \r
 327 ***Meta:***\r
 328 \r
 329 -  Meta is a Boolean value.\r
 330 \r
 331 -  DMaaP Message Router reads the value of meta from\r
 332    MRConfiguration.properties file at the time of startup.\r
 333 \r
 334 -  If the value of meta is not null and if value of meta is one of these\r
 335    values true, yes, on, 1, y, checked then DMaaP Message Router will\r
 336    take meta flag as true, else it will be false.\r
 337 \r
 338 -  If meta is set to true then consumer will get the value of message\r
 339    offset along with message.\r
 340 \r
 341    |image1|\r
 342 \r
 343    .. |image1| image:: images/image1.png\r
 344    \r
 345 - **Pretty**:\r
 346 \r
 347 -  Pretty is a Boolean value.\r
 348 \r
 349 -  DMaaP Message Router reads the value of pretty from\r
 350    MRConfiguration.properties file at the time of startup.\r
 351 \r
 352 -  If the value of pretty is not null and if value of pretty is one of\r
 353    these values true, yes, on, 1, y, checked then DMaaP Message Router\r
 354    will take pretty flag as true, else it will be false.\r
 355 \r
 356 -  If pretty is set to true then different sets of messages will be\r
 357    printed in next line separated by comma (,).\r
 358 \r
 359    |image2|\r
 360    \r
 361    .. |image2| image:: images/image2.png\r
 362    \r
 363 - **Filter**\r
 364 \r
 365    - A filter examine an event and decides if it matches or doesn't. \r
 366    - Filters are mainly used in rules to decide if the processing entries\r
 367      should be executed on the given event. They're also used for settings,\r
 368      and systems like the Graph Correlator re-use Highland Park's filter\r
 369      mechanism to specify which alarms fit in a correlation. \r
 370    - The standard library includes a number of simple filters. The Equals\r
 371      filter, for example, compares a field's value with some other value\r
 372      and returns true if the values match. \r
 373    - The standard library also includes filter classes called And, Or, and\r
 374      Not, so you can compose more complex filters. For example, written in\r
 375      the standard JSON config format: \r
 376 \r
 377     +-----------------------------------------+\r
 378     | "filter":{                              |\r
 379     | "class":"And",                          |\r
 380     | "filters":                              |\r
 381     | [                                       |\r
 382     | { "class":"Equals", "foo":"abc" },      |\r
 383     | { "class":"Assigned", "field":"bar" }   |\r
 384     | ]                                       |\r
 385     | }                                       |\r
 386     +-----------------------------------------+\r
 387 \r
 388    - This filter matches events in which the field "foo" has value "abc"\r
 389      and the field "bar" is assigned to some value (as opposed to not being\r
 390      present on the event).\r
 391    -  Filters are used by the consumers to filter out data and consume only\r
 392      specific set of data which matches the conditions mentioned in filter.\r
 393    -  Filters can be passed as a query parameter by the consumer in consume\r
 394      request as mentioned below:\r
 395    - **http://localhost:8080/DMaaP/dmaaprest/events/DMaaP/consumergroup/mHOeNFY4XiWx4CBa?filter=\\{"class":"Equals",\r
 396      "field":"email", "value":"`test@abc.com <mailto:test@att.com>`__" }** \r
 397    - Filters can be applied only on data in JSON format i.e. if applied,\r
 398      filters will automatically ignore any non-json data. \r
 399    - While consuming, request CONTENT\_TYPE is not relevant to filter.\r
 400 \r
 401    The MR API allows a subscriber pass a Highland Park filter as part of\r
 402    the GET request. This will filter the stream of messages sent back to\r
 403    the subscriber, but for this to work, there are some requirements: \r
 404 \r
 405     -  The message payload must be JSON\r
 406 \r
 407    -  Only a filter built from Highland Park's Standard Library  may be\r
 408       used. (The Cambria API server doesn't have access to plugged in\r
 409       filters.)\r
 410 \r
 411    -  The filter must be encoded properly in the URL path.\r
 412 \r
 413  Server-side filtering can also be setup in the Java client as\r
 414 illustrated below\r
 415 \r
 416 **Filtering Consumer**\r
 417 \r
 418 You can also provide a Highland Park filter to your consumer instance,\r
 419 and this filter is passed on to the server in the GET request. One way\r
 420 to create the filter is programmatically. In your code, instantiate a\r
 421 filter from the Highland Park Standard Library Then create a String\r
 422 representation of the filter using the FilterIo.write utility. This\r
 423 String can then be passed to the Cambria client instance for use on the\r
 424 server.\r
 425 \r
 426 Remember, only Highland Park standard library filter components can be\r
 427 used -- no plug-ins are available in the Cambria server context.\r
 428         \r
 429         .. code:: bash\r
 430         \r
 431                 package org.onap.sa.highlandPark.integration;\r
 432 \r
 433                 import java.io.IOException;\r
 434 \r
 435                 import java.util.UUID;\r
 436 \r
 437                 import org.onap.nsa.cambria.client.CambriaClientFactory;\r
 438 \r
 439                 import org.onap.nsa.cambria.client.CambriaConsumer;\r
 440 \r
 441                 import org.onap.sa.highlandPark.processor.HpEvent;\r
 442 \r
 443                 import org.onap.sa.highlandPark.stdlib.filters.FilterIo;\r
 444 \r
 445                 import org.onap.sa.highlandPark.stdlib.filters.OneOf;\r
 446 \r
 447                 public class ExampleFilteringConsumer\r
 448 \r
 449                 {\r
 450 \r
 451                 public static void main ( String[] args ) throws IOException,\r
 452                 InterruptedException\r
 453 \r
 454                 {\r
 455 \r
 456                 // Cambria clients take a set of 1 or more servers to use in round-robin\r
 457                 fashion.\r
 458 \r
 459                 // If a server becomes unreachable, another in the group is used.\r
 460 \r
 461                 final String\r
 462                 serverGroup="ueb01hydc.it.att.com,ueb02hydc.it.att.com,ueb03hydc.it.att.com";\r
 463 \r
 464                 // choose a topic\r
 465 \r
 466                 final String topic = "TEST-TOPIC";\r
 467 \r
 468                 // Cambria clients can run in a cooperative group to handle high-volume\r
 469                 topics.\r
 470 \r
 471                 // Here, we create a random group name, which means this client is not\r
 472                 re-startable.\r
 473 \r
 474                 final String consumerGroup = UUID.randomUUID ().toString ();\r
 475 \r
 476                 final String consumerId = "0";\r
 477 \r
 478                 // Cambria clients can sit in a tight loop on the client side, using a\r
 479                 long-poll\r
 480 \r
 481                 // to wait for messages, and a limit to tell the server the most to send\r
 482                 at a time.\r
 483 \r
 484                 final int longPollMs = 30\*1000;\r
 485 \r
 486                 final int limit = -1;\r
 487 \r
 488                 // The Cambria server can filter the returned message stream using\r
 489                 filters from the\r
 490 \r
 491                 // Highland Park system. Here, we create a simple filter to test for the\r
 492                 AlarmID\r
 493 \r
 494                 // value being one of the Mobility power alarms.\r
 495 \r
 496                 final OneOf oneOf = new OneOf ( "AlarmId", kPowerAlarms );\r
 497 \r
 498                 // create the consumer\r
 499 \r
 500                 final CambriaConsumer cc = CambriaClientFactory.createConsumer (\r
 501                 serverGroup, topic,\r
 502 \r
 503                 consumerGroup, consumerId, longPollMs, limit, FilterIo.write ( oneOf )\r
 504                 );\r
 505 \r
 506                 // now loop reading messages. Note that cc.fetch() will wait in its HTTP\r
 507                 receive\r
 508 \r
 509                 // method for up to 30 seconds (longPollMs) when nothing's available at\r
 510                 the server.\r
 511 \r
 512                 long count = 0;\r
 513 \r
 514                 while ( true )\r
 515 \r
 516                 {\r
 517 \r
 518                 for ( String msg : cc.fetch () )\r
 519 \r
 520                 {\r
 521 \r
 522                 System.out.println ( "" + (++count) + ": " + msg );\r
 523 \r
 524                 }\r
 525 \r
 526                 }\r
 527 \r
 528                 }\r
 529 \r
 530                 private static final String[] kPowerAlarms =\r
 531 \r
 532                 {\r
 533 \r
 534                 "HUB COMMERCIAL POWER FAIL\_FWD",\r
 535 \r
 536                 "HUB COMMERCIAL POWER FAIL",\r
 537 \r
 538                 "RBS COMMERCIAL POWER FAIL - Fixed\_FWD",\r
 539 \r
 540                 "RBS COMMERCIAL POWER FAIL\_FWD",\r
 541 \r
 542                 "RBS COMMERCIAL POWER FAIL - No Generator\_FWD",\r
 543 \r
 544                 "RBS COMMERCIAL POWER FAIL - Portable\_FWD",\r
 545 \r
 546                 "RBS COMMERCIAL POWER FAIL - Shared\_FWD",\r
 547 \r
 548                 "RBS COMMERCIAL POWER FAIL - Yes\_FWD",\r
 549 \r
 550                 "RBS COMMERCIAL POWER FAIL - YES\_FWD",\r
 551 \r
 552                 "RBS COMMERCIAL POWER FAIL - Fixed",\r
 553 \r
 554                 "RBS COMMERCIAL POWER FAIL - No Generator",\r
 555 \r
 556                 "RBS COMMERCIAL POWER FAIL - Portable",\r
 557 \r
 558                 "RBS COMMERCIAL POWER FAIL - Shared",\r
 559 \r
 560                 "RBS COMMERCIAL POWER FAIL - YES",\r
 561 \r
 562                 "RBS COMMERCIAL POWER FAIL - Yes",\r
 563 \r
 564                 "RBS COMMERCIAL POWER FAIL",\r
 565 \r
 566                 "HUB COMMERCIAL POWER FAIL - Fixed",\r
 567 \r
 568                 "HUB COMMERCIAL POWER FAIL - No Generator",\r
 569 \r
 570                 "HUB COMMERCIAL POWER FAIL - Portable",\r
 571 \r
 572                 "HUB COMMERCIAL POWER FAIL - Shared",\r
 573 \r
 574                 "HUB COMMERCIAL POWER FAIL - Fixed\_FWD",\r
 575 \r
 576                 "HUB COMMERCIAL POWER FAIL - No Generator\_FWD",\r
 577 \r
 578                 "HUB COMMERCIAL POWER FAIL - Portable\_FWD",\r
 579 \r
 580                 "HUB COMMERCIAL POWER FAIL - Shared\_FWD",\r
 581 \r
 582                 };\r
 583 \r
 584                 }\r
 585 \r
 586  \r
 587 \r
 588 **Filter Builder**\r
 589 \r
 590  MR server-side filtering allows a consumer to filter the stream of\r
 591  messages returned from the GET call.  The following link provide details\r
 592  of building some of the filter to illustrate Filter Builder.  It is not\r
 593  meant to cover and provide examples of every filter\r
 594 \r
 595 \r
 596 \r
 597 \r