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 and Description
static int	FLUSH_LIMIT

Constructor Summary

Constructors

Constructor and Description
QueueControlImpl(Queue queue, String address, PostOffice postOffice, StorageManager storageManager, SecurityStore securityStore, HierarchicalRepository<AddressSettings> addressSettingsRepository)

Method Summary

Modifier and Type	Method and Description
CompositeData[]	browse(String filterStr) Resets the MessagesAdded property
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	countMessages(String filterStr) Counts the number of messages in this queue matching the specified filter.
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.
String	getAddress() Returns the address this queue is bound to.
int	getConsumerCount() Returns the number of consumers consuming messages from this queue.
String	getDeadLetterAddress() Returns the dead-letter address associated with this queue.
int	getDeliveringCount() Returns the number of messages that this queue is currently delivering to its consumers.
String	getExpiryAddress() Returns the expiry address associated with this queue.
String	getFilter() Returns the filter associated with this queue.
protected Map<String,Object>[]	getFirstMessage()
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.
long	getID() Returns this queue ID.
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	getScheduledCount() Returns the number of scheduled messages in this queue.
boolean	isDurable() Returns whether this queue is durable.
boolean	isPaused() Returns whether the queue is paused.
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	listMessageCounter() Lists the message counter for this queue.
String	listMessageCounterAsHTML() Lists the message counter for this queue as a HTML table.
String	listMessageCounterHistory() Lists the message counter history for this queue.
String	listMessageCounterHistoryAsHTML() Lists the message counter history for this queue as a HTML table.
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(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.
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	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, String userID, boolean durable, String user, String password)
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

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,
                        PostOffice postOffice,
                        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

isTemporary

public boolean isTemporary()

Description copied from interface: QueueControl

Returns whether this queue is temporary.

Specified by:

isTemporary 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

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

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

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

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

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

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

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

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(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,
                          String userID,
                          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

password - @return

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

public String listMessageCounterAsHTML()

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

public String listMessageCounterHistoryAsHTML()

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(String filterStr)
                       throws Exception

Description copied from interface: QueueControl

Resets the MessagesAdded property

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

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