Package org.apache.activemq.artemis.core.management.impl

Class QueueControlImpl

java.lang.Object

javax.management.StandardMBean

org.apache.activemq.artemis.core.management.impl.AbstractControl

org.apache.activemq.artemis.core.management.impl.QueueControlImpl

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, QueueControl

public class QueueControlImpl
extends AbstractControl
implements QueueControl

Field Summary

Fields

Modifier and Type	Field	Description
static int	FLUSH_LIMIT

Fields inherited from interface org.apache.activemq.artemis.api.core.management.QueueControl

CONSUMER_COUNT_DESCRIPTION, DELIVERING_MESSAGE_COUNT_DESCRIPTION, DELIVERING_SIZE_DESCRIPTION, DURABLE_DELIVERING_MESSAGE_COUNT_DESCRIPTION, DURABLE_DELIVERING_SIZE_DESCRIPTION, DURABLE_MESSAGE_COUNT_DESCRIPTION, DURABLE_PERSISTENT_SIZE_DESCRIPTION, DURABLE_SCHEDULED_MESSAGE_COUNT_DESCRIPTION, DURABLE_SCHEDULED_SIZE_DESCRIPTION, MESSAGE_COUNT_DESCRIPTION, MESSAGES_ACKNOWLEDGED_DESCRIPTION, MESSAGES_ADDED_DESCRIPTION, MESSAGES_EXPIRED_DESCRIPTION, MESSAGES_KILLED_DESCRIPTION, PERSISTENT_SIZE_DESCRIPTION, SCHEDULED_MESSAGE_COUNT_DESCRIPTION, SCHEDULED_SIZE_DESCRIPTION

Constructor Summary

Constructors

Constructor	Description
QueueControlImpl(Queue queue, String address, ActiveMQServer server, StorageManager storageManager, SecurityStore securityStore, HierarchicalRepository<AddressSettings> addressSettingsRepository)

Method Summary

Modifier and Type	Method	Description
CompositeData[]	browse()
CompositeData[]	browse(int page, int pageSize)
CompositeData[]	browse(int page, int pageSize, String filter)
CompositeData[]	browse(String filter)
boolean	changeMessagePriority(long messageID, int newPriority)	Changes the message's priority corresponding to the specified message ID to the specified priority.
int	changeMessagesPriority(String filterStr, int newPriority)	Changes the priority for all the message corresponding to the specified filter to the specified priority.
long	countDeliveringMessages(String filterStr)	Counts the number of delivering messages in this queue matching the specified filter.
String	countDeliveringMessages(String filterStr, String groupByProperty)	Counts the number of delivering messages in this queue matching the specified filter, grouped by the given property field.
long	countMessages()
long	countMessages(String filterStr)	Counts the number of messages in this queue matching the specified filter.
String	countMessages(String filterStr, String groupByProperty)	Counts the number of messages in this queue matching the specified filter, grouped by the given property field.
void	disable()	Enables the queue.
void	enable()	Enables the queue.
boolean	expireMessage(long messageID)	Expires the message corresponding to the specified message ID.
int	expireMessages(String filterStr)	Expires all the message corresponding to the specified filter.
protected MBeanAttributeInfo[]	fillMBeanAttributeInfo()
protected MBeanOperationInfo[]	fillMBeanOperationInfo()
void	flushExecutor()	it will flush one cycle on internal executors, so you would be sure that any pending tasks are done before you call any other measure.
long	getAcknowledgeAttempts()	Returns the number of messages added to this queue since it was created.
String	getAddress()	Returns the address this queue is bound to.
int	getConsumerCount()	Returns the number of consumers consuming messages from this queue.
int	getConsumersBeforeDispatch()	Return the Consumers Before Dispatch
String	getDeadLetterAddress()	Returns the dead-letter address associated with this queue.
long	getDelayBeforeDispatch()	Return the Consumers Before Dispatch
int	getDeliveringCount()	Returns the number of messages that this queue is currently delivering to its consumers.
long	getDeliveringSize()	Returns the persistent size of messages that this queue is currently delivering to its consumers.
int	getDurableDeliveringCount()	Returns the number of durable messages that this queue is currently delivering to its consumers.
long	getDurableDeliveringSize()	Returns the size of durable messages that this queue is currently delivering to its consumers.
long	getDurableMessageCount()	Returns the number of durable messages currently in this queue.
long	getDurablePersistentSize()	Returns the persistent size of durable messages currently in this queue.
long	getDurableScheduledCount()	Returns the number of durable scheduled messages in this queue.
long	getDurableScheduledSize()	Returns the size of durable scheduled messages in this queue.
String	getExpiryAddress()	Returns the expiry address associated with this queue.
String	getFilter()	Returns the filter associated with this queue.
protected Map<String,Object>	getFirstMessage()	this method returns a Map representing the first message.
Long	getFirstMessageAge()	Returns the age of the first message in milliseconds.
String	getFirstMessageAsJSON()	Returns the first message on the queue as JSON
Long	getFirstMessageTimestamp()	Returns the timestamp of the first message in milliseconds.
int	getGroupBuckets()	Will return the group buckets.
int	getGroupCount()	Will return the current number of active groups.
String	getGroupFirstKey()	Will return the header key to notify a consumer of a group change.
long	getID()	Returns this queue ID.
String	getLastValueKey()	The key used for the last value queues
int	getMaxConsumers()
long	getMessageCount()	Returns the number of messages currently in this queue.
long	getMessagesAcknowledged()	Returns the number of messages added to this queue since it was created.
long	getMessagesAdded()	Returns the number of messages added to this queue since it was created.
long	getMessagesExpired()	Returns the number of messages expired from this queue since it was created.
long	getMessagesKilled()	Returns the number of messages removed from this queue since it was created due to exceeding the max delivery attempts.
String	getName()	Returns the name of this queue.
long	getPersistentSize()	Returns the persistent size of all messages currently in this queue.
int	getPreparedTransactionMessageCount()	Will return the number of messages stuck in prepared transactions
long	getRingSize()	Will return the ring size.
String	getRoutingType()	The routing type of this queue.
long	getScheduledCount()	Returns the number of scheduled messages in this queue.
long	getScheduledSize()	Returns the size of scheduled messages in this queue.
String	getUser()	Returns the user that is associated with creating the queue.
boolean	isConfigurationManaged()
boolean	isDurable()	Returns whether this queue is durable.
boolean	isEnabled()
boolean	isExclusive()
boolean	isGroupRebalance()	Returns whether the groups of this queue are automatically rebalanced.
boolean	isGroupRebalancePauseDispatch()	Returns whether the dispatch is paused when groups of this queue are automatically rebalanced.
boolean	isLastValue()
boolean	isPaused()	Returns whether the queue is paused.
boolean	isPurgeOnNoConsumers()
boolean	isRetroactiveResource()	Returns whether this queue is used for a retroactive address.
boolean	isTemporary()	Returns whether this queue is temporary.
String	listConsumersAsJSON()
Map<String,Map<String,Object>[]>	listDeliveringMessages()	Lists all the messages being deliver per consumer.
String	listDeliveringMessagesAsJSON()	Executes a conversion of QueueControl.listDeliveringMessages() to JSON
String	listGroupsAsJSON()
String	listMessageCounter()	Lists the message counter for this queue.
String	listMessageCounterAsHTML()	Deprecated.
String	listMessageCounterHistory()	Lists the message counter history for this queue.
String	listMessageCounterHistoryAsHTML()	Deprecated.
Map<String,Object>[]	listMessages(String filterStr)	Lists all the messages in this queue matching the specified filter.
String	listMessagesAsJSON(String filter)	Lists all the messages in this queue matching the specified filter using JSON serialization.
Map<String,Object>[]	listScheduledMessages()	Lists all the messages scheduled for delivery for this queue.
String	listScheduledMessagesAsJSON()	Lists all the messages scheduled for delivery for this queue using JSON serialization.
boolean	moveMessage(long messageID, String otherQueueName)	Moves the message corresponding to the specified message ID to the specified other queue.
boolean	moveMessage(long messageID, String otherQueueName, boolean rejectDuplicates)	Moves the message corresponding to the specified message ID to the specified other queue.
int	moveMessages(int flushLimit, String filterStr, String otherQueueName, boolean rejectDuplicates)
int	moveMessages(int flushLimit, String filterStr, String otherQueueName, boolean rejectDuplicates, int messageCount)
int	moveMessages(String filterStr, String otherQueueName)	Moves all the message corresponding to the specified filter to the specified other queue.
int	moveMessages(String filterStr, String otherQueueName, boolean rejectDuplicates)	Moves all the message corresponding to the specified filter to the specified other queue.
void	pause()	Pauses the queue.
void	pause(boolean persist)	Pauses the queue.
int	removeAllMessages()	Removes all the message from the queue.
boolean	removeMessage(long messageID)	Removes the message corresponding to the specified message ID.
int	removeMessages(int flushLimit, String filterStr)	Removes all the message corresponding to the specified filter.
int	removeMessages(String filterStr)	Removes all the message corresponding to the specified filter.
void	resetAllGroups()	Will reset the all the groups.
void	resetGroup(String groupID)	Will reset the group matching the given groupID.
void	resetMessageCounter()	Resets the message counter for this queue.
void	resetMessagesAcknowledged()	Resets the MessagesAdded property
void	resetMessagesAdded()	Resets the MessagesAdded property
void	resetMessagesExpired()	Resets the MessagesExpired property
void	resetMessagesKilled()	Resets the MessagesExpired property
void	resume()	Resumes the queue.
boolean	retryMessage(long messageID)	Retries the message corresponding to the given messageID to the original queue.
int	retryMessages()	Retries all messages on a DLQ to their respective original queues.
String	sendMessage(Map<String,String> headers, int type, String body, boolean durable, String user, String password)
String	sendMessage(Map<String,String> headers, int type, String body, boolean durable, String user, String password, boolean createMessageId)
int	sendMessagesToDeadLetterAddress(String filterStr)	Sends all the message corresponding to the specified filter to this queue's dead letter address.
boolean	sendMessageToDeadLetterAddress(long messageID)	Sends the message corresponding to the specified message ID to this queue's dead letter address.
void	setMessageCounter(MessageCounter counter)

Methods inherited from class org.apache.activemq.artemis.core.management.impl.AbstractControl

blockOnIO, clearIO, getMBeanInfo, sendMessage, tcclCall, tcclInvoke

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, toString, wait, wait, wait

Field Detail

FLUSH_LIMIT

public static final int FLUSH_LIMIT

See Also:

Constant Field Values

Constructor Detail

QueueControlImpl

public QueueControlImpl(Queue queue,
                        String address,
                        ActiveMQServer server,
                        StorageManager storageManager,
                        SecurityStore securityStore,
                        HierarchicalRepository<AddressSettings> addressSettingsRepository)
                 throws Exception

Throws:

Exception

Method Detail

setMessageCounter

public void setMessageCounter(MessageCounter counter)

getName

public String getName()

Description copied from interface: QueueControl

Returns the name of this queue.

Specified by:

getName in interface QueueControl

getAddress

public String getAddress()

Description copied from interface: QueueControl

Returns the address this queue is bound to.

Specified by:

getAddress in interface QueueControl

getFilter

public String getFilter()

Description copied from interface: QueueControl

Returns the filter associated with this queue.

Specified by:

getFilter in interface QueueControl

isDurable

public boolean isDurable()

Description copied from interface: QueueControl

Returns whether this queue is durable.

Specified by:

isDurable in interface QueueControl

getUser

public String getUser()

Description copied from interface: QueueControl

Returns the user that is associated with creating the queue.

Specified by:

getUser in interface QueueControl

getRoutingType

public String getRoutingType()

Description copied from interface: QueueControl

The routing type of this queue.

Specified by:

getRoutingType in interface QueueControl

isTemporary

public boolean isTemporary()

Description copied from interface: QueueControl

Returns whether this queue is temporary.

Specified by:

isTemporary in interface QueueControl

isRetroactiveResource

public boolean isRetroactiveResource()

Description copied from interface: QueueControl

Returns whether this queue is used for a retroactive address.

Specified by:

isRetroactiveResource in interface QueueControl

getMessageCount

public long getMessageCount()

Description copied from interface: QueueControl

Returns the number of messages currently in this queue.

Specified by:

getMessageCount in interface QueueControl

getPersistentSize

public long getPersistentSize()

Description copied from interface: QueueControl

Returns the persistent size of all messages currently in this queue. The persistent size of a message is the amount of space the message would take up on disk which is used to track how much data there is to consume on this queue

Specified by:

getPersistentSize in interface QueueControl

getDurableMessageCount

public long getDurableMessageCount()

Description copied from interface: QueueControl

Returns the number of durable messages currently in this queue.

Specified by:

getDurableMessageCount in interface QueueControl

getDurablePersistentSize

public long getDurablePersistentSize()

Description copied from interface: QueueControl

Returns the persistent size of durable messages currently in this queue. The persistent size of a message is the amount of space the message would take up on disk which is used to track how much data there is to consume on this queue

Specified by:

getDurablePersistentSize in interface QueueControl

getConsumerCount

public int getConsumerCount()

Description copied from interface: QueueControl

Returns the number of consumers consuming messages from this queue.

Specified by:

getConsumerCount in interface QueueControl

getDeliveringCount

public int getDeliveringCount()

Description copied from interface: QueueControl

Returns the number of messages that this queue is currently delivering to its consumers.

Specified by:

getDeliveringCount in interface QueueControl

getDeliveringSize

public long getDeliveringSize()

Description copied from interface: QueueControl

Returns the persistent size of messages that this queue is currently delivering to its consumers.

Specified by:

getDeliveringSize in interface QueueControl

getDurableDeliveringCount

public int getDurableDeliveringCount()

Description copied from interface: QueueControl

Returns the number of durable messages that this queue is currently delivering to its consumers.

Specified by:

getDurableDeliveringCount in interface QueueControl

getDurableDeliveringSize

public long getDurableDeliveringSize()

Description copied from interface: QueueControl

Returns the size of durable messages that this queue is currently delivering to its consumers.

Specified by:

getDurableDeliveringSize in interface QueueControl

getMessagesAdded

public long getMessagesAdded()

Description copied from interface: QueueControl

Returns the number of messages added to this queue since it was created.

Specified by:

getMessagesAdded in interface QueueControl

getMessagesAcknowledged

public long getMessagesAcknowledged()

Description copied from interface: QueueControl

Returns the number of messages added to this queue since it was created.

Specified by:

getMessagesAcknowledged in interface QueueControl

getAcknowledgeAttempts

public long getAcknowledgeAttempts()

Description copied from interface: QueueControl

Returns the number of messages added to this queue since it was created.

Specified by:

getAcknowledgeAttempts in interface QueueControl

getMessagesExpired

public long getMessagesExpired()

Description copied from interface: QueueControl

Returns the number of messages expired from this queue since it was created.

Specified by:

getMessagesExpired in interface QueueControl

getMessagesKilled

public long getMessagesKilled()

Description copied from interface: QueueControl

Returns the number of messages removed from this queue since it was created due to exceeding the max delivery attempts.

Specified by:

getMessagesKilled in interface QueueControl

getID

public long getID()

Description copied from interface: QueueControl

Returns this queue ID.

Specified by:

getID in interface QueueControl

getScheduledCount

public long getScheduledCount()

Description copied from interface: QueueControl

Returns the number of scheduled messages in this queue.

Specified by:

getScheduledCount in interface QueueControl

getScheduledSize

public long getScheduledSize()

Description copied from interface: QueueControl

Returns the size of scheduled messages in this queue.

Specified by:

getScheduledSize in interface QueueControl

getDurableScheduledCount

public long getDurableScheduledCount()

Description copied from interface: QueueControl

Returns the number of durable scheduled messages in this queue.

Specified by:

getDurableScheduledCount in interface QueueControl

getDurableScheduledSize

public long getDurableScheduledSize()

Description copied from interface: QueueControl

Returns the size of durable scheduled messages in this queue.

Specified by:

getDurableScheduledSize in interface QueueControl

getDeadLetterAddress

public String getDeadLetterAddress()

Description copied from interface: QueueControl

Returns the dead-letter address associated with this queue.

Specified by:

getDeadLetterAddress in interface QueueControl

getExpiryAddress

public String getExpiryAddress()

Description copied from interface: QueueControl

Returns the expiry address associated with this queue.

Specified by:

getExpiryAddress in interface QueueControl

getMaxConsumers

public int getMaxConsumers()

Specified by:

getMaxConsumers in interface QueueControl

isPurgeOnNoConsumers

public boolean isPurgeOnNoConsumers()

Specified by:

isPurgeOnNoConsumers in interface QueueControl

disable

public void disable()
             throws Exception

Description copied from interface: QueueControl

Enables the queue. Messages are not routed to this queue.

Specified by:

disable in interface QueueControl

Throws:

Exception

enable

public void enable()
            throws Exception

Description copied from interface: QueueControl

Enables the queue. Messages are now routed to this queue.

Specified by:

enable in interface QueueControl

Throws:

Exception

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface QueueControl

isConfigurationManaged

public boolean isConfigurationManaged()

Specified by:

isConfigurationManaged in interface QueueControl

isExclusive

public boolean isExclusive()

Specified by:

isExclusive in interface QueueControl

isLastValue

public boolean isLastValue()

Specified by:

isLastValue in interface QueueControl

getLastValueKey

public String getLastValueKey()

Description copied from interface: QueueControl

The key used for the last value queues

Specified by:

getLastValueKey in interface QueueControl

getConsumersBeforeDispatch

public int getConsumersBeforeDispatch()

Description copied from interface: QueueControl

Return the Consumers Before Dispatch

Specified by:

getConsumersBeforeDispatch in interface QueueControl

Returns:

getDelayBeforeDispatch

public long getDelayBeforeDispatch()

Description copied from interface: QueueControl

Return the Consumers Before Dispatch

Specified by:

getDelayBeforeDispatch in interface QueueControl

Returns:

listScheduledMessages

public Map<String,Object>[] listScheduledMessages()
                                                 throws Exception

Description copied from interface: QueueControl

Lists all the messages scheduled for delivery for this queue.
1 Map represents 1 message, keys are the message's properties and headers, values are the corresponding values.

Specified by:

listScheduledMessages in interface QueueControl

Throws:

Exception

listScheduledMessagesAsJSON

public String listScheduledMessagesAsJSON()
                                   throws Exception

Description copied from interface: QueueControl

Lists all the messages scheduled for delivery for this queue using JSON serialization.

Specified by:

listScheduledMessagesAsJSON in interface QueueControl

Throws:

Exception

listDeliveringMessages

public Map<String,Map<String,Object>[]> listDeliveringMessages()
                                                                    throws ActiveMQException

Description copied from interface: QueueControl

Lists all the messages being deliver per consumer.
The Map's key is a toString representation for the consumer. Each consumer will then return a Map<String,Object>[] same way is returned by QueueControl.listScheduledMessages()

Specified by:

listDeliveringMessages in interface QueueControl

Throws:

ActiveMQException

listDeliveringMessagesAsJSON

public String listDeliveringMessagesAsJSON()
                                    throws Exception

Description copied from interface: QueueControl

Executes a conversion of QueueControl.listDeliveringMessages() to JSON

Specified by:

listDeliveringMessagesAsJSON in interface QueueControl

Returns:

Throws:

Exception

listMessages

public Map<String,Object>[] listMessages(String filterStr)
                                        throws Exception

Description copied from interface: QueueControl

Lists all the messages in this queue matching the specified filter.
1 Map represents 1 message, keys are the message's properties and headers, values are the corresponding values.
Using null or an empty filter will list all messages from this queue.

Specified by:

listMessages in interface QueueControl

Throws:

Exception

listMessagesAsJSON

public String listMessagesAsJSON(String filter)
                          throws Exception

Description copied from interface: QueueControl

Lists all the messages in this queue matching the specified filter using JSON serialization.
Using null or an empty filter will list all messages from this queue.

Specified by:

listMessagesAsJSON in interface QueueControl

Throws:

Exception

getFirstMessage

protected Map<String,Object> getFirstMessage()
                                            throws Exception

this method returns a Map representing the first message. or null if there's no first message.

Returns:

Throws:

Exception

getFirstMessageAsJSON

public String getFirstMessageAsJSON()
                             throws Exception

Description copied from interface: QueueControl

Returns the first message on the queue as JSON

Specified by:

getFirstMessageAsJSON in interface QueueControl

Throws:

Exception

getFirstMessageTimestamp

public Long getFirstMessageTimestamp()
                              throws Exception

Description copied from interface: QueueControl

Returns the timestamp of the first message in milliseconds.

Specified by:

getFirstMessageTimestamp in interface QueueControl

Throws:

Exception

getFirstMessageAge

public Long getFirstMessageAge()
                        throws Exception

Description copied from interface: QueueControl

Returns the age of the first message in milliseconds.

Specified by:

getFirstMessageAge in interface QueueControl

Throws:

Exception

countMessages

public long countMessages()
                   throws Exception

Specified by:

countMessages in interface QueueControl

Throws:

Exception

countMessages

public long countMessages(String filterStr)
                   throws Exception

Description copied from interface: QueueControl

Counts the number of messages in this queue matching the specified filter.
Using null or an empty filter will count all messages from this queue.

Specified by:

countMessages in interface QueueControl

Throws:

Exception

countMessages

public String countMessages(String filterStr,
                            String groupByProperty)
                     throws Exception

Description copied from interface: QueueControl

Counts the number of messages in this queue matching the specified filter, grouped by the given property field. In case of null property will be grouped in "null"
Using null or an empty filter will count all messages from this queue.

Specified by:

countMessages in interface QueueControl

Throws:

Exception

countDeliveringMessages

public long countDeliveringMessages(String filterStr)
                             throws Exception

Description copied from interface: QueueControl

Counts the number of delivering messages in this queue matching the specified filter.
Using null or an empty filter will count all messages from this queue.

Specified by:

countDeliveringMessages in interface QueueControl

Throws:

Exception

countDeliveringMessages

public String countDeliveringMessages(String filterStr,
                                      String groupByProperty)
                               throws Exception

Description copied from interface: QueueControl

Counts the number of delivering messages in this queue matching the specified filter, grouped by the given property field. In case of null property will be grouped in "null"
Using null or an empty filter will count all messages from this queue.

Specified by:

countDeliveringMessages in interface QueueControl

Throws:

Exception

removeMessage

public boolean removeMessage(long messageID)
                      throws Exception

Description copied from interface: QueueControl

Removes the message corresponding to the specified message ID.

Specified by:

removeMessage in interface QueueControl

Returns:

true if the message was removed, false else

Throws:

Exception

removeMessages

public int removeMessages(String filterStr)
                   throws Exception

Description copied from interface: QueueControl

Removes all the message corresponding to the specified filter.
Using null or an empty filter will remove all messages from this queue.

Specified by:

removeMessages in interface QueueControl

Returns:

the number of removed messages

Throws:

Exception

removeMessages

public int removeMessages(int flushLimit,
                          String filterStr)
                   throws Exception

Description copied from interface: QueueControl

Removes all the message corresponding to the specified filter.
Using null or an empty filter will remove all messages from this queue.

Specified by:

removeMessages in interface QueueControl

Returns:

the number of removed messages

Throws:

Exception

removeAllMessages

public int removeAllMessages()
                      throws Exception

Description copied from interface: QueueControl

Removes all the message from the queue.

Specified by:

removeAllMessages in interface QueueControl

Returns:

the number of removed messages

Throws:

Exception

expireMessage

public boolean expireMessage(long messageID)
                      throws Exception

Description copied from interface: QueueControl

Expires the message corresponding to the specified message ID.

Specified by:

expireMessage in interface QueueControl

Returns:

true if the message was expired, false else

Throws:

Exception

expireMessages

public int expireMessages(String filterStr)
                   throws Exception

Description copied from interface: QueueControl

Expires all the message corresponding to the specified filter.
Using null or an empty filter will expire all messages from this queue.

Specified by:

expireMessages in interface QueueControl

Returns:

the number of expired messages

Throws:

Exception

retryMessage

public boolean retryMessage(long messageID)
                     throws Exception

Description copied from interface: QueueControl

Retries the message corresponding to the given messageID to the original queue. This is appropriate on dead messages on Dead letter queues only.

Specified by:

retryMessage in interface QueueControl

Returns:

true if the message was retried, false else

Throws:

Exception

retryMessages

public int retryMessages()
                  throws Exception

Description copied from interface: QueueControl

Retries all messages on a DLQ to their respective original queues. This is appropriate on dead messages on Dead letter queues only.

Specified by:

retryMessages in interface QueueControl

Returns:

the number of retried messages.

Throws:

Exception

moveMessage

public boolean moveMessage(long messageID,
                           String otherQueueName)
                    throws Exception

Description copied from interface: QueueControl

Moves the message corresponding to the specified message ID to the specified other queue.

Specified by:

moveMessage in interface QueueControl

Returns:

true if the message was moved, false else

Throws:

Exception

moveMessage

public boolean moveMessage(long messageID,
                           String otherQueueName,
                           boolean rejectDuplicates)
                    throws Exception

Description copied from interface: QueueControl

Moves the message corresponding to the specified message ID to the specified other queue.

Specified by:

moveMessage in interface QueueControl

Returns:

true if the message was moved, false else

Throws:

Exception

moveMessages

public int moveMessages(String filterStr,
                        String otherQueueName)
                 throws Exception

Description copied from interface: QueueControl

Moves all the message corresponding to the specified filter to the specified other queue. RejectDuplicates = false on this case
Using null or an empty filter will move all messages from this queue.

Specified by:

moveMessages in interface QueueControl

Returns:

the number of moved messages

Throws:

Exception

moveMessages

public int moveMessages(int flushLimit,
                        String filterStr,
                        String otherQueueName,
                        boolean rejectDuplicates)
                 throws Exception

Specified by:

moveMessages in interface QueueControl

Throws:

Exception

moveMessages

public int moveMessages(int flushLimit,
                        String filterStr,
                        String otherQueueName,
                        boolean rejectDuplicates,
                        int messageCount)
                 throws Exception

Specified by:

moveMessages in interface QueueControl

Throws:

Exception

moveMessages

public int moveMessages(String filterStr,
                        String otherQueueName,
                        boolean rejectDuplicates)
                 throws Exception

Description copied from interface: QueueControl

Moves all the message corresponding to the specified filter to the specified other queue.
Using null or an empty filter will move all messages from this queue.

Specified by:

moveMessages in interface QueueControl

Returns:

the number of moved messages

Throws:

Exception

sendMessagesToDeadLetterAddress

public int sendMessagesToDeadLetterAddress(String filterStr)
                                    throws Exception

Description copied from interface: QueueControl

Sends all the message corresponding to the specified filter to this queue's dead letter address.
Using null or an empty filter will send all messages from this queue.

Specified by:

sendMessagesToDeadLetterAddress in interface QueueControl

Returns:

the number of sent messages

Throws:

Exception

sendMessage

public String sendMessage(Map<String,String> headers,
                          int type,
                          String body,
                          boolean durable,
                          String user,
                          String password)
                   throws Exception

Specified by:

sendMessage in interface QueueControl

Parameters:

headers - the message headers and properties to set. Can only container Strings maped to primitive types.

body - the text to send

Returns:

Throws:

Exception

sendMessage

public String sendMessage(Map<String,String> headers,
                          int type,
                          String body,
                          boolean durable,
                          String user,
                          String password,
                          boolean createMessageId)
                   throws Exception

Specified by:

sendMessage in interface QueueControl

Parameters:

headers - the message headers and properties to set. Can only container Strings maped to primitive types.

body - the text to send

createMessageId - whether or not to auto generate a Message ID

Returns:

Throws:

Exception

sendMessageToDeadLetterAddress

public boolean sendMessageToDeadLetterAddress(long messageID)
                                       throws Exception

Description copied from interface: QueueControl

Sends the message corresponding to the specified message ID to this queue's dead letter address.

Specified by:

sendMessageToDeadLetterAddress in interface QueueControl

Returns:

true if the message was sent to the dead letter address, false else

Throws:

Exception

changeMessagesPriority

public int changeMessagesPriority(String filterStr,
                                  int newPriority)
                           throws Exception

Description copied from interface: QueueControl

Changes the priority for all the message corresponding to the specified filter to the specified priority.
Using null or an empty filter will change all messages from this queue.

Specified by:

changeMessagesPriority in interface QueueControl

Returns:

the number of changed messages

Throws:

Exception

changeMessagePriority

public boolean changeMessagePriority(long messageID,
                                     int newPriority)
                              throws Exception

Description copied from interface: QueueControl

Changes the message's priority corresponding to the specified message ID to the specified priority.

Specified by:

changeMessagePriority in interface QueueControl

newPriority - between 0 and 9 inclusive.

Returns:

true if the message priority was changed

Throws:

Exception

listMessageCounter

public String listMessageCounter()

Description copied from interface: QueueControl

Lists the message counter for this queue.

Specified by:

listMessageCounter in interface QueueControl

resetMessageCounter

public void resetMessageCounter()

Description copied from interface: QueueControl

Resets the message counter for this queue.

Specified by:

resetMessageCounter in interface QueueControl

listMessageCounterAsHTML

@Deprecated
public String listMessageCounterAsHTML()

Deprecated.

Description copied from interface: QueueControl

Lists the message counter for this queue as a HTML table.

Specified by:

listMessageCounterAsHTML in interface QueueControl

listMessageCounterHistory

public String listMessageCounterHistory()
                                 throws Exception

Description copied from interface: QueueControl

Lists the message counter history for this queue.

Specified by:

listMessageCounterHistory in interface QueueControl

Throws:

Exception

listMessageCounterHistoryAsHTML

@Deprecated
public String listMessageCounterHistoryAsHTML()

Deprecated.

Description copied from interface: QueueControl

Lists the message counter history for this queue as a HTML table.

Specified by:

listMessageCounterHistoryAsHTML in interface QueueControl

pause

public void pause()

Description copied from interface: QueueControl

Pauses the queue. Messages are no longer delivered to its consumers.

Specified by:

pause in interface QueueControl

pause

public void pause(boolean persist)

Description copied from interface: QueueControl

Pauses the queue. Messages are no longer delivered to its consumers.

Specified by:

pause in interface QueueControl

resume

public void resume()

Description copied from interface: QueueControl

Resumes the queue. Messages are again delivered to its consumers.

Specified by:

resume in interface QueueControl

isPaused

public boolean isPaused()
                 throws Exception

Description copied from interface: QueueControl

Returns whether the queue is paused.

Specified by:

isPaused in interface QueueControl

Throws:

Exception

browse

public CompositeData[] browse(int page,
                              int pageSize)
                       throws Exception

Specified by:

browse in interface QueueControl

Throws:

Exception

browse

public CompositeData[] browse(int page,
                              int pageSize,
                              String filter)
                       throws Exception

Specified by:

browse in interface QueueControl

Throws:

Exception

browse

public CompositeData[] browse()
                       throws Exception

Specified by:

browse in interface QueueControl

Throws:

Exception

browse

public CompositeData[] browse(String filter)
                       throws Exception

Specified by:

browse in interface QueueControl

Throws:

Exception

flushExecutor

public void flushExecutor()

Description copied from interface: QueueControl

it will flush one cycle on internal executors, so you would be sure that any pending tasks are done before you call any other measure. It is useful if you need the exact number of counts on a message

Specified by:

flushExecutor in interface QueueControl

resetAllGroups

public void resetAllGroups()

Description copied from interface: QueueControl

Will reset the all the groups. This is useful if you want a complete rebalance of the groups to consumers

Specified by:

resetAllGroups in interface QueueControl

resetGroup

public void resetGroup(String groupID)

Description copied from interface: QueueControl

Will reset the group matching the given groupID. This is useful if you want the given group to be rebalanced to the consumers

Specified by:

resetGroup in interface QueueControl

getGroupCount

public int getGroupCount()

Description copied from interface: QueueControl

Will return the current number of active groups.

Specified by:

getGroupCount in interface QueueControl

listGroupsAsJSON

public String listGroupsAsJSON()
                        throws Exception

Specified by:

listGroupsAsJSON in interface QueueControl

Throws:

Exception

getRingSize

public long getRingSize()

Description copied from interface: QueueControl

Will return the ring size.

Specified by:

getRingSize in interface QueueControl

listConsumersAsJSON

public String listConsumersAsJSON()
                           throws Exception

Specified by:

listConsumersAsJSON in interface QueueControl

Throws:

Exception

fillMBeanOperationInfo

protected MBeanOperationInfo[] fillMBeanOperationInfo()

Specified by:

fillMBeanOperationInfo in class AbstractControl

fillMBeanAttributeInfo

protected MBeanAttributeInfo[] fillMBeanAttributeInfo()

Specified by:

fillMBeanAttributeInfo in class AbstractControl

resetMessagesAdded

public void resetMessagesAdded()
                        throws Exception

Description copied from interface: QueueControl

Resets the MessagesAdded property

Specified by:

resetMessagesAdded in interface QueueControl

Throws:

Exception

resetMessagesAcknowledged

public void resetMessagesAcknowledged()
                               throws Exception

Description copied from interface: QueueControl

Resets the MessagesAdded property

Specified by:

resetMessagesAcknowledged in interface QueueControl

Throws:

Exception

resetMessagesExpired

public void resetMessagesExpired()
                          throws Exception

Description copied from interface: QueueControl

Resets the MessagesExpired property

Specified by:

resetMessagesExpired in interface QueueControl

Throws:

Exception

resetMessagesKilled

public void resetMessagesKilled()
                         throws Exception

Description copied from interface: QueueControl

Resets the MessagesExpired property

Specified by:

resetMessagesKilled in interface QueueControl

Throws:

Exception

isGroupRebalance

public boolean isGroupRebalance()

Description copied from interface: QueueControl

Returns whether the groups of this queue are automatically rebalanced.

Specified by:

isGroupRebalance in interface QueueControl

isGroupRebalancePauseDispatch

public boolean isGroupRebalancePauseDispatch()

Description copied from interface: QueueControl

Returns whether the dispatch is paused when groups of this queue are automatically rebalanced.

Specified by:

isGroupRebalancePauseDispatch in interface QueueControl

getGroupBuckets

public int getGroupBuckets()

Description copied from interface: QueueControl

Will return the group buckets.

Specified by:

getGroupBuckets in interface QueueControl

getGroupFirstKey

public String getGroupFirstKey()

Description copied from interface: QueueControl

Will return the header key to notify a consumer of a group change.

Specified by:

getGroupFirstKey in interface QueueControl

getPreparedTransactionMessageCount

public int getPreparedTransactionMessageCount()

Description copied from interface: QueueControl

Will return the number of messages stuck in prepared transactions

Specified by:

getPreparedTransactionMessageCount in interface QueueControl