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 |
---|---|---|---|
None |
String[] | ||
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. |
|
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. |
|
none |
String[] |
Wildcard strings used by current consumers associated with the broker |
|
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.
Table 3–63 Lookup Keys for Message Consumer Information
Name |
Value Type |
Description |
---|---|---|
String | ||
String |
Message selector |
|
String |
Name of associated connection service |
|
String | ||
String |
Connection's host name |
|
String |
Connection's user name |
|
String |
Name of associated destination |
|
String[] |
Destination names that match wildcards used by wildcard consumers For topic destinations only. |
|
Boolean |
Wildcard consumer? For topic destinations only. |
|
String |
Type of associated destination See Table 3–64 for possible values. |
|
Integer |
Acknowledgment mode of associated session See Table 3–65 for possible values. |
|
String |
String representation of acknowledgment mode Useful for displaying the acknowledgment mode in human-readable form, such as in the Java Monitoring and Management Console (jconsole). See Table 3–65 for possible values. |
|
Boolean |
Durable topic subscriber? |
|
String |
Subscription name |
|
String |
Client identifier |
|
Boolean |
Subscriber active? |
|
Boolean |
Message delivery paused? |
|
Long |
Cumulative number of messages that have been dispatched to consumer (includes messages that have been delivered and those waiting to be delivered) |
|
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) |
|
Long |
Current number of messages that have been delivered to consumer and are being held in broker memory and persistent store pending acknowledgment |
|
Long |
JMS Message ID of the next message to be delivered to consumer |
|
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 |
---|---|---|
Queue (point-to-point) destination |
||
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.
Table 3–65 Acknowledgment Modes
Value |
Utility Constant |
String Representation |
Meaning |
---|---|---|---|
1 |
AUTO_ACKNOWLEDGE |
Auto-acknowledge mode |
|
2 |
CLIENT_ACKNOWLEDGE |
Client-acknowledge mode |
|
3 |
DUPS_OK_ACKNOWLEDGE |
Dups-OK-acknowledge mode |
|
32768 |
NO_ACKNOWLEDGE |
No-acknowledge mode |
|
0 |
SESSION_TRANSACTED |
Session is transacted (acknowledgment mode ignored) |