Consumer Manager Monitor

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

Object Name

The consumer manager monitor MBean has the following object name:

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

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

Attribute

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

Table 3–61 Consumer Manager Monitor
Attribute

Name

Type

Settable?

Description

NumConsumers

Integer

No

Current total number of message consumers

NumWildcardConsumers

Integer

No

Number of wildcard message consumers associated with the broker

Operations

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

Table 3–62 Consumer Manager Monitor
Operations

Name

Parameters

Result Type

Description

getConsumerIDs

None

String[]

Consumer identifiers of all current message consumers

getConsumerInfoByID

consumerID (String)

CompositeData

Descriptive information about message consumer

The desired consumer is designated by its consumer
identifier (consumerID). The value returned is a JMX CompositeData object describing the consumer; see Table 3–63 for lookup keys used with
this object.

getConsumerInfo

None

CompositeData[]

Descriptive information about all current message consumers

The value returned is an array of JMX CompositeData objects
describing the consumers; see Table 3–63 for
lookup keys used with these objects.

getConsumerWildcards

none

String[]

Wildcard strings used by current consumers associated with the broker

getNumWildcardConsumers

wildcard-String

Integer

Number of current consumers associated with the broker that are using
the specified wildcard string

The getConsumerInfoByID and getConsumerInfo operations return objects
implementing the JMX interface CompositeData,
which maps lookup keys to associated data values. The keys shown in Table 3–63 are defined as static constants
in the utility class ConsumerInfo for use with these objects.

Cumulative number of messages that have been dispatched to consumer
(includes messages that have been delivered and those waiting to be delivered)

NumMsgsPending

Long

Current number of messages that have been dispatched to consumer and are being held in broker memory and persistent
store (includes messages that have been delivered and those waiting to be
delivered)

NumMsgsPendingAcks

Long

Current number of messages that have been delivered to consumer and
are being held in broker memory and persistent store pending acknowledgment

NextMessageID

Long

JMS Message ID of the next message to be delivered to consumer

LastAckTime

Long

Time of last acknowledgment, in standard Java format (milliseconds since
January 1, 1970, 00:00:00 UTC)

Table 3–64 shows the possible
values returned for the lookup key DestinationType. These values are defined as static constants in the utility class DestinationType.

Table 3–64 Message Consumer Destination
Types

Value

Utility Constant

Meaning

q

DestinationType.QUEUE

Queue (point-to-point) destination

t

DestinationType.TOPIC

Topic (publish/subscribe) destination

Table 3–65 shows the possible
values returned for the lookup keys AcknowledgeMode and AcknowledgeModeLabel. Four of these values are defined as static constants in the standard
JMS interface javax.jms.Session;
the fifth (NO_ACKNOWLEDGE) is defined in the extended Message Queue version
of the interface, com.sun.messaging.jms.Session.