The UMS Broker Monitoring services getBrokerInfo is a service which returns XML containing MQ Broker monitoring data. The content of this XML depends on the query string that is used.
This is a description of the XML that is returned by this service.
The XML document returned by a getBrokerInfo query has the following general structure:
<BrokerInfo>
<Header>
<GeneratedDate>
<Milliseconds>2347657265323342</Milliseconds>
<DateString>Monday, November 10, 2008 4:25:24 PM PST</DateString>
</GeneratedDate>
<RequestProperties cmd="getDestinations"/>
<Broker>
<InstanceName>imqbroker</InstanceName>
<Port>7676</Port>
<Version>4.4</Version>
<Host>myHost</Host>
<VarHome>/var/imq</VarHome>
...
</Broker>
<Header>
<Body>
...
</Body>
</BrokerInfo>
There are two main elements; <Header> and <Body>.
The <Header> element is common to all queries and should return the same information for each request apart for <GeneratedDate>.
The <Body> element will depend on the particular query being performed
XML Element |
Description |
---|---|
Header |
Header element of UMS BrokerInfo reply XML |
GeneratedDate |
Date when this XML reply was generated. |
Milliseconds |
Milliseconds since Jan 1, 1970 |
DateString |
Human readable date string. |
RequestProperties |
Request properties as submitted via the query string. This is a list of key=value pairs. |
Broker |
High level details on the broker being queried. |
The information returned in the Body element depends on the type of query being performed, as defined by the cmd request parameter.
Currently the only type of query available is cmd=getDestinations
The Body element has the following structure:
Query String |
service=getBrokerInfo&cmd=getDestinations |
---|---|
Description |
List all destinations and show all monitoring/runtime information of those destinations. |
XML returned |
|
Notes |
The child elements that are returned within the <Destination> elements come directly from the corresponding JMX MBean: DestinationMonitor in this case. Attributes
Operations
|
The dest-elements attribute can be appended to the query to specify which particular elements should be returned:
Query String |
service=getBrokerInfo&cmd=getDestinations |
---|---|
Description |
List all destinations and show the specified monitoring/runtime information of those destinations |
XML returned |
|
Notes |
The values listed after the dest-elements parameter are comma-separated and designate the XML elements (for both attributes and operations) that are to be returned. |