public interface QueueControl
| Modifier and Type | Method and Description |
|---|---|
CompositeData[] |
browse(String filter)
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 filter,
int newPriority)
Changes the priority for all the message corresponding to the specified filter to the specified priority.
|
long |
countMessages(String filter)
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 filter)
Expires all the message corresponding to the specified filter.
|
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.
|
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
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 filter)
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 filter,
String otherQueueName,
boolean rejectDuplicates) |
int |
moveMessages(String filter,
String otherQueueName)
Moves all the message corresponding to the specified filter to the specified other queue.
|
int |
moveMessages(String filter,
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 filter)
Removes all the message corresponding to the specified filter.
|
int |
removeMessages(String filter)
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.
|
String getName()
String getAddress()
long getID()
boolean isTemporary()
boolean isDurable()
String getFilter()
long getMessageCount()
long getScheduledCount()
int getConsumerCount()
int getDeliveringCount()
long getMessagesAdded()
long getMessagesAcknowledged()
long getMessagesExpired()
long getMessagesKilled()
String getFirstMessageAsJSON() throws Exception
ExceptionLong getFirstMessageTimestamp() throws Exception
ExceptionLong getFirstMessageAge() throws Exception
ExceptionString getExpiryAddress()
String getDeadLetterAddress()
Map<String,Object>[] listScheduledMessages() throws Exception
ExceptionString listScheduledMessagesAsJSON() throws Exception
ExceptionMap<String,Map<String,Object>[]> listDeliveringMessages() throws Exception
Map<String,Object>[] same way is returned by listScheduledMessages()ExceptionString listDeliveringMessagesAsJSON() throws Exception
listDeliveringMessages() to JSONExceptionMap<String,Object>[] listMessages(String filter) throws Exception
null or an empty filter will list all messages from this queue.ExceptionString listMessagesAsJSON(String filter) throws Exception
null or an empty filter will list all messages from this queue.Exceptionlong countMessages(String filter) throws Exception
null or an empty filter will count all messages from this queue.Exceptionboolean removeMessage(long messageID)
throws Exception
true if the message was removed, false elseExceptionint removeMessages(String filter) throws Exception
null or an empty filter will remove all messages from this queue.Exceptionint removeMessages(int flushLimit,
String filter)
throws Exception
null or an empty filter will remove all messages from this queue.Exceptionint expireMessages(String filter) throws Exception
null or an empty filter will expire all messages from this queue.Exceptionboolean expireMessage(long messageID)
throws Exception
true if the message was expired, false elseExceptionboolean retryMessage(long messageID)
throws Exception
messageID - true if the message was retried, false elseExceptionint retryMessages()
throws Exception
Exceptionboolean moveMessage(long messageID,
String otherQueueName)
throws Exception
true if the message was moved, false elseExceptionboolean moveMessage(long messageID,
String otherQueueName,
boolean rejectDuplicates)
throws Exception
true if the message was moved, false elseExceptionint moveMessages(String filter, String otherQueueName) throws Exception
null or an empty filter will move all messages from this queue.Exceptionint moveMessages(String filter, String otherQueueName, boolean rejectDuplicates) throws Exception
null or an empty filter will move all messages from this queue.Exceptionint moveMessages(int flushLimit,
String filter,
String otherQueueName,
boolean rejectDuplicates)
throws Exception
Exceptionboolean sendMessageToDeadLetterAddress(long messageID)
throws Exception
true if the message was sent to the dead letter address, false elseExceptionint sendMessagesToDeadLetterAddress(String filterStr) throws Exception
null or an empty filter will send all messages from this queue.ExceptionString sendMessage(Map<String,String> headers, int type, String body, String userID, boolean durable, String user, String password) throws Exception
headers - the message headers and properties to set. Can only
container Strings maped to primitive types.body - the text to senduserID - durable - user - password - @returnExceptionboolean changeMessagePriority(long messageID,
int newPriority)
throws Exception
newPriority - between 0 and 9 inclusive.true if the message priority was changedExceptionint changeMessagesPriority(String filter, int newPriority) throws Exception
null or an empty filter will change all messages from this queue.ExceptionString listMessageCounter() throws Exception
Exceptionvoid resetMessageCounter()
throws Exception
ExceptionString listMessageCounterAsHTML() throws Exception
ExceptionString listMessageCounterHistory() throws Exception
ExceptionString listMessageCounterHistoryAsHTML() throws Exception
Exceptionvoid pause()
throws Exception
Exceptionvoid pause(boolean persist)
throws Exception
Exceptionvoid resume()
throws Exception
ExceptionCompositeData[] browse(String filter) throws Exception
Exceptionvoid resetMessagesAdded()
throws Exception
Exceptionvoid resetMessagesAcknowledged()
throws Exception
Exceptionvoid resetMessagesExpired()
throws Exception
Exceptionvoid resetMessagesKilled()
throws Exception
Exceptionvoid flushExecutor()
Copyright © 2018 The Apache Software Foundation. All rights reserved.