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

Attributes

The destination monitor MBean has the attributes shown in Table 3–38. The names of these attributes are defined as static constants in the utility class DestinationAttributes.

Table 3–38 Destination Monitor Attributes

Name 

Type 

Settable? 

Description 

Name

String

No 

Destination name 

Type

String

No 

Destination type 

See Table 3–39 for possible values.

CreatedByAdmin

Boolean

No 

Administrator-created destination?  

Temporary

Boolean

No 

Temporary destination?  

ConnectionID [Temporary destinations only]

String

No 

Connection identifier

State

Integer

No 

Current state 

See Table 3–40 for possible values.

StateLabel

String

No 

String representation of current state:  

Useful for displaying the state in human-readable form, such as in the Java Monitoring and Management Console (jconsole).

See Table 3–40 for possible values.

NumProducers

Integer

No 

Current number of associated message producers 

NumConsumers

Integer

No 

Current number of associated message consumers 

For queue destinations, this attribute includes both active and backup consumers. For topic destinations, it includes both nondurable and (active and inactive) durable subscribers and is equivalent to NumActiveConsumers.

NumWildcardProducers

Integer

No 

Current number of wildcard message producers associated with the destination 

For topic destinations only. 

NumWildcardConsumers

Integer

No 

Current number of wildcard message consumers associated with the destination 

For topic destinations only. 

NumWildcards

Integer

No 

Current number of wildcard message producers and wildcard message consumers associated with the destination 

For topic destinations only. 

PeakNumConsumers

Integer

No 

Peak number of associated message consumers since broker started 

For queue destinations, this attribute includes both active and backup consumers. For topic destinations, it includes both nondurable and (active and inactive) durable subscribers and is equivalent to PeakNumActiveConsumers.

AvgNumConsumers

Integer

No 

Average number of associated message consumers since broker started 

For queue destinations, this attribute includes both active and backup consumers. For topic destinations, it includes both nondurable and (active and inactive) durable subscribers and is equivalent to AvgNumActiveConsumers.

NumActiveConsumers

Integer

No 

Current number of associated active message consumers 

For topic destinations, this attribute includes both nondurable and (active and inactive) durable subscribers and is equivalent to NumConsumers.

PeakNumActiveConsumers

Integer

No 

Peak number of associated active message consumers since broker started 

For topic destinations, this attribute includes both nondurable and (active and inactive) durable subscribers and is equivalent to PeakNumConsumers.

AvgNumActiveConsumers

Integer

No 

Average number of associated active message consumers since broker started 

For topic destinations, this attribute includes both nondurable and (active and inactive) durable subscribers and is equivalent to AvgNumConsumers.

NumBackupConsumers [Queue destinations only]

Integer

No 

Current number of associated backup message consumers 

PeakNumBackupConsumers

Integer

No 

Peak number of associated backup message consumers since broker started 

AvgNumBackupConsumers

Integer

No 

Average number of associated backup message consumers since broker started 

NumMsgs

Long

No 

Current number of messages stored in memory and persistent store 

Does not include messages held in transactions. 

NumMsgsRemote

Long

No 

Current number of messages stored in memory and persistent store that were produced to a remote broker in a cluster. This number does not include messages included in transactions. 

NumMsgsPendingAcks

Long

No 

Current number of messages being held in memory and persistent store pending acknowledgment 

NumMsgsHeldInTransaction

Long

No 

Current number of messages being held in memory and persistent store in uncommitted transactions 

PeakNumMsgs

Long

No 

Peak number of messages stored in memory and persistent store since broker started 

AvgNumMsgs

Long

No 

Average number of messages stored in memory and persistent store since broker started 

NumMsgsIn

Long

No 

Cumulative number of messages received since broker started 

NumMsgsOut

Long

No 

Cumulative number of messages sent since broker started 

MsgBytesIn

Long

No 

Cumulative size in bytes of messages received since broker started 

MsgBytesOut

Long

No 

Cumulative size in bytes of messages sent since broker started 

PeakMsgBytes

Long

No 

Size in bytes of largest single message received since broker started 

TotalMsgBytes

Long

No 

Current total size in bytes of messages stored in memory and persistent store 

Does not include messages held in transactions.  

TotalMsgBytesRemote

Long

No 

Current total size in bytes of messages stored in memory and persistent store that were produced to a remote broker in a cluster. This value does not include messages included in transactions. 

TotalMsgBytesHeldInTransaction

Long

No 

Current total size in bytes of messages being held in memory and persistent store in uncommitted transactions 

PeakTotalMsgBytes

Long

No 

Peak total size in bytes of messages stored in memory and persistent store since broker started 

AvgTotalMsgBytes

Long

No 

Average total size in bytes of messages stored in memory and persistent store since broker started 

DiskReserved [File-based persistence only]

Long

No 

Amount of disk space, in bytes, reserved for destination 

DiskUsed

Long

No 

Amount of disk space, in bytes, currently in use by destination 

DiskUtilizationRatio

Integer

No 

Ratio of disk space currently in use to disk space reserved for destination 

Table 3–39 shows the possible values for the Type attribute. These values are defined as static constants in the utility class DestinationType.

Table 3–39 Destination Monitor Type Values

Value 

Utility Constant 

Meaning 

q

DestinationType.QUEUE

Queue (point-to-point) destination 

t

DestinationType.TOPIC

Topic (publish/subscribe) destination 

Table 3–40 shows the possible values for the State and StateLabel attributes. These values are defined as static constants in the utility class DestinationState.

Table 3–40 Destination State Values

Value 

Utility Constant 

String Representation 

Meaning 

0

DestinationState.RUNNING

RUNNING

Destination running 

1

DestinationState.CONSUMERS_PAUSED

CONSUMERS_PAUSED

Message consumers paused 

2

DestinationState.PRODUCERS_PAUSED

PRODUCERS_PAUSED

Message producers paused 

3

DestinationState.PAUSED

PAUSED

Destination paused 

-1

DestinationState.UNKNOWN

UNKNOWN

Destination state unknown