test

Sun Java System Message Queue 4.0 Developer's Guide for JMX Clients

Broker Configuration

The broker configuration MBean is used for configuring a message 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 2–1. The names of these attributes are defined as static constants in the utility class BrokerAttributes.

Table 2–1 Broker Configuration Attributes

Name 

Type 

Settable? 

Description 

BrokerID

String

No 

Broker identifier

Appended to database table names to make them unique when more than one broker instance is using the same database as a persistent data store. If a database is not used as the persistent data store, the value of this attribute is null.

Version

String

No 

Broker version 

InstanceName

String

No 

Broker instance name 

Example: imqbroker

Port

Integer

Yes 

Port number of Port Mapper 

Operations

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

Table 2–2 Broker Configuration Operations

Name 

Parameters 

Return Type 

Description 

shutdown

time (Long)

None 

Shut down broker 

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 

Equivalent to shutdown(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.  

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 2–3.

Table 2–3 Broker Configuration Notification

Name 

Description 

jmx.attribute.change

Attribute value changed