Changes to JMX API (Sun Java System Message Queue 4.2 Release Notes)

Sun Java System Message Queue 4.2 Release Notes

Changes to JMX API

Message Queue supports the Java Management Extensions (JMX) API for configuring and monitoring broker functions programmatically from within a Message Queue client application. Message Queue 4.2 includes extensions to the JMX API to support new features and functionality in the release. New JMX attributes, operations, and/or lookup keys are defined for the following Mbeans:

ConsumerManager Monitor MBean

The attributes, operations, and lookup keys in the following tables support the feature described in Multiple Destinations for a Publisher or Subscriber.

The name of the following attribute is defined as static constants in the utility class com.sun.messaging.jms.management.server.ConsumerAttributes.

Table 1–10 ConsumerManager Monitor Attributes


Name	Type	Settable?	Description
`NumWildcardConsumers`	`Integer`	No	Number of wildcard message consumers associated with the broker

The names of the following operations are defined as static constants in the utility class com.sun.messaging.jms.management.server.ConsumerOperations.

Table 1–11 ConsumerManager Monitor Operations


Name	Parameters	Result Type	Description
`getConsumerWildcards`	none	`String[]`	Wildcard strings used by current consumers associated with the broker
`getNumWildcardConsumers`	wildcard-String	`Integer`	Number of current consumers associated with the broker that are using the specified wildcard string

The following lookup keys are defined as static constants in the utility class com.sun.messaging.jms.management.server.ConsumerInfo.

Table 1–12 Lookup Keys for Message Consumer Information


Name	Value Type	Description
`DestinationNames`	`String[]`	Destination names that match wildcards used by wildcard consumers For topic destinations only.
`Wildcard`	`Boolean`	Wildcard consumer? For topic destinations only.

Destination Configuration MBean

The attributes in the following table support the feature described in Schema Validation of XML Payload Messages.

The names of the following attributes are defined as static constants in the utility class com.sun.messaging.jms.management.server.DestinationAttributes.

Table 1–13 Destination Configuration Attributes


Name	Type	Settable?	Description
`ValidateXMLSchemaEnabled`	`Boolean`	Yes	XML schema validation is enabled? If set to `false` or not set, then XML schema validation is not enabled for the destination.
`XMLSchemaURIList`	`String`	Yes	Space separated list of XML schema document (XSD) URI strings The URIs point to the location of one or more XSDs to use for XML schema validation, if enabled. Use double quotes around this value if multiple URIs are specified. Example: “`http://foo/flap.xsd http://test.com/test.xsd`” If this property is not set or null and XML validation is enabled, XML validation is performed using a DTD specified in the XML document.
`ReloadXMLSchemaOnFailure`	`Boolean`	Yes	Reload XML schema on failure enabled? If set to false or not set, then the schema is not reloaded if validation fails.

Destination Manager Configuration MBean

The new Destination Configuration MBean attributes, above, that support the new feature, Schema Validation of XML Payload Messages, can be used in creating a destination using the create operation of the Destination Manager Configuration MBean.

Destination Monitor MBean

The first set of attributes in the following table support the feature described in Multiple Destinations for a Publisher or Subscriber and the second set of attributes support the enhancement described in New Destination Metrics.

The names of the following attributes are defined as static constants in the utility class com.sun.messaging.jms.management.server.DestinationAttributes.

Table 1–14 Destination Monitor Attributes


Name	Type	Settable?	Description
`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.
`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.
`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.

The operations in the following table support the feature described in Multiple Destinations for a Publisher or Subscriber.

The names of the following operations are defined as static constants in the utility class com.sun.messaging.jms.management.server.DestinationOperations.

Table 1–15 Destination Monitor Operations


Name	Parameters	Result Type	Description
`getConsumerWildcards`	none	`String[]`	Wildcard strings used by current consumers associated with the destination For topic destinations only.
`getProducerWildcards`	none	`String[]`	Wildcard strings used by current producers associated with the destination For topic destinations only.
`getWildcards`	none	`String[]`	Wildcard strings used by current consumers and producers associated with the destination For topic destinations only.
`getNumWildcardConsumers`	wildcard-String	`Integer`	Number of current consumers associated with the destination that are using the specified wildcard string For topic destinations only.
`getNumWildcardProducers`	wildcard-String	`Integer`	Number of current producers associated with the destination that are using the specified wildcard string For topic destinations only.

ProducerManager Monitor MBean

The attributes, operations, and lookup keys in the tables below support the feature described in Multiple Destinations for a Publisher or Subscriber.

The name of the following attribute is defined as static constants in the utility class com.sun.messaging.jms.management.server.ProducerAttributes.

Table 1–16 ProducerManager Monitor Attributes


Name	Type	Settable?	Description
`NumWildcardProducers`	`Integer`	No	Number of wildcard message producers associated with the broker

The names of the following operations are defined as static constants in the utility class com.sun.messaging.jms.management.server.ProducerOperations.

Table 1–17 ProducerManager Monitor Operations


Name	Parameters	Result Type	Description
`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 following lookup keys are defined as static constants in the utility class com.sun.messaging.jms.management.server.ProducerInfo.

Table 1–18 Lookup Keys for Message Producer Information


Name	Value Type	Description
`DestinationNames`	`String[]`	Destination names that match wildcards used by wildcard producers For topic destinations only.
`Wildcard`	`Boolean`	Wildcard producer? For topic destinations only.