JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle GlassFish Server Message Queue 4.5 Developer's Guide for JMX Clients
search filter icon
search icon

Document Information

Preface

1.  Introduction to JMX Programming for Message Queue Clients

2.  Using the JMX API

3.  Message Queue MBean Reference

Brokers

Broker Configuration

Object Name

Attributes

Operations

Notification

Broker Monitor

Object Name

Attributes

Notifications

Connection Services

Service Configuration

Object Name

Attributes

Operations

Notification

Service Monitor

Object Name

Attributes

Operations

Notifications

Service Manager Configuration

Object Name

Attributes

Operations

Service Manager Monitor

Object Name

Attributes

Operation

Notifications

Connections

Connection Configuration

Object Name

Attribute

Connection Monitor

Object Name

Attributes

Operations

Connection Manager Configuration

Object Name

Attribute

Operations

Connection Manager Monitor

Object Name

Attributes

Operation

Notifications

Destinations

Destination Configuration

Object Name

Attributes

Operations

Notification

Destination Monitor

Object Name

Attributes

Operations

Notifications

Destination Manager Configuration

Object Name

Attributes

Operations

Notification

Destination Manager Monitor

Object Name

Attributes

Operation

Notifications

Message Producers

Producer Manager Configuration

Object Name

Attribute

Operation

Producer Manager Monitor

Object Name

Attribute

Operations

Message Consumers

Consumer Manager Configuration

Object Name

Attribute

Operations

Consumer Manager Monitor

Object Name

Attribute

Operations

Transactions

Transaction Manager Configuration

Object Name

Attribute

Operations

Transaction Manager Monitor

Object Name

Attributes

Operations

Notifications

Broker Clusters

Cluster Configuration

Object Name

Attributes

Operations

Notification

Cluster Monitor

Object Name

Attributes

Operations

Notifications

Logging

Log Configuration

Object Name

Attributes

Notification

Log Monitor

Object Name

Notifications

Java Virtual Machine

JVM Monitor

Object Name

Attributes

A.  Alphabetical Reference

Index

Message Producers

This section describes the MBeans used for managing message producers:

The following subsections describe each of these MBeans in detail.


Note - Notice that there are no resource MBeans associated with individual message producers; rather, all producers are managed through the broker's global producer manager configuration and producer manager monitor MBeans.


Producer Manager Configuration

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

Object Name

The producer manager configuration MBean has the following object name:

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

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

Attribute

The producer manager configuration MBean has the attribute shown in Table 3-53. The name of this attribute is defined as a static constant in the utility class ProducerAttributes.

Table 3-53 Producer Manager Configuration Attribute

Name
Type
Settable?
Description
NumProducers
Integer
No
Current total number of message producers

Operation

The producer manager configuration MBean supports the operation shown in Table 3-54. The name of this operation is defined as a static constant in the utility class ProducerOperations.

Table 3-54 Producer Manager Configuration Operation

Name
Parameters
Result Type
Description
getProducerIDs
None
String[]
Producer identifiers of all current message producers

Producer Manager Monitor

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

Object Name

The producer manager monitor MBean has the following object name:

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

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

Attribute

The producer manager monitor MBean has the attribute shown in Table 3-55. The name of this attribute is defined as a static constant in the utility class ProducerAttributes.

Table 3-55 Producer Manager Monitor Attribute

Name
Type
Settable?
Description
NumProducers
Integer
No
Current total number of message producers
NumWildcardProducers
Integer
No
Number of wildcard message producers associated with the broker

Operations

The producer manager monitor MBean supports the operations shown in Table 3-56. The names of these operations are defined as static constants in the utility class ProducerOperations.

Table 3-56 Producer Manager Monitor Operations

Name
Parameters
Result Type
Description
getProducerIDs
None
String[]
Producer identifiers of all current message producers
getProducerInfoByID
producerID (String)
CompositeData
Descriptive information about message producer

The desired producer is designated by its producer identifier (producerID). The value returned is a JMX CompositeData object describing the producer; see Table 3-57 for lookup keys used with this object.

getProducerInfo
None
CompositeData[]
Descriptive information about all current message producers

The value returned is an array of JMX CompositeData objects describing the producers; see Table 3-57 for lookup keys used with these objects.

getProducerWildcards
None
String[]
Wildcard strings used by current producers associated with the broker
getNumWildcardProducers
wildcard-String
Integer
Number of current producers associated with the broker that are using the specified wildcard string

The getProducerInfoByID and getProducerInfo operations return objects implementing the JMX interface CompositeData, which maps lookup keys to associated data values. The keys shown in Table 3-57 are defined as static constants in the utility class ProducerInfo for use with these objects.

Table 3-57 Lookup Keys for Message Producer Information

Name
Value Type
Description
ProducerID
String
Producer identifier
ServiceName
String
Name of associated connection service

ConnectionID

String
Connection identifier of associated connection
Host
String
Connection's host name
User
String
Connection's user name
DestinationName
String
Name of associated destination
DestinationNames
String[]
Destination names that match wildcards used by wildcard producers

For topic destinations only.

Wildcard
Boolean
Wildcard producer?

For topic destinations only.

DestinationType
String
Type of associated destination

See Table 3-58 for possible values.

FlowPaused
Boolean
Message delivery paused?
NumMsgs
Long
Number of messages sent

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

Table 3-58 Message Producer Destination Types

Value
Utility Constant
Meaning
q
DestinationType.QUEUE
Queue (point-to-point) destination
t
DestinationType.TOPIC
Topic (publish/subscribe) destination