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         Suppose if we set limit=2, then only 2 sets of data will be consumed. \r
 290         *Get \ **<<topicName>>/group/2?limit=4*** \r
 291         Let us suppose if \r
 292         **No of data available** = 4\r
 293         **Set limit** = 6\r
 294         i.e. limit>no of data\r
 295         In this scenario all 4 sets of data will be consumed. \r
 296 \r
 297 -  If limit is not passed with the url then by default limit is set to\r
 298    4096.\r
 299    \r
 300    .. code:: bash\r
 301 \r
 302         i.e. 4096 sets of data will be consumed. \r
 303         **Timeout and Long Poll:** \r
 304 \r
 305 -  Timeout is the integer value which will be treated by DMaaP Message\r
 306    Router as time in millisecond.\r
 307 \r
 308  \r
 309 \r
 310 -  Get\r
 311 \r
 312 +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
 313 | `***http://localhost/DMaaP/dmaaprest/events/<<topicName>>/group/2?timeout=20000*** <http://localhost/DMaaP/dmaaprest/events/%3c%3ctopicName%3e%3e/group/2?timeout=20000>`__   |\r
 314 +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
 315 \r
 316 -  If there is no data available to be consumed, then DMaaP Message\r
 317    Router will poll for the particular period of time specified in\r
 318    timeout this mechanism is known as Long Poll.\r
 319 \r
 320 -  If timeout is not passed with url then DMaaP Message Router will set\r
 321    the value of timeout =10000\r
 322 \r
 323 -  i.e. if no set of data are available then DMaaP Message Router will\r
 324    poll for 10000 ms.\r
 325 \r
 326 ***Meta:***\r
 327 \r
 328 -  Meta is a Boolean value.\r
 329 \r
 330 -  DMaaP Message Router reads the value of meta from\r
 331    MRConfiguration.properties file at the time of startup.\r
 332 \r
 333 -  If the value of meta is not null and if value of meta is one of these\r
 334    values true, yes, on, 1, y, checked then DMaaP Message Router will\r
 335    take meta flag as true, else it will be false.\r
 336 \r
 337 -  If meta is set to true then consumer will get the value of message\r
 338    offset along with message.\r
 339 \r
 340    |image1|\r
 341 \r
 342    .. |image1| image:: images/image1.png\r
 343    \r
 344 - **Pretty**:\r
 345 \r
 346 -  Pretty is a Boolean value.\r
 347 \r
 348 -  DMaaP Message Router reads the value of pretty from\r
 349    MRConfiguration.properties file at the time of startup.\r
 350 \r
 351 -  If the value of pretty is not null and if value of pretty is one of\r
 352    these values true, yes, on, 1, y, checked then DMaaP Message Router\r
 353    will take pretty flag as true, else it will be false.\r
 354 \r
 355 -  If pretty is set to true then different sets of messages will be\r
 356    printed in next line separated by comma (,).\r
 357 \r
 358    |image2|\r
 359    \r
 360    .. |image2| image:: images/image2.png\r
 361    \r
 362 - **Filter**\r
 363 \r
 364    - A filter examine an event and decides if it matches or doesn't. \r
 365    - Filters are mainly used in rules to decide if the processing entries\r
 366      should be executed on the given event. They're also used for settings,\r
 367      and systems like the Graph Correlator re-use Highland Park's filter\r
 368      mechanism to specify which alarms fit in a correlation. \r
 369    - The standard library includes a number of simple filters. The Equals\r
 370      filter, for example, compares a field's value with some other value\r
 371      and returns true if the values match. \r
 372    - The standard library also includes filter classes called And, Or, and\r
 373      Not, so you can compose more complex filters. For example, written in\r
 374      the standard JSON config format: \r
 375 \r
 376     +-----------------------------------------+\r
 377     | "filter":{                              |\r
 378     | "class":"And",                          |\r
 379     | "filters":                              |\r
 380     | [                                       |\r
 381     | { "class":"Equals", "foo":"abc" },      |\r
 382     | { "class":"Assigned", "field":"bar" }   |\r
 383     | ]                                       |\r
 384     | }                                       |\r
 385     +-----------------------------------------+\r
 386 \r
 387    - This filter matches events in which the field "foo" has value "abc"\r
 388      and the field "bar" is assigned to some value (as opposed to not being\r
 389      present on the event).\r
 390    -  Filters are used by the consumers to filter out data and consume only\r
 391      specific set of data which matches the conditions mentioned in filter.\r
 392    -  Filters can be passed as a query parameter by the consumer in consume\r
 393      request as mentioned below:\r
 394    - **http://localhost:8080/DMaaP/dmaaprest/events/DMaaP/consumergroup/mHOeNFY4XiWx4CBa?filter=\\{"class":"Equals",\r
 395      "field":"email", "value":"`test@abc.com <mailto:test@att.com>`__" }** \r
 396    - Filters can be applied only on data in JSON format i.e. if applied,\r
 397      filters will automatically ignore any non-json data. \r
 398    - While consuming, request CONTENT\_TYPE is not relevant to filter.\r
 399 \r
 400    The MR API allows a subscriber pass a Highland Park filter as part of\r
 401    the GET request. This will filter the stream of messages sent back to\r
 402    the subscriber, but for this to work, there are some requirements: \r
 403 \r
 404     -  The message payload must be JSON\r
 405 \r
 406    -  Only a filter built from Highland Park's Standard Library  may be\r
 407       used. (The Cambria API server doesn't have access to plugged in\r
 408       filters.)\r
 409 \r
 410    -  The filter must be encoded properly in the URL path.\r
 411 \r
 412  Server-side filtering can also be setup in the Java client as\r
 413 illustrated below\r
 414 \r
 415 **Filtering Consumer**\r
 416 \r
 417 You can also provide a Highland Park filter to your consumer instance,\r
 418 and this filter is passed on to the server in the GET request. One way\r
 419 to create the filter is programmatically. In your code, instantiate a\r
 420 filter from the Highland Park Standard Library Then create a String\r
 421 representation of the filter using the FilterIo.write utility. This\r
 422 String can then be passed to the Cambria client instance for use on the\r
 423 server.\r
 424 \r
 425 Remember, only Highland Park standard library filter components can be\r
 426 used -- no plug-ins are available in the Cambria server context.\r
 427 \r
 428 package org.onap.sa.highlandPark.integration;\r
 429 \r
 430 import java.io.IOException;\r
 431 \r
 432 import java.util.UUID;\r
 433 \r
 434 import org.onap.nsa.cambria.client.CambriaClientFactory;\r
 435 \r
 436 import org.onap.nsa.cambria.client.CambriaConsumer;\r
 437 \r
 438 import org.onap.sa.highlandPark.processor.HpEvent;\r
 439 \r
 440 import org.onap.sa.highlandPark.stdlib.filters.FilterIo;\r
 441 \r
 442 import org.onap.sa.highlandPark.stdlib.filters.OneOf;\r
 443 \r
 444 public class ExampleFilteringConsumer\r
 445 \r
 446 {\r
 447 \r
 448 public static void main ( String[] args ) throws IOException,\r
 449 InterruptedException\r
 450 \r
 451 {\r
 452 \r
 453 // Cambria clients take a set of 1 or more servers to use in round-robin\r
 454 fashion.\r
 455 \r
 456 // If a server becomes unreachable, another in the group is used.\r
 457 \r
 458 final String\r
 459 serverGroup="ueb01hydc.it.att.com,ueb02hydc.it.att.com,ueb03hydc.it.att.com";\r
 460 \r
 461 // choose a topic\r
 462 \r
 463 final String topic = "TEST-TOPIC";\r
 464 \r
 465 // Cambria clients can run in a cooperative group to handle high-volume\r
 466 topics.\r
 467 \r
 468 // Here, we create a random group name, which means this client is not\r
 469 re-startable.\r
 470 \r
 471 final String consumerGroup = UUID.randomUUID ().toString ();\r
 472 \r
 473 final String consumerId = "0";\r
 474 \r
 475 // Cambria clients can sit in a tight loop on the client side, using a\r
 476 long-poll\r
 477 \r
 478 // to wait for messages, and a limit to tell the server the most to send\r
 479 at a time.\r
 480 \r
 481 final int longPollMs = 30\*1000;\r
 482 \r
 483 final int limit = -1;\r
 484 \r
 485 // The Cambria server can filter the returned message stream using\r
 486 filters from the\r
 487 \r
 488 // Highland Park system. Here, we create a simple filter to test for the\r
 489 AlarmID\r
 490 \r
 491 // value being one of the Mobility power alarms.\r
 492 \r
 493 final OneOf oneOf = new OneOf ( "AlarmId", kPowerAlarms );\r
 494 \r
 495 // create the consumer\r
 496 \r
 497 final CambriaConsumer cc = CambriaClientFactory.createConsumer (\r
 498 serverGroup, topic,\r
 499 \r
 500 consumerGroup, consumerId, longPollMs, limit, FilterIo.write ( oneOf )\r
 501 );\r
 502 \r
 503 // now loop reading messages. Note that cc.fetch() will wait in its HTTP\r
 504 receive\r
 505 \r
 506 // method for up to 30 seconds (longPollMs) when nothing's available at\r
 507 the server.\r
 508 \r
 509 long count = 0;\r
 510 \r
 511 while ( true )\r
 512 \r
 513 {\r
 514 \r
 515 for ( String msg : cc.fetch () )\r
 516 \r
 517 {\r
 518 \r
 519 System.out.println ( "" + (++count) + ": " + msg );\r
 520 \r
 521 }\r
 522 \r
 523 }\r
 524 \r
 525 }\r
 526 \r
 527 private static final String[] kPowerAlarms =\r
 528 \r
 529 {\r
 530 \r
 531 "HUB COMMERCIAL POWER FAIL\_FWD",\r
 532 \r
 533 "HUB COMMERCIAL POWER FAIL",\r
 534 \r
 535 "RBS COMMERCIAL POWER FAIL - Fixed\_FWD",\r
 536 \r
 537 "RBS COMMERCIAL POWER FAIL\_FWD",\r
 538 \r
 539 "RBS COMMERCIAL POWER FAIL - No Generator\_FWD",\r
 540 \r
 541 "RBS COMMERCIAL POWER FAIL - Portable\_FWD",\r
 542 \r
 543 "RBS COMMERCIAL POWER FAIL - Shared\_FWD",\r
 544 \r
 545 "RBS COMMERCIAL POWER FAIL - Yes\_FWD",\r
 546 \r
 547 "RBS COMMERCIAL POWER FAIL - YES\_FWD",\r
 548 \r
 549 "RBS COMMERCIAL POWER FAIL - Fixed",\r
 550 \r
 551 "RBS COMMERCIAL POWER FAIL - No Generator",\r
 552 \r
 553 "RBS COMMERCIAL POWER FAIL - Portable",\r
 554 \r
 555 "RBS COMMERCIAL POWER FAIL - Shared",\r
 556 \r
 557 "RBS COMMERCIAL POWER FAIL - YES",\r
 558 \r
 559 "RBS COMMERCIAL POWER FAIL - Yes",\r
 560 \r
 561 "RBS COMMERCIAL POWER FAIL",\r
 562 \r
 563 "HUB COMMERCIAL POWER FAIL - Fixed",\r
 564 \r
 565 "HUB COMMERCIAL POWER FAIL - No Generator",\r
 566 \r
 567 "HUB COMMERCIAL POWER FAIL - Portable",\r
 568 \r
 569 "HUB COMMERCIAL POWER FAIL - Shared",\r
 570 \r
 571 "HUB COMMERCIAL POWER FAIL - Fixed\_FWD",\r
 572 \r
 573 "HUB COMMERCIAL POWER FAIL - No Generator\_FWD",\r
 574 \r
 575 "HUB COMMERCIAL POWER FAIL - Portable\_FWD",\r
 576 \r
 577 "HUB COMMERCIAL POWER FAIL - Shared\_FWD",\r
 578 \r
 579 };\r
 580 \r
 581 }\r
 582 \r
 583  \r
 584 \r
 585 ** Filter Builder**\r
 586 \r
 587  MR server-side filtering allows a consumer to filter the stream of\r
 588 messages returned from the GET call.  The following link provide details\r
 589 of building some of the filter to illustrate Filter Builder.  It is not\r
 590 meant to cover and provide examples of every filter\r
 591 \r
 592 \r
 593 \r
 594 \r