This section describes the MBeans used for managing brokers:
The broker configuration MBean configures a broker.
The broker monitor MBean monitors a broker.
The following subsections describe each of these MBeans in detail.
The broker configuration MBean is used for configuring a broker. There is one such MBean for each broker.
The broker configuration MBean has the following object name:
com.sun.messaging.jms.server:type=Broker,subtype=Config
A string representing this object name is defined as a static constant BROKER_CONFIG_MBEAN_NAME in the utility class MQObjectName.
The broker configuration MBean has the attributes shown in Table 3–1. The names of these attributes are defined as static constants in the utility class BrokerAttributes.
Table 3–1 Broker Configuration Attributes
Name |
Type |
Settable? |
Description |
---|---|---|---|
String |
No |
Must be a unique alphanumeric string of no more than n - 13 characters, where n is the maximum table name length allowed by the database. No two running brokers may have the same broker identifier. For brokers using a JDBC-based persistent data store, this string is appended to the names of all database tables to make them unique in the case where more than one broker instance is using the same database. If a database is not used as the persistent data store, the value of this attribute is null. Note – For high-availability brokers, database table names use the ClusterID attribute (see Table 3–74) instead. |
|
String |
No |
Broker version |
|
String |
No |
Broker instance name Example: imqbroker |
|
Integer |
Yes |
Port number of Port Mapper |
The broker configuration MBean supports the operations shown in Table 3–2. The names of these operations are defined as static constants in the utility class BrokerOperations.
Table 3–2 Broker Configuration Operations
The broker configuration MBean supports the notification shown in Table 3–3.
Table 3–3 Broker Configuration Notification
Name |
Description |
---|---|
Attribute value changed |
The broker monitor MBean is used for monitoring a broker. There is one such MBean for each broker.
The broker monitor MBean has the following object name:
com.sun.messaging.jms.server:type=Broker,subtype=Monitor
A string representing this object name is defined as a static constant BROKER_MONITOR_MBEAN_NAME in the utility class MQObjectName.
The broker monitor MBean has the attributes shown in Table 3–4. The names of these attributes are defined as static constants in the utility class BrokerAttributes.
Table 3–4 Broker Monitor Attributes
Name |
Type |
Settable? |
Description |
---|---|---|---|
String |
No |
Must be a unique alphanumeric string of no more than n - 13 characters, where n is the maximum table name length allowed by the database. No two running brokers may have the same broker identifier. For brokers using a JDBC-based persistent data store, this string is appended to the names of all database tables to make them unique in the case where more than one broker instance is using the same database. If a database is not used as the persistent data store, the value of this attribute is null. Note – For high-availability brokers, database table names use the ClusterID attribute (see Table 3–78) instead. |
|
String |
No |
Broker version |
|
String |
No |
Broker instance name |
|
Integer |
No |
Port number of Port Mapper |
|
String |
No |
Current broker resource state: green: < 80% memory utilization yellow: 80–90% memory utilization orange: 90–98% memory utilization red: > 98% memory utilization Note – The threshold values shown are the default thresholds for triggering the various states; these can be changed by setting the broker configuration properties imq.green.threshold imq.yellow.threshold imq.orange.threshold imq.red.threshold |
|
Boolean |
No |
Is broker embedded (started from within another process)? |
The broker monitor MBean supports the notifications shown in Table 3–5. These notifications are instances of the Message Queue JMX classes BrokerNotification and ClusterNotification, and their names are defined as static constants in those classes.
Table 3–5 Broker Monitor Notifications
Name |
Utility Constant |
Description |
---|---|---|
Broker has begun shutting down |
||
Broker has begun quiescing |
||
Broker has finished quiescing |
||
Broker has begun taking over persistent data store from another broker |
||
Broker has finished taking over persistent data store from another broker |
||
Attempted takeover has failed |
||
Broker’s resource state has changed |
||
Broker has joined a cluster |
Table 3–6 shows the methods defined in class BrokerNotification for obtaining details about a broker monitor notification. See Table 3–83 for the corresponding methods of class ClusterNotification.
Table 3–6 Data Retrieval Methods for Broker Monitor Notifications