|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface QueueControl
A QueueControl is used to manage a queue.
Method Summary | |
---|---|
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. |
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 to 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 to this queue. |
String |
getFilter()
Returns the filter associated to this queue. |
long |
getID()
Returns this queue ID. |
long |
getMessageCount()
Returns the number of messages currently in this queue. |
long |
getMessagesAdded()
Returns the number of messages added to this queue since it was created. |
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()
|
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(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. |
boolean |
removeMessage(long messageID)
Removes the message corresponding to the specified message ID. |
int |
removeMessages(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(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 |
setDeadLetterAddress(String deadLetterAddress)
Sets the dead-letter address associated to this queue to the specified deadLetterAddress. |
void |
setExpiryAddress(String expiryAddres)
Sets the expiry address associated to this queue to the specified expiryAddress. |
Method Detail |
---|
String getName()
String getAddress()
long getID()
boolean isTemporary()
boolean isDurable()
String getFilter()
long getMessageCount()
long getScheduledCount()
int getConsumerCount()
int getDeliveringCount()
long getMessagesAdded()
String getExpiryAddress()
void setExpiryAddress(String expiryAddres) throws Exception
Exception
String getDeadLetterAddress()
void setDeadLetterAddress(String deadLetterAddress) throws Exception
Exception
Map<String,Object>[] listScheduledMessages() throws Exception
Exception
String listScheduledMessagesAsJSON() throws Exception
Exception
Map<String,Object>[] listMessages(String filter) throws Exception
null
or an empty filter will list all messages from this queue.
Exception
String listMessagesAsJSON(String filter) throws Exception
null
or an empty filter will list all messages from this queue.
Exception
long countMessages(String filter) throws Exception
null
or an empty filter will count all messages from this queue.
Exception
boolean removeMessage(long messageID) throws Exception
true
if the message was removed, false
else
Exception
int removeMessages(String filter) throws Exception
null
or an empty filter will remove all messages from this queue.
Exception
int expireMessages(String filter) throws Exception
null
or an empty filter will expire all messages from this queue.
Exception
boolean expireMessage(long messageID) throws Exception
true
if the message was expired, false
else
Exception
boolean moveMessage(long messageID, String otherQueueName) throws Exception
true
if the message was moved, false
else
Exception
boolean moveMessage(long messageID, String otherQueueName, boolean rejectDuplicates) throws Exception
true
if the message was moved, false
else
Exception
int moveMessages(String filter, String otherQueueName) throws Exception
null
or an empty filter will move all messages from this queue.
Exception
int moveMessages(String filter, String otherQueueName, boolean rejectDuplicates) throws Exception
null
or an empty filter will move all messages from this queue.
Exception
boolean sendMessageToDeadLetterAddress(long messageID) throws Exception
true
if the message was sent to the dead letter address, false
else
Exception
int sendMessagesToDeadLetterAddress(String filterStr) throws Exception
null
or an empty filter will send all messages from this queue.
Exception
boolean changeMessagePriority(long messageID, int newPriority) throws Exception
newPriority
- between 0 and 9 inclusive.
true
if the message priority was changed
Exception
int changeMessagesPriority(String filter, int newPriority) throws Exception
null
or an empty filter will change all messages from this queue.
Exception
String listMessageCounter() throws Exception
Exception
void resetMessageCounter() throws Exception
Exception
String listMessageCounterAsHTML() throws Exception
Exception
String listMessageCounterHistory() throws Exception
Exception
String listMessageCounterHistoryAsHTML() throws Exception
Exception
void pause() throws Exception
Exception
void resume() throws Exception
Exception
String listConsumersAsJSON() throws Exception
Exception
boolean isPaused() throws Exception
Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |