org.apache.activemq.broker.jmx

Class QueueView

java.lang.Object

org.apache.activemq.broker.jmx.DestinationView

org.apache.activemq.broker.jmx.QueueView

All Implemented Interfaces:

DestinationViewMBean, QueueViewMBean

public class QueueView
extends DestinationView
implements QueueViewMBean

Provides a JMX Management view of a Queue.

Field Summary

Fields inherited from class org.apache.activemq.broker.jmx.DestinationView

broker, destination

Constructor Summary

Constructors

Constructor and Description
QueueView(ManagedRegionBroker broker, Queue destination)

Method Summary

Methods

Modifier and Type	Method and Description
int	copyMatchingMessagesTo(java.lang.String selector, java.lang.String destinationName) Copies the messages matching the given selector
int	copyMatchingMessagesTo(java.lang.String selector, java.lang.String destinationName, int maximumMessages) Copies the messages matching the given selector up to the maximum number of matched messages
boolean	copyMessageTo(java.lang.String messageId, java.lang.String destinationName) Copies a given message to another destination.
int	cursorSize()
boolean	doesCursorHaveMessagesBuffered()
boolean	doesCursorHaveSpace()
long	getCursorMemoryUsage()
int	getCursorPercentUsage()
javax.management.openmbean.CompositeData	getMessage(java.lang.String messageId) Retrieve a message from the destination's queue.
boolean	isCacheEnabled()
boolean	isCursorFull()
int	moveMatchingMessagesTo(java.lang.String selector, java.lang.String destinationName) Moves the messages matching the given selector
int	moveMatchingMessagesTo(java.lang.String selector, java.lang.String destinationName, int maximumMessages) Moves the messages matching the given selector up to the maximum number of matched messages
boolean	moveMessageTo(java.lang.String messageId, java.lang.String destinationName) Moves the message to another destination.
void	purge() Removes all of the messages in the queue.
int	removeMatchingMessages(java.lang.String selector) Removes the messages matching the given selector
int	removeMatchingMessages(java.lang.String selector, int maximumMessages) Removes the messages matching the given selector up to the maximum number of matched messages
boolean	removeMessage(java.lang.String messageId) Removes a message from the queue.
boolean	retryMessage(java.lang.String messageId) Moves a message back to its original destination

Methods inherited from class org.apache.activemq.broker.jmx.DestinationView

browse, browse, browseAsTable, browseAsTable, browseMessages, browseMessages, gc, getAverageEnqueueTime, getBlockedProducerWarningInterval, getConsumerCount, getDequeueCount, getDispatchCount, getEnqueueCount, getExpiredCount, getInFlightCount, getMaxAuditDepth, getMaxEnqueueTime, getMaxPageSize, getMaxProducersToAudit, getMemoryLimit, getMemoryPercentUsage, getMemoryUsageByteCount, getMemoryUsagePortion, getMessagesCached, getMinEnqueueTime, getName, getOptions, getProducerCount, getQueueSize, getSlowConsumerStrategy, getSubscriptions, isAlwaysRetroactive, isEnableAudit, isPrioritizedMessages, isProducerFlowControl, isUseCache, resetStatistics, sendTextMessage, sendTextMessage, sendTextMessage, sendTextMessage, setAlwaysRetroactive, setBlockedProducerWarningInterval, setEnableAudit, setMaxAuditDepth, setMaxPageSize, setMaxProducersToAudit, setMemoryLimit, setMemoryUsagePortion, setProducerFlowControl, setUseCache

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.broker.jmx.DestinationViewMBean

browse, browse, browseAsTable, browseAsTable, browseMessages, browseMessages, getAverageEnqueueTime, getBlockedProducerWarningInterval, getConsumerCount, getDequeueCount, getDispatchCount, getEnqueueCount, getExpiredCount, getInFlightCount, getMaxAuditDepth, getMaxEnqueueTime, getMaxPageSize, getMaxProducersToAudit, getMemoryLimit, getMemoryPercentUsage, getMemoryUsageByteCount, getMemoryUsagePortion, getMinEnqueueTime, getName, getOptions, getProducerCount, getQueueSize, getSlowConsumerStrategy, getSubscriptions, isAlwaysRetroactive, isPrioritizedMessages, isProducerFlowControl, isUseCache, resetStatistics, sendTextMessage, sendTextMessage, sendTextMessage, sendTextMessage, setAlwaysRetroactive, setBlockedProducerWarningInterval, setMaxAuditDepth, setMaxPageSize, setMaxProducersToAudit, setMemoryLimit, setMemoryUsagePortion, setProducerFlowControl, setUseCache

Constructor Detail

QueueView

public QueueView(ManagedRegionBroker broker,
         Queue destination)

Method Detail

getMessage

public javax.management.openmbean.CompositeData getMessage(java.lang.String messageId)
                                                    throws javax.management.openmbean.OpenDataException

Description copied from interface: QueueViewMBean

Retrieve a message from the destination's queue.

Specified by:

getMessage in interface QueueViewMBean

Parameters:

messageId - the message id of the message to retrieve

Returns:

A CompositeData object which is a JMX version of the messages

Throws:

javax.management.openmbean.OpenDataException

purge

public void purge()
           throws java.lang.Exception

Description copied from interface: QueueViewMBean

Removes all of the messages in the queue.

Specified by:

purge in interface QueueViewMBean

Throws:

java.lang.Exception

removeMessage

public boolean removeMessage(java.lang.String messageId)
                      throws java.lang.Exception

Description copied from interface: QueueViewMBean

Removes a message from the queue. If the message has already been dispatched to another consumer, the message cannot be deleted and this method will return false.

Specified by:

removeMessage in interface QueueViewMBean

Returns:

true if the message was found and could be successfully deleted.

Throws:

java.lang.Exception

removeMatchingMessages

public int removeMatchingMessages(java.lang.String selector)
                           throws java.lang.Exception

Description copied from interface: QueueViewMBean

Removes the messages matching the given selector

Specified by:

removeMatchingMessages in interface QueueViewMBean

Returns:

the number of messages removed

Throws:

java.lang.Exception

removeMatchingMessages

public int removeMatchingMessages(java.lang.String selector,
                         int maximumMessages)
                           throws java.lang.Exception

Description copied from interface: QueueViewMBean

Removes the messages matching the given selector up to the maximum number of matched messages

Specified by:

removeMatchingMessages in interface QueueViewMBean

Returns:

the number of messages removed

Throws:

java.lang.Exception

copyMessageTo

public boolean copyMessageTo(java.lang.String messageId,
                    java.lang.String destinationName)
                      throws java.lang.Exception

Description copied from interface: QueueViewMBean

Copies a given message to another destination.

Specified by:

copyMessageTo in interface QueueViewMBean

Returns:

true if the message was found and was successfully copied to the other destination.

Throws:

java.lang.Exception

copyMatchingMessagesTo

public int copyMatchingMessagesTo(java.lang.String selector,
                         java.lang.String destinationName)
                           throws java.lang.Exception

Description copied from interface: QueueViewMBean

Copies the messages matching the given selector

Specified by:

copyMatchingMessagesTo in interface QueueViewMBean

Returns:

the number of messages copied

Throws:

java.lang.Exception

copyMatchingMessagesTo

public int copyMatchingMessagesTo(java.lang.String selector,
                         java.lang.String destinationName,
                         int maximumMessages)
                           throws java.lang.Exception

Description copied from interface: QueueViewMBean

Copies the messages matching the given selector up to the maximum number of matched messages

Specified by:

copyMatchingMessagesTo in interface QueueViewMBean

Returns:

the number of messages copied

Throws:

java.lang.Exception

moveMessageTo

public boolean moveMessageTo(java.lang.String messageId,
                    java.lang.String destinationName)
                      throws java.lang.Exception

Description copied from interface: QueueViewMBean

Moves the message to another destination.

Specified by:

moveMessageTo in interface QueueViewMBean

Returns:

true if the message was found and was successfully copied to the other destination.

Throws:

java.lang.Exception

moveMatchingMessagesTo

public int moveMatchingMessagesTo(java.lang.String selector,
                         java.lang.String destinationName)
                           throws java.lang.Exception

Description copied from interface: QueueViewMBean

Moves the messages matching the given selector

Specified by:

moveMatchingMessagesTo in interface QueueViewMBean

Returns:

the number of messages removed

Throws:

java.lang.Exception

moveMatchingMessagesTo

public int moveMatchingMessagesTo(java.lang.String selector,
                         java.lang.String destinationName,
                         int maximumMessages)
                           throws java.lang.Exception

Description copied from interface: QueueViewMBean

Moves the messages matching the given selector up to the maximum number of matched messages

Specified by:

moveMatchingMessagesTo in interface QueueViewMBean

Throws:

java.lang.Exception

retryMessage

public boolean retryMessage(java.lang.String messageId)
                     throws java.lang.Exception

Moves a message back to its original destination

Specified by:

retryMessage in interface QueueViewMBean

Throws:

java.lang.Exception

cursorSize

public int cursorSize()

Specified by:

cursorSize in interface QueueViewMBean

Returns:

the number of messages available to be paged in by the cursor

doesCursorHaveMessagesBuffered

public boolean doesCursorHaveMessagesBuffered()

Specified by:

doesCursorHaveMessagesBuffered in interface QueueViewMBean

Returns:

true if the cursor has messages buffered to deliver

doesCursorHaveSpace

public boolean doesCursorHaveSpace()

Specified by:

doesCursorHaveSpace in interface QueueViewMBean

Returns:

true if the message cursor has memory space available to page in more messages

getCursorMemoryUsage

public long getCursorMemoryUsage()

Specified by:

getCursorMemoryUsage in interface QueueViewMBean

Returns:

the cursor memory usage in bytes

getCursorPercentUsage

public int getCursorPercentUsage()

Specified by:

getCursorPercentUsage in interface QueueViewMBean

Returns:

the cursor memory usage as a percentage

isCursorFull

public boolean isCursorFull()

Specified by:

isCursorFull in interface QueueViewMBean

Returns:

true if the cursor has reached its memory limit for paged in messages

isCacheEnabled

public boolean isCacheEnabled()

Specified by:

isCacheEnabled in interface QueueViewMBean

Returns:

true if caching is currently enabled of for the destination