Broker Configuration
The broker configuration MBean is used for configuring
a broker. There is one such MBean for each broker.
Object Name
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.
Attributes
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
|
|
BrokerID
|
String
|
No
|
Broker identifier
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.
|
|
Version
|
String
|
No
|
Broker version
|
|
InstanceName
|
String
|
No
|
Broker instance name
Example:
|
|
Port
|
Integer
|
Yes
|
Port number of Port Mapper
|
Operations
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
|
Name
|
Parameters
|
Result Type
|
Description
|
|
shutdown
|
nofailover (Boolean)
time (Long)
|
None
|
Shut down broker
If nofailover is false or null, another broker will attempt to take over for this broker
when it shuts down; this applies only to brokers in a high-availability
(HA) cluster. If nofailover is true, no such takeover attempt will occur.
The time parameter specifies the interval, in
seconds, before the broker actually shuts down; for immediate shutdown, specify 0 or null.
|
|
shutdown
|
None
|
None
|
Shut down broker immediately
If the broker is part of a high-availability (HA)
cluster, another broker will attempt to take over for it.
Equivalent to shutdown(Boolean.FALSE,
new Long(0)).
|
|
restart
|
None
|
None
|
Restart broker
|
|
quiesce
|
None
|
None
|
Quiesce broker
The broker will refuse any new connections; existing connections will
continue to be served.
|
|
unquiesce
|
None
|
None
|
Unquiesce broker
The broker will again accept new connections.
|
|
takeover [HA clusters only]
|
brokerID (String)
|
None
|
Initiate takeover from specified broker
The desired broker is designated by its broker identifier (brokerID).
|
|
getProperty
|
propertyName (String)
|
String
|
Get value of configuration property
The desired property is designated by its name (propertyName)
|
|
resetMetrics
|
None
|
None
|
Reset metrics
Resets to zero all metrics in monitor MBeans that track cumulative,
peak, or average counts. The following attributes are affected:
|
|
|
|
|
Service monitor
NumConnectionsOpened
NumConnectionsRejected
NumMsgsIn
NumMsgsOut
MsgBytesIn
MsgBytesOut
NumPktsIn
NumPktsOut
PktBytesIn
PktBytesOut
|
|
|
|
|
Service manager monitor
NumMsgsIn
NumMsgsOut
MsgBytesIn
MsgBytesOut
NumPktsIn
NumPktsOut
PktBytesIn
PktBytesOut
|
|
|
|
|
Connection manager monitor
NumConnectionsOpened
NumConnectionsRejected
|
|
|
|
|
Destination monitor
PeakNumConsumers
AvgNumConsumers
PeakNumActiveConsumers
AvgNumActiveConsumers
PeakNumBackupConsumers
AvgNumBackupConsumers
PeakNumMsgs
AvgNumMsgs
NumMsgsIn
NumMsgsOut
MsgBytesIn
MsgBytesOut
PeakMsgBytes
PeakTotalMsgBytes
AvgTotalMsgBytes
|
|
|
|
|
Transaction manager monitor
NumTransactionsCommitted
NumTransactionsRollback
|
Notification
The broker configuration MBean supports the notification shown in Table 3–3.
Table 3–3 Broker Configuration Notification
|
Name
|
Description
|
|
jmx.attribute.change
|
Attribute value changed
|
