org.hornetq.api.jms.management

Interface JMSQueueControl

All Superinterfaces:

DestinationControl

public interface JMSQueueControl
extends DestinationControl

A JMSQueueControl is used to manage a JMS queue.

Author:

Jeff Mesnil

Method Summary

Methods

Modifier and Type	Method and Description
void	addJNDI(java.lang.String jndi) Add the JNDI binding to this destination
boolean	changeMessagePriority(java.lang.String messageID, int newPriority) Changes the message's priority corresponding to the specified message ID to the specified priority.
int	changeMessagesPriority(java.lang.String filter, int newPriority) Changes the priority for all the message corresponding to the specified filter to the specified priority.
long	countMessages(java.lang.String filter) Counts the number of messages in this queue matching the specified filter.
boolean	expireMessage(java.lang.String messageID) Expires the message corresponding to the specified message ID.
int	expireMessages(java.lang.String filter) Expires all the message corresponding to the specified filter.
int	getConsumerCount() Returns the number of consumers consuming messages from this queue.
java.lang.String	getDeadLetterAddress() Returns the dead-letter address associated to this queue.
java.lang.String	getExpiryAddress() Returns the expiry address associated to this queue.
java.lang.String[]	getJNDIBindings() Returns the JNDI bindings associated to this connection factory.
long	getScheduledCount() Returns the number of scheduled messages in this queue.
java.lang.String	getSelector() returns the selector for the queue
boolean	isPaused() Returns whether the queue is paused.
java.lang.String	listConsumersAsJSON()
java.lang.String	listMessageCounter() Lists the message counter for this queue.
java.lang.String	listMessageCounterAsHTML() Lists the message counter for this queue as a HTML table.
java.lang.String	listMessageCounterHistory() Lists the message counter history for this queue.
java.lang.String	listMessageCounterHistoryAsHTML() Lists the message counter history for this queue as a HTML table.
java.util.Map<java.lang.String,java.lang.Object>[]	listMessages(java.lang.String filter) Lists all the JMS messages in this queue matching the specified filter.
java.lang.String	listMessagesAsJSON(java.lang.String filter) Lists all the JMS messages in this queue matching the specified filter using JSON serialization.
boolean	moveMessage(java.lang.String messageID, java.lang.String otherQueueName) Moves the message corresponding to the specified message ID to the specified other queue.
boolean	moveMessage(java.lang.String messageID, java.lang.String otherQueueName, boolean rejectDuplicates) Moves the message corresponding to the specified message ID to the specified other queue.
int	moveMessages(java.lang.String filter, java.lang.String otherQueueName) Moves all the message corresponding to the specified filter to the specified other queue.
int	moveMessages(java.lang.String filter, java.lang.String otherQueueName, boolean rejectDuplicates) Moves all the message corresponding to the specified filter to the specified other queue.
void	pause() Pauses the queue.
void	removeJNDI(java.lang.String jndi)
boolean	removeMessage(java.lang.String messageID) Removes the message corresponding to the specified message ID.
int	removeMessages(java.lang.String filter) Removes all the message corresponding to the specified filter.
void	resetMessageCounter() Resets the message counter for this queue.
void	resume() Resumes the queue.
int	sendMessagesToDeadLetterAddress(java.lang.String filterStr) Sends all the message corresponding to the specified filter to this queue's dead letter address.
boolean	sendMessageToDeadLetterAddress(java.lang.String messageID) Sends the message corresponding to the specified message ID to this queue's dead letter address.
void	setDeadLetterAddress(java.lang.String deadLetterAddress) Sets the dead-letter address associated to this queue to the specified deadLetterAddress.
void	setExpiryAddress(java.lang.String expiryAddress) Sets the expiry address associated to this queue to the specified expiryAddress.

Methods inherited from interface org.hornetq.api.jms.management.DestinationControl

getAddress, getDeliveringCount, getMessageCount, getMessagesAdded, getName, isTemporary

Method Detail

getExpiryAddress

java.lang.String getExpiryAddress()

Returns the expiry address associated to this queue.

setExpiryAddress

void setExpiryAddress(java.lang.String expiryAddress)
                      throws java.lang.Exception

Sets the expiry address associated to this queue to the specified expiryAddress.

Throws:

java.lang.Exception

getDeadLetterAddress

java.lang.String getDeadLetterAddress()

Returns the dead-letter address associated to this queue.

setDeadLetterAddress

void setDeadLetterAddress(java.lang.String deadLetterAddress)
                          throws java.lang.Exception

Sets the dead-letter address associated to this queue to the specified deadLetterAddress.

Throws:

java.lang.Exception

getScheduledCount

long getScheduledCount()

Returns the number of scheduled messages in this queue.

getConsumerCount

int getConsumerCount()

Returns the number of consumers consuming messages from this queue.

getSelector

java.lang.String getSelector()

returns the selector for the queue

getJNDIBindings

java.lang.String[] getJNDIBindings()

Returns the JNDI bindings associated to this connection factory.

addJNDI

void addJNDI(java.lang.String jndi)
             throws java.lang.Exception

Add the JNDI binding to this destination

Throws:

java.lang.Exception

removeJNDI

void removeJNDI(java.lang.String jndi)
                throws java.lang.Exception

Throws:

java.lang.Exception

listMessages

java.util.Map<java.lang.String,java.lang.Object>[] listMessages(java.lang.String filter)
                                                                throws java.lang.Exception

Lists all the JMS 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.

Throws:

java.lang.Exception

listMessagesAsJSON

java.lang.String listMessagesAsJSON(java.lang.String filter)
                                    throws java.lang.Exception

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

Throws:

java.lang.Exception

countMessages

long countMessages(java.lang.String filter)
                   throws java.lang.Exception

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.

Throws:

java.lang.Exception

removeMessage

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

Removes the message corresponding to the specified message ID.

Returns:

true if the message was removed, false else

Throws:

java.lang.Exception

removeMessages

int removeMessages(java.lang.String filter)
                   throws java.lang.Exception

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 DestinationControl

Returns:

the number of removed messages

Throws:

java.lang.Exception

expireMessages

int expireMessages(java.lang.String filter)
                   throws java.lang.Exception

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

Returns:

the number of expired messages

Throws:

java.lang.Exception

expireMessage

boolean expireMessage(java.lang.String messageID)
                      throws java.lang.Exception

Expires the message corresponding to the specified message ID.

Returns:

true if the message was expired, false else

Throws:

java.lang.Exception

sendMessageToDeadLetterAddress

boolean sendMessageToDeadLetterAddress(java.lang.String messageID)
                                       throws java.lang.Exception

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

Returns:

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

Throws:

java.lang.Exception

sendMessagesToDeadLetterAddress

int sendMessagesToDeadLetterAddress(java.lang.String filterStr)
                                    throws java.lang.Exception

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.

Returns:

the number of sent messages

Throws:

java.lang.Exception

changeMessagePriority

boolean changeMessagePriority(java.lang.String messageID,
                            int newPriority)
                              throws java.lang.Exception

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

Parameters:

newPriority - between 0 and 9 inclusive.

Returns:

true if the message priority was changed

Throws:

java.lang.Exception

changeMessagesPriority

int changeMessagesPriority(java.lang.String filter,
                         int newPriority)
                           throws java.lang.Exception

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.

Returns:

the number of changed messages

Throws:

java.lang.Exception

moveMessage

boolean moveMessage(java.lang.String messageID,
                  java.lang.String otherQueueName)
                    throws java.lang.Exception

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

Returns:

true if the message was moved, false else

Throws:

java.lang.Exception

moveMessage

boolean moveMessage(java.lang.String messageID,
                  java.lang.String otherQueueName,
                  boolean rejectDuplicates)
                    throws java.lang.Exception

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

Returns:

true if the message was moved, false else

Throws:

java.lang.Exception

moveMessages

int moveMessages(java.lang.String filter,
               java.lang.String otherQueueName)
                 throws java.lang.Exception

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.

Returns:

the number of moved messages

Throws:

java.lang.Exception

moveMessages

int moveMessages(java.lang.String filter,
               java.lang.String otherQueueName,
               boolean rejectDuplicates)
                 throws java.lang.Exception

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.

Returns:

the number of moved messages

Throws:

java.lang.Exception

listMessageCounter

java.lang.String listMessageCounter()
                                    throws java.lang.Exception

Lists the message counter for this queue.

Throws:

java.lang.Exception

resetMessageCounter

void resetMessageCounter()
                         throws java.lang.Exception

Resets the message counter for this queue.

Throws:

java.lang.Exception

listMessageCounterAsHTML

java.lang.String listMessageCounterAsHTML()
                                          throws java.lang.Exception

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

Throws:

java.lang.Exception

listMessageCounterHistory

java.lang.String listMessageCounterHistory()
                                           throws java.lang.Exception

Lists the message counter history for this queue.

Throws:

java.lang.Exception

listMessageCounterHistoryAsHTML

java.lang.String listMessageCounterHistoryAsHTML()
                                                 throws java.lang.Exception

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

Throws:

java.lang.Exception

pause

void pause()
           throws java.lang.Exception

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

Throws:

java.lang.Exception

isPaused

boolean isPaused()
                 throws java.lang.Exception

Returns whether the queue is paused.

Throws:

java.lang.Exception

resume

void resume()
            throws java.lang.Exception

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

Throws:

java.lang.Exception

listConsumersAsJSON

java.lang.String listConsumersAsJSON()
                                     throws java.lang.Exception

Throws:

java.lang.Exception