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

Methods

Modifier and Type	Method and Description
Long	clearQueue()
void	copyMessages(long fromMessageId, long toMessageId, String toQueue)
void	deleteMessageFromTop() Deprecated.
void	deleteMessages(long fromMessageId, long toMessageId)
Integer	getActiveConsumerCount()
String	getAlternateExchange()
Long	getCapacity()
Integer	getConsumerCount()
String	getDescription()
Long	getFlowResumeCapacity()
Integer	getMaximumDeliveryCount()
Long	getMaximumMessageAge()
Long	getMaximumMessageCount()
Long	getMaximumMessageSize()
Long	getMaximumQueueDepth()
Integer	getMessageCount()
String	getMessageGroupKey()
String	getName()
MBeanNotificationInfo[]	getNotificationInfo() returns Notifications sent by this MBean.
String	getObjectInstanceName()
Long	getOldestMessageAge()
String	getOwner()
ManagedObject	getParentObject()
Long	getQueueDepth()
String	getQueueType()
Long	getReceivedMessageCount()
boolean	isAutoDelete()
boolean	isDurable()
boolean	isExclusive()
boolean	isFlowOverfull()
boolean	isMessageGroupSharedGroups()
void	moveMessages(long fromMessageId, long toMessageId, String toQueue)
void	notifyClients(NotificationCheck notification, Queue queue, String notificationMsg)
void	setAlternateExchange(String exchangeName)
void	setCapacity(Long value)
void	setDescription(String description)
void	setExclusive(boolean exclusive)
void	setFlowResumeCapacity(Long value)
void	setMaximumMessageAge(Long age)
void	setMaximumMessageCount(Long value)
void	setMaximumMessageSize(Long size)
void	setMaximumQueueDepth(Long value)
CompositeData	viewMessageContent(long messageId)
TabularData	viewMessages(int fromIndex, int toIndex) Deprecated.
TabularData	viewMessages(long startPosition, long endPosition)

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()

Specified by:

getName in interface ManagedQueue

getMessageCount

public Integer getMessageCount()

Specified by:

getMessageCount in interface ManagedQueue

getMaximumDeliveryCount

public Integer getMaximumDeliveryCount()

Specified by:

getMaximumDeliveryCount in interface ManagedQueue

getReceivedMessageCount

public Long getReceivedMessageCount()

Specified by:

getReceivedMessageCount in interface ManagedQueue

getQueueDepth

public Long getQueueDepth()

Specified by:

getQueueDepth in interface ManagedQueue

getActiveConsumerCount

public Integer getActiveConsumerCount()

Specified by:

getActiveConsumerCount in interface ManagedQueue

getConsumerCount

public Integer getConsumerCount()

Specified by:

getConsumerCount in interface ManagedQueue

getOwner

public String getOwner()

Specified by:

getOwner in interface ManagedQueue

getQueueType

public String getQueueType()

Specified by:

getQueueType in interface ManagedQueue

isDurable

public boolean isDurable()

Specified by:

isDurable in interface ManagedQueue

isAutoDelete

public boolean isAutoDelete()

Specified by:

isAutoDelete in interface ManagedQueue

getMaximumMessageAge

public Long getMaximumMessageAge()

Specified by:

getMaximumMessageAge in interface ManagedQueue

setMaximumMessageAge

public void setMaximumMessageAge(Long age)

Specified by:

setMaximumMessageAge in interface ManagedQueue

getMaximumMessageSize

public Long getMaximumMessageSize()

Specified by:

getMaximumMessageSize in interface ManagedQueue

setMaximumMessageSize

public void setMaximumMessageSize(Long size)

Specified by:

setMaximumMessageSize in interface ManagedQueue

getMaximumMessageCount

public Long getMaximumMessageCount()

Specified by:

getMaximumMessageCount in interface ManagedQueue

setMaximumMessageCount

public void setMaximumMessageCount(Long value)

Specified by:

setMaximumMessageCount in interface ManagedQueue

getMaximumQueueDepth

public Long getMaximumQueueDepth()

Specified by:

getMaximumQueueDepth in interface ManagedQueue

setMaximumQueueDepth

public void setMaximumQueueDepth(Long value)

Specified by:

setMaximumQueueDepth in interface ManagedQueue

getCapacity

public Long getCapacity()

Specified by:

getCapacity in interface ManagedQueue

setCapacity

public void setCapacity(Long value)

Specified by:

setCapacity in interface ManagedQueue

getFlowResumeCapacity

public Long getFlowResumeCapacity()

Specified by:

getFlowResumeCapacity in interface ManagedQueue

setFlowResumeCapacity

public void setFlowResumeCapacity(Long value)

Specified by:

setFlowResumeCapacity in interface ManagedQueue

isFlowOverfull

public boolean isFlowOverfull()

Specified by:

isFlowOverfull in interface ManagedQueue

isExclusive

public boolean isExclusive()

Specified by:

isExclusive in interface ManagedQueue

setExclusive

public void setExclusive(boolean exclusive)

Specified by:

setExclusive in interface ManagedQueue

setAlternateExchange

public void setAlternateExchange(String exchangeName)
                          throws OperationsException

Specified by:

setAlternateExchange in interface ManagedQueue

Throws:

OperationsException

getAlternateExchange

public String getAlternateExchange()

Specified by:

getAlternateExchange in interface ManagedQueue

viewMessages

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

Deprecated.

Specified by:

viewMessages in interface ManagedQueue

Throws:

IOException

JMException

viewMessages

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

Specified by:

viewMessages in interface ManagedQueue

Throws:

IOException

JMException

viewMessageContent

public CompositeData viewMessageContent(long messageId)
                                 throws IOException,
                                        JMException

Specified by:

viewMessageContent in interface ManagedQueue

Throws:

IOException

JMException

deleteMessageFromTop

@Deprecated
public void deleteMessageFromTop()
                          throws IOException,
                                 JMException

Deprecated.

Specified by:

deleteMessageFromTop in interface ManagedQueue

Throws:

IOException

JMException

clearQueue

public Long clearQueue()
                throws IOException,
                       JMException

Specified by:

clearQueue in interface ManagedQueue

Throws:

IOException

JMException

moveMessages

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

Specified by:

moveMessages in interface ManagedQueue

Throws:

IOException

JMException

deleteMessages

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

Specified by:

deleteMessages in interface ManagedQueue

Throws:

IOException

JMException

copyMessages

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

Specified by:

copyMessages in interface ManagedQueue

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()

Specified by:

getDescription in interface ManagedQueue

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface ManagedQueue

getMessageGroupKey

public String getMessageGroupKey()

Specified by:

getMessageGroupKey in interface ManagedQueue

isMessageGroupSharedGroups

public boolean isMessageGroupSharedGroups()

Specified by:

isMessageGroupSharedGroups in interface ManagedQueue

getOldestMessageAge

public Long getOldestMessageAge()

Specified by:

getOldestMessageAge in interface ManagedQueue