org.apache.activemq.broker.jmx

Interface QueueViewMBean

All Superinterfaces:

DestinationViewMBean

All Known Implementing Classes:

QueueView

public interface QueueViewMBean
extends DestinationViewMBean

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.
java.util.Map<java.lang.String,java.lang.String>	getMessageGroups()
java.lang.String	getMessageGroupType()
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.
void	removeAllMessageGroups() remove all the message groups - will rebalance all message groups across consumers
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.
void	removeMessageGroup(java.lang.String groupName) remove a message group = has the effect of rebalancing group
boolean	retryMessage(java.lang.String messageId) Moves a message back to its original destination
int	retryMessages() Retries messages sent to the DLQ

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

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

Method Detail

getMessage

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

Retrieve a message from the destination's queue.

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

removeMessage

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

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.

Parameters:

messageId -

Returns:

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

Throws:

java.lang.Exception

removeMatchingMessages

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

Removes the messages matching the given selector

Returns:

the number of messages removed

Throws:

java.lang.Exception

removeMatchingMessages

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

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

Returns:

the number of messages removed

Throws:

java.lang.Exception

purge

void purge()
           throws java.lang.Exception

Removes all of the messages in the queue.

Throws:

java.lang.Exception

copyMessageTo

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

Copies a given message to another destination.

Parameters:

messageId -

destinationName -

Returns:

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

Throws:

java.lang.Exception

copyMatchingMessagesTo

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

Copies the messages matching the given selector

Returns:

the number of messages copied

Throws:

java.lang.Exception

copyMatchingMessagesTo

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

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

Returns:

the number of messages copied

Throws:

java.lang.Exception

moveMessageTo

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

Moves the message to another destination.

Parameters:

messageId -

destinationName -

Returns:

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

Throws:

java.lang.Exception

retryMessage

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

Moves a message back to its original destination

Throws:

java.lang.Exception

moveMatchingMessagesTo

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

Moves the messages matching the given selector

Returns:

the number of messages removed

Throws:

java.lang.Exception

moveMatchingMessagesTo

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

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

Throws:

java.lang.Exception

retryMessages

int retryMessages()
                  throws java.lang.Exception

Retries messages sent to the DLQ

Throws:

java.lang.Exception

doesCursorHaveSpace

boolean doesCursorHaveSpace()

Returns:

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

isCursorFull

boolean isCursorFull()

Returns:

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

doesCursorHaveMessagesBuffered

boolean doesCursorHaveMessagesBuffered()

Returns:

true if the cursor has messages buffered to deliver

getCursorMemoryUsage

long getCursorMemoryUsage()

Returns:

the cursor memory usage in bytes

getCursorPercentUsage

int getCursorPercentUsage()

Returns:

the cursor memory usage as a percentage

cursorSize

int cursorSize()

Returns:

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

isCacheEnabled

boolean isCacheEnabled()

Returns:

true if caching is currently enabled of for the destination

getMessageGroups

java.util.Map<java.lang.String,java.lang.String> getMessageGroups()

Returns:

a Map of groupNames and ConsumerIds

getMessageGroupType

java.lang.String getMessageGroupType()

Returns:

the message group type implementation (simple,bucket,cached)

removeMessageGroup

void removeMessageGroup(java.lang.String groupName)

remove a message group = has the effect of rebalancing group

Parameters:

groupName -

removeAllMessageGroups

void removeAllMessageGroups()

remove all the message groups - will rebalance all message groups across consumers