Operations (Sun Java System Message Queue 4.0 Developer's Guide for JMX Clients)

Sun Java System Message Queue 4.0 Developer's Guide for JMX Clients

Operations

The cluster monitor MBean supports the operations shown in Table 2–79. The names of these operations are defined as static constants in the utility class ClusterOperations.

Table 2–79 Cluster Monitor Operations


Name	Parameters	Return Type	Description
`getBrokerAddresses`	None	`String[]`	Addresses of brokers in cluster Each address specifies the host name and Port Mapper port number of a broker in the cluster, in the form `hostName:portNumber`. Example: `host1:3000`. The list includes all brokers specified by the broker property `imq.cluster.brokerlist`.
`getBrokerInfoByAddress`	`brokerAddress` (`String`)	`CompositeData`	Descriptive information about broker The desired broker is designated by its host name and Port Mapper port number (`brokerAddress`), in the form `hostName:portNumber`. The value returned is a JMX `CompositeData` object describing the broker; seeTable 2–80 for lookup keys used with this object.
`getBrokerInfo`	None	`CompositeData[]`	Descriptive information about all brokers in cluster The value returned is an array of JMX `CompositeData` objects describing the brokers; see Table 2–80 for lookup keys used with these objects. The array includes all brokers specified by the broker property `imq.cluster.brokerlist`.

The LocalBrokerInfo and MasterBrokerInfo attributes and the getBrokerInfoByAddress and getBrokerInfo operations return objects implementing the JMX interface CompositeData, which maps lookup keys to associated data values. The keys shown in Table 2–80 are defined as static constants in the utility class BrokerClusterInfo for use with these objects.

Table 2–80 Lookup Keys for Cluster Monitor Information


Key	Value Type	Description
`Address`	`String`	Broker address, in the form `hostName:portNumber` Example: `host1:3000`
`State`	`Integer`	Current state of broker See Table 2–81 for possible values.
`StateLabel`	`String`	String representation of current broker state Useful for displaying the state in human-readable form, such as in the Java Monitoring and Management Console (`jconsole`). See Table 2–81 for possible values.

Table 2–81 shows the possible values returned for the lookup keys State and StateLabel. These values are defined as static constants in the utility class BrokerState.

Table 2–81 Broker State Values


Value	Utility Constant	String Representation	Meaning
`0`	`BrokerState.OPERATING`	`OPERATING`	Broker is operating
`4`	`BrokerState.QUIESCE_STARTED`	`QUIESCE_STARTED`	Broker has begun quiescing
`5`	`BrokerState.QUIESCE_COMPLETE`	`QUIESCE_COMPLETE`	Broker has finished quiescing
`6`	`BrokerState.SHUTDOWN_STARTED`	`SHUTDOWN_STARTED`	Broker has begun shutting down
`7`	`BrokerState.BROKER_DOWN`	`BROKER_DOWN`	Broker is down
`-1`	`BrokerState.UNKNOWN`	`UNKNOWN`	Broker state unknown