Sun GlassFish Message Queue 4.4 Developer's Guide for JMX Clients

Consumer Manager Configuration

Each broker has a single consumer manager configuration MBean, used for configuring all of the broker's message consumers.

Object Name

The consumer manager configuration MBean has the following object name:

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

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

Attribute

The consumer manager configuration MBean has the attribute shown in Table 3–59. The name of this attribute is defined as a static constant in the utility class ConsumerAttributes.

Table 3–59 Consumer Manager Configuration Attribute

Name 

Type 

Settable? 

Description 

NumConsumers

Integer

No 

Current total number of message consumers 

Operations

The consumer manager configuration MBean supports the operations shown in Table 3–60. The names of these operations are defined as static constants in the utility class ConsumerOperations.

Table 3–60 Consumer Manager Configuration Operations

Name 

Parameters 

Result Type 

Description 

getConsumerIDs

None 

String[]

Consumer identifiers of all current message consumers

purge [Durable topic subscribers only]

consumerID (String)

None 

Purge all messages 

The desired subscriber is designated by its consumer identifier (consumerID).

The subscriber itself is not destroyed.