Oracle GlassFish Message Queue 4.4.2 Developer's Guide for JMX Clients

Connections

This section describes the MBeans used for managing connections:

The connection configuration MBean configures a connection.
The connection monitor MBean monitors a connection.
The connection manager configuration MBean manages connection configuration MBeans.
The connection manager monitor MBean manages connection monitor MBeans.

The following subsections describe each of these MBeans in detail.

Connection Configuration

The connection configuration MBean is used for configuring a connection. There is one such MBean for each connection.

Object Name

The connection configuration MBean has an object name of the following form:

com.sun.messaging.jms.server:type=Connection,subtype=Config,id=connectionID

where connectionID is the connection identifier. For example:

com.sun.messaging.jms.server:type=Connection,subtype=Config,id=7853717387765338368

The utility class MQObjectName provides a static method, createConnectionConfig, for constructing object names of this form.

Attribute

The connection configuration MBean has the attribute shown in Table 3–23. The name of this attribute is defined as a static constant in the utility class ConnectionAttributes.

Table 3–23 Connection Configuration Attribute


Name	Type	Settable?	Description
`ConnectionID`	`String`	No	Connection identifier

Connection Monitor

The connection monitor MBean is used for monitoring a connection. There is one such MBean for each connection.

Object Name

The connection monitor MBean has an object name of the following form:

com.sun.messaging.jms.server:type=Connection,subtype=Monitor,id=connectionID

where connectionID is the connection identifier. For example:

com.sun.messaging.jms.server:type=Connection,subtype=Monitor,id=7853717387765338368

The utility class MQObjectName provides a static method, createConnectionMonitor, for constructing object names of this form.

Attributes

The connection monitor MBean has the attributes shown in Table 3–24. The names of these attributes are defined as static constants in the utility class ConnectionAttributes.

Table 3–24 Connection Monitor Attributes


Name	Type	Settable?	Description
`ConnectionID`	`String`	No	Connection identifier
`Host`	`String`	No	Host from which connection was made
`Port`	`Integer`	No	Port number
`ServiceName`	`String`	No	Connection service name
`User`	`String`	No	User name
`ClientID`	`String`	No	Client identifier
`ClientPlatform`	`String`	No	String describing client platform
`NumProducers`	`Integer`	No	Current number of associated message producers
`NumConsumers`	`Integer`	No	Current number of associated message consumers

Operations

The connection monitor MBean supports the operations shown in Table 3–25. The names of these operations are defined as static constants in the utility class ConnectionOperations.

Table 3–25 Connection Monitor Operations


Name	Parameters	Result Type	Description
`getService`	None	`ObjectName`	Object name of service monitor MBean for associated connection service
`getTemporaryDestinations`	None	`ObjectName[]`	Object names of destination monitor MBeans for all associated temporary destinations
`getProducerIDs`	None	`String[]`	Producer identifiers of all associated message producers
`getConsumerIDs`	None	`String[]`	Consumer identifiers of all associated message consumers

Connection Manager Configuration

Each broker has a single connection manager configuration MBean, used for managing all of the broker's connection configuration MBeans.

Object Name

The connection manager configuration MBean has the following object name:

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

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

Attribute

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

Table 3–26 Connection Manager Configuration Attribute


Name	Type	Settable?	Description
`NumConnections`	`Integer`	No	Number of current connections

Operations

The connection manager configuration MBean supports the operations shown in Table 3–27. The names of these operations are defined as static constants in the utility class ConnectionOperations.

Table 3–27 Connection Manager Configuration Operations


Name	Parameters	Result Type	Description
`getConnections`	None	`ObjectName[]`	Object names of connection configuration MBeans for all current connections
`destroy`	`connectionID` (`Long`)	None	Destroy connection The desired connection is designated by its connection identifier (`connectionID`).

Connection Manager Monitor

Each broker has a single connection manager monitor MBean, used for managing all of the broker's connection monitor MBeans.

Object Name

The connection manager monitor MBean has the following object name:

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

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

Attributes

The connection manager monitor MBean has the attributes shown in Table 3–28. The names of these attributes are defined as static constants in the utility class ConnectionAttributes.

Table 3–28 Connection Manager Monitor Attributes


Name	Type	Settable?	Description
`NumConnections`	`Integer`	No	Current number of connections
`NumConnectionsOpened`	`Long`	No	Cumulative number of connections opened since broker started
`NumConnectionsRejected`	`Long`	No	Cumulative number of connections rejected since broker started

Operation

The connection manager monitor MBean supports the operation shown in Table 3–29. The name of this operation is defined as a static constant in the utility class ConnectionOperations.

Table 3–29 Connection Manager Monitor Operation


Name	Parameters	Result Type	Description
`getConnections`	None	`ObjectName[]`	Object names of connection monitor MBeans for all current connections

Notifications

The connection manager monitor MBean supports the notifications shown in Table 3–30. These notifications are instances of the Message Queue JMX class ConnectionNotification, and their names are defined as static constants in that class.

Table 3–30 Connection Manager Monitor Notifications


Name	Utility Constant	Description
`mq.connection.open`	`ConnectionNotification.CONNECTION_OPEN`	Connection opened
`mq.connection.reject`	`ConnectionNotification.CONNECTION_REJECT`	Connection rejected
`mq.connection.close`	`ConnectionNotification.CONNECTION_CLOSE`	Connection closed

Table 3–31 shows the methods defined in class ConnectionNotification for obtaining details about a connection manager monitor notification.

Table 3–31 Data Retrieval Methods for Connection Manager Monitor Notifications


Method	Result Type	Description
`getConnectionID`	`String`	Connection identifier
`getRemoteHost`	`String`	Host from which connection was made
`getServiceName`	`String`	Connection service name
`getUserName`	`String`	User name