Object Names (Sun Java System Message Queue 4.1 Developer's Guide for JMX Clients)

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

Object Names

Each individual MBean is designated by an object name belonging to the JMX class ObjectName, which encapsulates a string identifying the MBean. For Message Queue MBeans, the encapsulated name string has the following syntax:

com.sun.messaging.jms.server:property=value[,property=value]*

Table 1–1 shows the possible properties.

Table 1–1 Object Name Properties


Property	Description	Values
`type`	MBean type	See Table 1–2.
`subtype`	MBean subtype	See Table 1–3.
`desttype`	Destination type Applies only to MBeans of the following types: Destination configuration Destination monitor	See Table 1–4.
`name`	Resource name Applies only to MBeans of the following types: Service configuration Service monitor Destination configuration Destination monitor	For service configuration and service monitor MBeans, see Table 1–5. For destination configuration and destination monitor MBeans, the destination name. Examples: `myTopic` `temporary_destination://queue/129.145.180.99/63008/1`
`id`	Resource identifier Applies only to MBeans of the following types: Connection configuration Connection monitor	Example: `7853717387765338368`

Table 1–2 shows the possible values for the object name's type property.

Table 1–2 Message Queue MBean Types


Value	Description
`Broker`	Broker resource MBean
`Service`	Connection service resource MBean
`ServiceManager`	Connection service manager MBean
`Connection`	Connection resource MBean
`ConnectionManager`	Connection manager MBean
`Destination`	Destination resource MBean
`DestinationManager`	Destination manager MBean
`ProducerManager`	Message producer manager MBean
`ConsumerManager`	Message consumer manager MBean
`TransactionManager`	Transaction manager MBean
`Cluster`	Broker cluster resource MBean
`Log`	Logging resource MBean
`JVM`	JVM resource MBean

Table 1–3 shows the possible values for the object name's subtype property.

Table 1–3 Message Queue MBean Subtypes


Value	Description
`Config`	Configuration MBean
`Monitor`	Monitor MBean

For destination configuration and destination monitor MBeans, the object name's desttype property specifies whether the destination is a point-to-point queue or a publish/subscribe topic. Table 1–4 shows the possible values, which are defined for convenience as static constants in the utility class DestinationType.

Table 1–4 Destination Types


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

For service configuration and service monitor MBeans, the object name's name property identifies the connection service with which the MBean is associated. Table 1–5 shows the possible values.

Table 1–5 Connection Service Names


Service Name	Service Type	Protocol Type
`jms`	Normal	TCP
`ssljms`	Normal	TLS (SSL-based security)
`httpjms`	Normal	HTTP
`httpsjms`	Normal	HTTPS (SSL-based security)
`admin`	Admin	TCP
`ssladmin`	Admin	TLS (SSL-based security)

Table 1–6 shows some example object names.

Table 1–6 Example Object Names


MBean type	Object Name
Broker configuration	`com.sun.messaging.jms.server:type=Broker,subtype=Config`
Service manager monitor	`com.sun.messaging.jms.server:type=ServiceManager,subtype=Monitor`
Connection configuration	`com.sun.messaging.jms.server:type=Connection,subtype=Config,id=7853717387765338368`
Destination monitor	`com.sun.messaging.jms.server:type=Destination,subtype=Monitor,desttype=t,name="MyQueue"`

The object names for each type of Message Queue MBean are given in the relevant sections of Chapter 3, Message Queue MBean Reference. All such names are either defined as static constants or returned by static methods in the utility class MQObjectName (see Table 1–7). For instance, the constant

MQObjectName.BROKER_CONFIG_MBEAN_NAME

is defined as a string representing the object name for a broker configuration MBean, and the method call

MQObjectName.createDestinationMonitor(DestinationType.TOPIC, "MyQueue");

returns the destination monitor MBean object name shown in Table 1–6. Note that, whereas methods such as createDestinationMonitor return an actual object name (that is, an object of class ObjectName) that can be assigned directly to a variable of that type

ObjectName  destMonitorName
    = MQObjectName.createDestinationMonitor(DestinationType.TOPIC, "Dest");

constants like BROKER_CONFIG_MBEAN_NAME instead represent an ordinary string (class String) that must then be converted into the corresponding object name itself:

ObjectName  brokerConfigName
    = new ObjectName(MQObjectName.BROKER_CONFIG_MBEAN_NAME);

Table 1–7 Utility Constants and Methods for Object Names


MBean Type	Utility Constant or Method
Broker configuration	`MQObjectName.BROKER_CONFIG_MBEAN_NAME`
Broker monitor	`MQObjectName.BROKER_MONITOR_MBEAN_NAME`
Service configuration	`MQObjectName.createServiceConfig`
Service monitor	`MQObjectName.createServiceMonitor`
Service manager configuration	`MQObjectName.SERVICE_MANAGER_CONFIG_MBEAN_NAME`
Service manager monitor	`MQObjectName.SERVICE_MANAGER_MONITOR_MBEAN_NAME`
Connection configuration	`MQObjectName.createConnectionConfig`
Connection monitor	`MQObjectName.createConnectionMonitor`
Connection manager configuration	`MQObjectName.CONNECTION_MANAGER_CONFIG_MBEAN_NAME`
Connection manager monitor	`MQObjectName.CONNECTION_MANAGER_MONITOR_MBEAN_NAME`
Destination configuration	`MQObjectName.createDestinationConfig`
Destination monitor	`MQObjectName.createDestinationMonitor`
Destination manager configuration	`MQObjectName.DESTINATION_MANAGER_CONFIG_MBEAN_NAME`
Destination manager monitor	`MQObjectName.DESTINATION_MANAGER_MONITOR_MBEAN_NAME`
Producer manager configuration	`MQObjectName.PRODUCER_MANAGER_CONFIG_MBEAN_NAME`
Producer manager monitor	`MQObjectName.PRODUCER_MANAGER_MONITOR_MBEAN_NAME`
Consumer manager configuration	`MQObjectName.CONSUMER_MANAGER_CONFIG_MBEAN_NAME`
Consumer manager monitor	`MQObjectName.CONSUMER_MANAGER_MONITOR_MBEAN_NAME`
Transaction manager configuration	`MQObjectName.TRANSACTION_MANAGER_CONFIG_MBEAN_NAME`
Transaction manager monitor	`MQObjectName.TRANSACTION_MANAGER_MONITOR_MBEAN_NAME`
Cluster configuration	`MQObjectName.CLUSTER_CONFIG_MBEAN_NAME`
Cluster monitor	`MQObjectName.CLUSTER_MONITOR_MBEAN_NAME`
Log configuration	`MQObjectName.LOG_CONFIG_MBEAN_NAME`
Log monitor	`MQObjectName.LOG_MONITOR_MBEAN_NAME`
JVM monitor	`MQObjectName.JVM_MONITOR_MBEAN_NAME`