The cluster configuration MBean is used for configuring a broker's cluster-related properties. There is one such MBean for each broker.
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.
The cluster configuration MBean has the attributes shown in Table 3–74. The names of these attributes are defined as static constants in the utility class ClusterAttributes.
Table 3–74 Cluster Configuration Attributes
Name |
Type |
Settable? |
Description |
---|---|---|---|
Boolean |
No | ||
String |
No |
Must be unique; no two running clusters may have the same cluster identifier. This identifier is appended to the names of all database tables in the cluster’s shared persistent store. Must be an alphanumeric string of no more than n - 13 characters, where n is the maximum table name length allowed by the database. Note – For brokers belonging to an HA cluster, this attribute is used in database table names in place of the BrokerID (see Table 3–1). |
|
String |
Yes |
URL of cluster configuration file |
|
CompositeData |
No |
Descriptive information about local broker The value returned is a JMX CompositeData object describing the broker; see Table 3–76 for lookup keys used with this object. |
|
CompositeData |
No |
Descriptive information about master broker The value returned is a JMX CompositeData object describing the master broker; see Table 3–76 for lookup keys used with this object. |
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 |
---|---|---|---|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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 |
---|---|---|
String |
Broker address, in the form hostName:portNumber Example: host1:3000 |
|
String |
The cluster configuration MBean supports the notification shown in Table 3–77.
Table 3–77 Cluster Configuration Notification
Name |
Description |
---|---|
Attribute value changed |