Operations (Sun GlassFish Message Queue 4.4 Developer's Guide for JMX Clients)

Sun GlassFish Message Queue 4.4 Developer's Guide for JMX Clients

Operations

The cluster configuration MBean supports the operations shown in Table 3–75. The names of these operations are defined as static constants in the utility class ClusterOperations.

Table 3–75 Cluster Configuration Operations


Name	Parameters	Result 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` For conventional clusters, the list includes all brokers specified by the broker property `imq.cluster.brokerlist`. For HA clusters, it includes all active and inactive brokers in the cluster table stored in the HA database.
`getBrokerIDs` [HA clusters only]	None	`String[]`	Broker identifiers of brokers in cluster The list includes all active and inactive brokers in the cluster table stored in the HA database.
`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; see Table 3–76 for lookup keys used with this object.
`getBrokerInfoByID`	`brokerID` (`String`)	`CompositeData`	Descriptive information about broker The desired broker is designated by its broker identifier (`brokerID`). The value returned is a JMX `CompositeData` object describing the broker; see Table 3–76 for lookup keys used with this object. For conventional clusters, the operation returns `null`.
`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 3–76 for lookup keys used with these objects. For conventional clusters, the array includes all brokers specified by the broker property `imq.cluster.brokerlist`. For HA clusters, it includes all active and inactive brokers in the cluster table stored in the HA database.
`reload` [Conventional clusters only]	None	None	Reload cluster configuration file

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

Table 3–76 Lookup Keys for Cluster Configuration Information


Key	Value Type	Description
`Address`	`String`	Broker address, in the form `hostName:portNumber` Example: `host1:3000`
`ID` [HA clusters only]	`String`	Broker identifier