XML::subscribe


NOTE: The features contained in this namespace require an EA (Early Access) license to be accessed. These commands will not function if your system does not have this license installed. For more information about obtaining the necessary license to access these features, please contact your sales representative. For more information, read about the LicenseDetails

Description

Subscribes to a specified category of XML events. You must specify which category of events you would like to have raised.
Note: All XML commands are unavailable beginning in v10.

Syntax

XML::subscribe addressing
XML::subscribe allevent
XML::subscribe cdata <key>
XML::subscribe cdata_regexp <key>
XML::subscribe element <key>
XML::subscribe element_regexp <key>
XML::subscribe end_element <key>
XML::subscribe remove <id>
XML::subscribe soap

XML::subscribe addressing

  • Subscribes to be notified when a WS-Addressing header is found. Returns a subscription ID.

XML::subscribe allevent

  • Subscribes to all possible events. This command causes events to be triggered during the start/end of any element and CDATA encountered. Returns a subscription ID.

XML::subscribe cdata <key>

  • Subscribes to the cdata matching the value of the key parameter. Returns a subscription ID.

XML::subscribe cdata_regexp <key>

  • Subscribes to the cdata matching the value of the key paramter (which can be in the form of a regular expression). Returns a subscription ID.

XML::subscribe element <key>

  • Subscribes to the elements matching the value of the key parameter. Returns a subscription ID.

XML::subscribe element_regexp <key>

  • Subscribes to the elements matching the value of the key parameter (which can be in the form of a regular expression). Returns a subscription ID.

XML::subscribe end_element <key>

  • This command is the same as the XML::subscribe element command but you are notified only when the element is finished processing. Returns a subscription ID.

XML::subscribe remove <id>

  • Removes the given subscription specified by the subscription ID.

XML::subscribe soap

  • Subscribes to XML documents that are SOAP messages. Returns a subscription ID.

Examples

when XML_BEGIN_DOCUMENT {
  XML::subscribe allevent
  XML::collect
}
when XML_BEGIN_ELEMENT {
  log local0. "Found element [XML::element]"
}