Destination Manager Configuration (Sun Java System Message Queue 4.3 Developer's Guide for JMX Clients)

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

Destination Manager Configuration

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

Object Name

The destination manager configuration MBean has the following object name:

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

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

Attributes

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

Table 3–44 Destination Manager Configuration Attributes


Name	Type	Settable?	Description
`AutoCreateQueues`	`Boolean`	Yes	Allow auto-creation of queue destinations?
`AutoCreateTopics`	`Boolean`	Yes	Allow auto-creation of topic destinations?
`NumDestinations`	`Integer`	No	Current total number of destinations
`MaxNumMsgs`	`Long`	Yes	Maximum total number of unconsumed messages A value of `-1` denotes an unlimited number of messages.
`MaxBytesPerMsg`	`Long`	Yes	Maximum size, in bytes, of any single message A value of `-1` denotes an unlimited message size.
`MaxTotalMsgBytes`	`Long`	Yes	Maximum total memory, in bytes, for unconsumed messages A value of `-1` denotes an unlimited number of bytes.
`AutoCreateQueueMaxNumActiveConsumers` [Auto-created queue destinations only]	`Integer`	Yes	Maximum total number of active message consumers in load-balanced delivery A value of `-1` denotes an unlimited number of consumers.
`AutoCreateQueueMaxNumBackupConsumers`	`Integer`	Yes	Maximum total number of backup message consumers in load-balanced delivery A value of `-1` denotes an unlimited number of consumers.
`DMQTruncateBody`	`Boolean`	Yes	Remove message body before storing in dead message queue? If `true`, only the message header and property data will be saved.
`LogDeadMsgs`	`Boolean`	Yes	Log information about dead messages? If `true`, the following events will be logged: A destination is full, having reached its maximum size or message count. The broker discards a message for a reason other than an administrative command or delivery acknowledgment. The broker moves a message to the dead message queue.

Operations

The destination manager configuration MBean supports the operations shown in Table 3–45. The names of these operations are defined as static constants in the utility class DestinationOperations.

Table 3–45 Destination Manager Configuration Operations


Name	Parameters	Result Type	Description
`getDestinations`	None	`ObjectName[]`	Object names of destination configuration MBeans for all current destinations
`create`	`destinationType` (`String`) `destinationName` (`String`) `destinationAttributes` (`AttributeList`)	None	Create destination with specified type, name, and attributes The `destinationType` and `destinationName` parameters are required, but `destinationAttributes` may be `null`. See Table 3–46 for possible values of `destinationType`. The `destinationAttributes` list may include any of the attributes listed in Table 3–32 except `Name` and `Type`. The names of these attributes are defined as static constants in the utility class `DestinationAttributes`.
`create`	`destinationType` (`String`) `destinationName` (`String`)	None	Create destination with specified type and name Equivalent to `create(destinationType,` `destinationName,` `null)`. See Table 3–46 for possible values of `destinationType`.
`destroy`	`destinationType` (`String`) `destinationName` (`String`)	None	Destroy destination See Table 3–46 for possible values of `destinationType`.
`pause`	`pauseType` (`String`)	None	Pause message delivery for all destinations See Table 3–47 for possible values of `pauseType`.
`pause`	None	None	Pause all message delivery for all destinations Equivalent to `pause(DestinationPauseType.ALL)`.
`resume`	None	None	Resume message delivery for all destinations
`compact` [File-based persistence only]	None	None	Compact all destinations Note – Only paused destinations can be compacted.

Table 3–46 shows the possible values for the create and destroy operations' destinationType parameters. These values are defined as static constants in the utility class DestinationType.

Table 3–46 Destination Manager Configuration Type Values


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

Table 3–47 shows the possible values for the pause operation's pauseType parameter. These values are defined as static constants in the utility class DestinationPauseType.

Table 3–47 Destination Manager Pause Types


Value	Utility Constant	Meaning
`PRODUCERS`	`DestinationPauseType.PRODUCERS`	Pause delivery from associated message producers
`CONSUMERS`	`DestinationPauseType.CONSUMERS`	Pause delivery to associated message consumers
`ALL`	`DestinationPauseType.ALL`	Pause all delivery

Notification

The destination manager configuration MBean supports the notification shown in Table 3–48.

Table 3–48 Destination Manager Configuration Notification


Name	Description
`jmx.attribute.change`	Attribute value changed