Cluster Configuration (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

Cluster Configuration

The cluster configuration MBean is used for configuring a broker's cluster-related properties. There is one such MBean for each broker.

Object Name

The cluster configuration MBean has the following object name:

com.sun.messaging.jms.server:type=Cluster,subtype=Config

A string representing this object name is defined as a static constant CLUSTER_CONFIG_MBEAN_NAME in the utility class MQObjectName.

Attributes

The cluster configuration MBean has the attributes shown in Table 2–74. The names of these attributes are defined as static constants in the utility class ClusterAttributes.

Table 2–74 Cluster Configuration Attributes


Name	Type	Settable?	Description
`ConfigFileURL`	`String`	Yes	URL of cluster configuration file
`LocalBrokerInfo`	`CompositeData`	No	Descriptive information about local broker The value returned is a JMX `CompositeData` object describing the broker; see Table 2–76 for lookup key used with this object.
`MasterBrokerInfo`	`CompositeData`	No	Descriptive information about master broker The value returned is a JMX `CompositeData` object describing the master broker; see Table 2–76 for lookup key used with this object.

Operations

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

Table 2–75 Cluster Configuration 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; see Table 2–76 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–76 for lookup keys used with these objects. The array includes all brokers specified by the broker property `imq.cluster.brokerlist`.
`reload`	None	None	Reload cluster configuration file

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 key shown in Table 2–76 is defined as a static constant in the utility class BrokerClusterInfo for use with these objects.

Table 2–76 Lookup Key for Cluster Configuration Information


Key	Value Type	Description
`Address`	`String`	Broker address, in the form `hostName:portNumber` Example: `host1:3000`

Notification

The cluster configuration MBean supports the notification shown in Table 2–77.

Table 2–77 Cluster Configuration Notification


Name	Description
`jmx.attribute.change`	Attribute value changed