org.apache.qpid.server.jmx.mbeans

Class QueueMBean

java.lang.Object

javax.management.StandardMBean

org.apache.qpid.server.jmx.DefaultManagedObject

org.apache.qpid.server.jmx.AMQManagedObject

org.apache.qpid.server.jmx.mbeans.QueueMBean

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, ManagedQueue, ManagedObject, QueueNotificationListener

public class QueueMBean
extends AMQManagedObject
implements ManagedQueue, QueueNotificationListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	QueueMBean.GetMessageVisitor

Field Summary

Fields

Modifier and Type	Field and Description
static String	JMSTIMESTAMP_DATETIME_FORMAT Date/time format used for message expiration and message timestamp formatting

Fields inherited from interface org.apache.qpid.management.common.mbeans.ManagedQueue

ATTR_ACTIVE_CONSUMER_COUNT, ATTR_ALT_EXCHANGE, ATTR_AUTODELETE, ATTR_CAPACITY, ATTR_CONSUMER_COUNT, ATTR_DESCRIPTION, ATTR_DURABLE, ATTR_EXCLUSIVE, ATTR_FLOW_OVERFULL, ATTR_FLOW_RESUME_CAPACITY, ATTR_MAX_MSG_AGE, ATTR_MAX_MSG_COUNT, ATTR_MAX_MSG_SIZE, ATTR_MAX_QUEUE_DEPTH, ATTR_MAXIMUM_DELIVERY_COUNT, ATTR_MESSAGE_GROUP_KEY, ATTR_MSG_COUNT, ATTR_NAME, ATTR_OLDEST_MESSAGE_AGE, ATTR_OWNER, ATTR_QUEUE_DEPTH, ATTR_QUEUE_TYPE, ATTR_RCVD_MSG_COUNT, ATTR_SHARED_MESSAGE_GROUP, CONTENT, ENCODING, MIME, MSG_AMQ_ID, MSG_DELIVERY_COUNT, MSG_HEADER, MSG_QUEUE_POS, MSG_REDELIVERED, MSG_SIZE, QUEUE_ATTRIBUTES, TYPE, VIEW_MSG_CONTENT_COMPOSITE_ITEM_NAMES_DESC, VIEW_MSGS_COMPOSITE_ITEM_NAMES_DESC, VIEW_MSGS_TABULAR_UNIQUE_INDEX

Fields inherited from interface org.apache.qpid.server.jmx.ManagedObject

DOMAIN

Constructor Summary

Constructors

Constructor and Description
QueueMBean(Queue queue, VirtualHostMBean virtualHostMBean)

Method Summary

Modifier and Type	Method and Description
Long	clearQueue() Clears the queue by deleting all the messages from the queue that have not been acquired by consumers" Since Qpid JMX API 1.3 this returns the number of messages deleted.
void	copyMessages(long fromMessageId, long toMessageId, String toQueue) Copies the messages in given range of AMQ message Ids to a given Queue.
void	deleteMessageFromTop() Deprecated.
void	deleteMessages(long fromMessageId, long toMessageId) Deletes the messages in given range of AMQ message Ids in the given Queue.
Integer	getActiveConsumerCount() Returns the total number of active subscribers to the queue.
String	getAlternateExchange() Returns the name of the Alternate Exchange for the queue, or null if there isn't one.
Long	getCapacity() Returns the current flow control Capacity of the queue in bytes.
Integer	getConsumerCount() Returns the total number of subscribers to the queue.
String	getDescription() Gets the free text queue description.
Long	getFlowResumeCapacity() Returns the current flow control FlowResumeCapacity of the queue in bytes.
Integer	getMaximumDeliveryCount() Maximum number of times a message is permitted to be delivered or zero if not enforced.
Long	getMaximumMessageAge() Returns the maximum age of a message (expiration time) in milliseconds
Long	getMaximumMessageCount() Tells the maximum number of messages that can be stored in the queue.
Long	getMaximumMessageSize() Returns the maximum size of a message (in Bytes) allowed to be accepted by the ManagedQueue.
Long	getMaximumQueueDepth() This is useful for setting notifications or taking required action if the size of messages stored in the queue increases over this limit.
Integer	getMessageCount() Total number of messages on the queue, which are yet to be delivered to the consumer(s).
String	getMessageGroupKey() Gets the message group key
String	getName() Returns the Name of the ManagedQueue.
MBeanNotificationInfo[]	getNotificationInfo() returns Notifications sent by this MBean.
String	getObjectInstanceName()
Long	getOldestMessageAge() Gets the arrival time of the oldest message in the queue
String	getOwner() Tells the Owner of the ManagedQueue.
ManagedObject	getParentObject()
Long	getQueueDepth() Size of messages in the queue Since Qpid JMX API 1.2 this operation returns in units of bytes.
String	getQueueType() Gets the queue type
Long	getReceivedMessageCount() Tells the total number of messages receieved by the queue since startup.
boolean	isAutoDelete() Tells if the ManagedQueue is set to AutoDelete.
boolean	isDurable() Tells whether this ManagedQueue is durable or not.
boolean	isExclusive() Returns whether the queue is exclusive or not.
boolean	isFlowOverfull() Indicates whether the Queue is currently considered overfull by the FlowControl system
boolean	isMessageGroupSharedGroups() Gets the message group key
void	moveMessages(long fromMessageId, long toMessageId, String toQueue) Moves the messages in given range of message Ids to given Queue.
void	notifyClients(NotificationCheck notification, Queue queue, String notificationMsg)
void	setAlternateExchange(String exchangeName) Sets the Alternate Exchange for the queue, for use in dead letter queue functionality.
void	setCapacity(Long value) Sets the Capacity in bytes above which flow is blocked.
void	setDescription(String description) Sets the free text queue description.
void	setExclusive(boolean exclusive) Sets whether the queue is exclusive or not.
void	setFlowResumeCapacity(Long value) Sets the FlowResumeCapacity in bytes below which flow resumes.
void	setMaximumMessageAge(Long age) Sets the maximum age of a message in milliseconds
void	setMaximumMessageCount(Long value) Sets the maximum number of messages allowed to be stored in the queue.
void	setMaximumMessageSize(Long size) Sets the maximum size of the message (in Bytes) that is allowed to be accepted by the Queue.
void	setMaximumQueueDepth(Long value) Sets the maximum size of all the messages together, that can be stored in the queue.
CompositeData	viewMessageContent(long messageId) Returns the content for the given AMQ Message ID.
TabularData	viewMessages(int fromIndex, int toIndex) Deprecated.
TabularData	viewMessages(long startPosition, long endPosition) Returns a subset (up to 2^31 messages at a time) of all the messages stored on the queue.

Methods inherited from class org.apache.qpid.server.jmx.AMQManagedObject

addNotificationListener, getBroadcaster, incrementAndGetSequenceNumber, removeNotificationListener

Methods inherited from class org.apache.qpid.server.jmx.DefaultManagedObject

getHierarchicalName, getHierarchicalType, getManagementInterface, getMBeanInfo, getObjectName, getObjectNameForSingleInstanceMBean, getRegistry, getType, register, toString, unregister

Methods inherited from class javax.management.StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInterface, getParameterName, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

JMSTIMESTAMP_DATETIME_FORMAT

public static final String JMSTIMESTAMP_DATETIME_FORMAT

Date/time format used for message expiration and message timestamp formatting

See Also:

Constant Field Values

Constructor Detail

QueueMBean

public QueueMBean(Queue queue,
                  VirtualHostMBean virtualHostMBean)
           throws JMException

Throws:

JMException

Method Detail

getParentObject

public ManagedObject getParentObject()

Specified by:

getParentObject in interface ManagedObject

Specified by:

getParentObject in class DefaultManagedObject

getObjectInstanceName

public String getObjectInstanceName()

Specified by:

getObjectInstanceName in interface ManagedObject

Returns:

the name that uniquely identifies this object instance. It must be unique only among objects of this type at this level in the hierarchy so the uniqueness should not be too difficult to ensure.

getName

public String getName()

Description copied from interface: ManagedQueue

Returns the Name of the ManagedQueue.

Specified by:

getName in interface ManagedQueue

Returns:

the name of the managedQueue.

getMessageCount

public Integer getMessageCount()

Description copied from interface: ManagedQueue

Total number of messages on the queue, which are yet to be delivered to the consumer(s).

Specified by:

getMessageCount in interface ManagedQueue

Returns:

number of undelivered message in the Queue.

getMaximumDeliveryCount

public Integer getMaximumDeliveryCount()

Description copied from interface: ManagedQueue

Maximum number of times a message is permitted to be delivered or zero if not enforced.

Specified by:

getMaximumDeliveryCount in interface ManagedQueue

Returns:

maximum delivery count

getReceivedMessageCount

public Long getReceivedMessageCount()

Description copied from interface: ManagedQueue

Tells the total number of messages receieved by the queue since startup.

Specified by:

getReceivedMessageCount in interface ManagedQueue

Returns:

total number of messages received.

getQueueDepth

public Long getQueueDepth()

Description copied from interface: ManagedQueue

Size of messages in the queue Since Qpid JMX API 1.2 this operation returns in units of bytes. Prior to this, the result was in units of kilobytes.

Specified by:

getQueueDepth in interface ManagedQueue

Returns:

getActiveConsumerCount

public Integer getActiveConsumerCount()

Description copied from interface: ManagedQueue

Returns the total number of active subscribers to the queue.

Specified by:

getActiveConsumerCount in interface ManagedQueue

Returns:

the number of active subscribers

getConsumerCount

public Integer getConsumerCount()

Description copied from interface: ManagedQueue

Returns the total number of subscribers to the queue.

Specified by:

getConsumerCount in interface ManagedQueue

Returns:

the number of subscribers.

getOwner

public String getOwner()

Description copied from interface: ManagedQueue

Tells the Owner of the ManagedQueue.

Specified by:

getOwner in interface ManagedQueue

Returns:

the owner's name.

getQueueType

public String getQueueType()

Description copied from interface: ManagedQueue

Gets the queue type

Specified by:

getQueueType in interface ManagedQueue

isDurable

public boolean isDurable()

Description copied from interface: ManagedQueue

Tells whether this ManagedQueue is durable or not.

Specified by:

isDurable in interface ManagedQueue

Returns:

true if this ManagedQueue is a durable queue.

isAutoDelete

public boolean isAutoDelete()

Description copied from interface: ManagedQueue

Tells if the ManagedQueue is set to AutoDelete.

Specified by:

isAutoDelete in interface ManagedQueue

Returns:

true if the ManagedQueue is set to AutoDelete.

getMaximumMessageAge

public Long getMaximumMessageAge()

Description copied from interface: ManagedQueue

Returns the maximum age of a message (expiration time) in milliseconds

Specified by:

getMaximumMessageAge in interface ManagedQueue

Returns:

the maximum age

setMaximumMessageAge

public void setMaximumMessageAge(Long age)

Description copied from interface: ManagedQueue

Sets the maximum age of a message in milliseconds

Specified by:

setMaximumMessageAge in interface ManagedQueue

Parameters:

age - maximum age of message.

getMaximumMessageSize

public Long getMaximumMessageSize()

Description copied from interface: ManagedQueue

Returns the maximum size of a message (in Bytes) allowed to be accepted by the ManagedQueue. This is useful in setting notifications or taking appropriate action, if the size of the message received is more than the allowed size.

Specified by:

getMaximumMessageSize in interface ManagedQueue

Returns:

the maximum size of a message allowed to be aceepted by the ManagedQueue.

setMaximumMessageSize

public void setMaximumMessageSize(Long size)

Description copied from interface: ManagedQueue

Sets the maximum size of the message (in Bytes) that is allowed to be accepted by the Queue.

Specified by:

setMaximumMessageSize in interface ManagedQueue

Parameters:

size - maximum size of message.

getMaximumMessageCount

public Long getMaximumMessageCount()

Description copied from interface: ManagedQueue

Tells the maximum number of messages that can be stored in the queue. This is useful in setting the notifications or taking required action is the number of message increase this limit.

Specified by:

getMaximumMessageCount in interface ManagedQueue

Returns:

maximum nuumber of message allowed to be stored in the queue.

setMaximumMessageCount

public void setMaximumMessageCount(Long value)

Description copied from interface: ManagedQueue

Sets the maximum number of messages allowed to be stored in the queue.

Specified by:

setMaximumMessageCount in interface ManagedQueue

Parameters:

value - the maximum number of messages allowed to be stored in the queue.

getMaximumQueueDepth

public Long getMaximumQueueDepth()

Description copied from interface: ManagedQueue

This is useful for setting notifications or taking required action if the size of messages stored in the queue increases over this limit. Since Qpid JMX API 1.2 this operation returns in units of bytes. Prior to this, the result was in units of kilobytes.

Specified by:

getMaximumQueueDepth in interface ManagedQueue

Returns:

threshold high value for Queue Depth

setMaximumQueueDepth

public void setMaximumQueueDepth(Long value)

Description copied from interface: ManagedQueue

Sets the maximum size of all the messages together, that can be stored in the queue.

Specified by:

setMaximumQueueDepth in interface ManagedQueue

getCapacity

public Long getCapacity()

Description copied from interface: ManagedQueue

Returns the current flow control Capacity of the queue in bytes.

Specified by:

getCapacity in interface ManagedQueue

Returns:

Capacity at which flow control is enforced

setCapacity

public void setCapacity(Long value)

Description copied from interface: ManagedQueue

Sets the Capacity in bytes above which flow is blocked.

Specified by:

setCapacity in interface ManagedQueue

Parameters:

value - the capacity in bytes

getFlowResumeCapacity

public Long getFlowResumeCapacity()

Description copied from interface: ManagedQueue

Returns the current flow control FlowResumeCapacity of the queue in bytes.

Specified by:

getFlowResumeCapacity in interface ManagedQueue

Returns:

Capacity below which flow resumes in bytes

setFlowResumeCapacity

public void setFlowResumeCapacity(Long value)

Description copied from interface: ManagedQueue

Sets the FlowResumeCapacity in bytes below which flow resumes.

Specified by:

setFlowResumeCapacity in interface ManagedQueue

Parameters:

value - of the resume capacity in bytes

isFlowOverfull

public boolean isFlowOverfull()

Description copied from interface: ManagedQueue

Indicates whether the Queue is currently considered overfull by the FlowControl system

Specified by:

isFlowOverfull in interface ManagedQueue

isExclusive

public boolean isExclusive()

Description copied from interface: ManagedQueue

Returns whether the queue is exclusive or not.

Specified by:

isExclusive in interface ManagedQueue

Returns:

whether the queue is exclusive.

setExclusive

public void setExclusive(boolean exclusive)

Description copied from interface: ManagedQueue

Sets whether the queue is exclusive or not.

Specified by:

setExclusive in interface ManagedQueue

Parameters:

exclusive - the capacity in bytes

setAlternateExchange

public void setAlternateExchange(String exchangeName)
                          throws OperationsException

Description copied from interface: ManagedQueue

Sets the Alternate Exchange for the queue, for use in dead letter queue functionality.

Specified by:

setAlternateExchange in interface ManagedQueue

Parameters:

exchangeName - the name of the exchange to use. Specifying null or the empty string will clear the alternate exchange.

Throws:

OperationsException

getAlternateExchange

public String getAlternateExchange()

Description copied from interface: ManagedQueue

Returns the name of the Alternate Exchange for the queue, or null if there isn't one.

Specified by:

getAlternateExchange in interface ManagedQueue

Returns:

the name of the Alternate Exchange for the queue, or null if there isn't one

viewMessages

@Deprecated
public TabularData viewMessages(int fromIndex,
                                            int toIndex)
                                     throws IOException,
                                            JMException

Deprecated.

Description copied from interface: ManagedQueue

Returns a subset of all the messages stored in the queue. The messages are returned based on the given index numbers. Deprecated as of Qpid JMX API 1.3

Specified by:

viewMessages in interface ManagedQueue

Returns:

Throws:

IOException

JMException

viewMessages

public TabularData viewMessages(long startPosition,
                                long endPosition)
                         throws IOException,
                                JMException

Description copied from interface: ManagedQueue

Returns a subset (up to 2^31 messages at a time) of all the messages stored on the queue. The messages are returned based on the given queue position range.

Specified by:

viewMessages in interface ManagedQueue

Returns:

Throws:

IOException

JMException

viewMessageContent

public CompositeData viewMessageContent(long messageId)
                                 throws IOException,
                                        JMException

Description copied from interface: ManagedQueue

Returns the content for the given AMQ Message ID.

Specified by:

viewMessageContent in interface ManagedQueue

Throws:

IOException

JMException

deleteMessageFromTop

@Deprecated
public void deleteMessageFromTop()
                                      throws IOException,
                                             JMException

Deprecated.

Description copied from interface: ManagedQueue

Deletes the first message from top. Deprecated as of Qpid JMX API 1.3

Specified by:

deleteMessageFromTop in interface ManagedQueue

Throws:

IOException

JMException

clearQueue

public Long clearQueue()
                throws IOException,
                       JMException

Description copied from interface: ManagedQueue

Clears the queue by deleting all the messages from the queue that have not been acquired by consumers" Since Qpid JMX API 1.3 this returns the number of messages deleted. Prior to this, the return type was void.

Specified by:

clearQueue in interface ManagedQueue

Returns:

the number of messages deleted

Throws:

IOException

JMException

moveMessages

public void moveMessages(long fromMessageId,
                         long toMessageId,
                         String toQueue)
                  throws IOException,
                         JMException

Description copied from interface: ManagedQueue

Moves the messages in given range of message Ids to given Queue. QPID-170

Specified by:

moveMessages in interface ManagedQueue

Parameters:

fromMessageId - first in the range of message ids

toMessageId - last in the range of message ids

toQueue - where the messages are to be moved

Throws:

IOException

JMException

deleteMessages

public void deleteMessages(long fromMessageId,
                           long toMessageId)
                    throws IOException,
                           JMException

Description copied from interface: ManagedQueue

Deletes the messages in given range of AMQ message Ids in the given Queue.

Specified by:

deleteMessages in interface ManagedQueue

Parameters:

fromMessageId - first in the range of message ids

toMessageId - last in the range of message ids

Throws:

IOException

JMException

copyMessages

public void copyMessages(long fromMessageId,
                         long toMessageId,
                         String toQueue)
                  throws IOException,
                         JMException

Description copied from interface: ManagedQueue

Copies the messages in given range of AMQ message Ids to a given Queue.

Specified by:

copyMessages in interface ManagedQueue

Parameters:

fromMessageId - first in the range of message ids

toMessageId - last in the range of message ids

toQueue - where the messages are to be copied

Throws:

IOException

JMException

notifyClients

public void notifyClients(NotificationCheck notification,
                          Queue queue,
                          String notificationMsg)

Specified by:

notifyClients in interface QueueNotificationListener

getNotificationInfo

public MBeanNotificationInfo[] getNotificationInfo()

returns Notifications sent by this MBean.

Specified by:

getNotificationInfo in interface NotificationBroadcaster

Overrides:

getNotificationInfo in class DefaultManagedObject

getDescription

public String getDescription()

Description copied from interface: ManagedQueue

Gets the free text queue description.

Specified by:

getDescription in interface ManagedQueue

setDescription

public void setDescription(String description)

Description copied from interface: ManagedQueue

Sets the free text queue description.

Specified by:

setDescription in interface ManagedQueue

getMessageGroupKey

public String getMessageGroupKey()

Description copied from interface: ManagedQueue

Gets the message group key

Specified by:

getMessageGroupKey in interface ManagedQueue

isMessageGroupSharedGroups

public boolean isMessageGroupSharedGroups()

Description copied from interface: ManagedQueue

Gets the message group key

Specified by:

isMessageGroupSharedGroups in interface ManagedQueue

getOldestMessageAge

public Long getOldestMessageAge()

Description copied from interface: ManagedQueue

Gets the arrival time of the oldest message in the queue

Specified by:

getOldestMessageAge in interface ManagedQueue