public interface JMSQueueControl extends DestinationControl
| Modifier and Type | Method and Description |
|---|---|
void |
addBinding(String binding)
Add the JNDI binding to this destination
|
CompositeData[] |
browse()
Resumes the queue.
|
CompositeData[] |
browse(String filter)
Resumes the queue.
|
boolean |
changeMessagePriority(String 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(String 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.
|
int |
getConsumerCount()
Returns the number of consumers consuming messages from this queue.
|
String |
getDeadLetterAddress()
Returns the dead-letter address associated with this queue.
|
String |
getExpiryAddress()
Returns the expiry address 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 |
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[] |
getRegistryBindings()
Returns the Registry bindings associated with this queue.
|
long |
getScheduledCount()
Returns the number of scheduled messages in this queue.
|
String |
getSelector()
returns the selector for the queue
|
boolean |
isPaused()
Returns whether the queue is paused.
|
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 JMS messages in this queue matching the specified filter.
|
String |
listMessagesAsJSON(String filter)
Lists all the JMS 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(String messageID,
String otherQueueName)
Moves the message corresponding to the specified message ID to the specified other queue.
|
boolean |
moveMessage(String 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.
|
void |
pause(boolean persist)
Pauses the queue.
|
boolean |
removeMessage(String 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.
|
boolean |
retryMessage(String 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.
|
int |
sendMessagesToDeadLetterAddress(String filterStr)
Sends all the message corresponding to the specified filter to this queue's dead letter address.
|
boolean |
sendMessageToDeadLetterAddress(String messageID)
Sends the message corresponding to the specified message ID to this queue's dead letter address.
|
String |
sendTextMessage(Map<String,String> headers,
String body)
Sends a TextMesage to the destination.
|
String |
sendTextMessage(Map<String,String> headers,
String body,
String user,
String password) |
String |
sendTextMessage(String body)
Sends a TextMesage to the destination.
|
String |
sendTextMessage(String body,
String user,
String password)
Sends a TextMesage to the destination.
|
String |
sendTextMessageWithProperties(String properties)
Sends a TextMessage to the destination.
|
getAddress, getDeliveringCount, getMessageCount, getMessagesAdded, getName, isTemporaryString getExpiryAddress()
String getDeadLetterAddress()
long getScheduledCount()
int getConsumerCount()
long getMessagesExpired()
long getMessagesKilled()
String getSelector()
String getFirstMessageAsJSON() throws Exception
ExceptionLong getFirstMessageTimestamp() throws Exception
ExceptionLong getFirstMessageAge() throws Exception
ExceptionString[] getRegistryBindings()
void addBinding(String binding) throws Exception
ExceptionMap<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(String 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.removeMessages in interface DestinationControlExceptionint expireMessages(String filter) throws Exception
null or an empty filter will expire all messages from this queue.Exceptionboolean expireMessage(String messageID) throws Exception
true if the message was expired, false elseExceptionboolean sendMessageToDeadLetterAddress(String 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 sendTextMessage(String body) throws Exception
body - the text to sendExceptionString sendTextMessageWithProperties(String properties) throws Exception
properties - the message properties to set as a comma sep name=value list. Can only
contain Strings maped to primitive types or JMS properties. eg: body=hi,JMSReplyTo=Queue2ExceptionString sendTextMessage(Map<String,String> headers, String body) throws Exception
headers - the message headers and properties to set. Can only
container Strings maped to primitive types.body - the text to sendExceptionString sendTextMessage(String body, String user, String password) throws Exception
body - the text to senduser - password - ExceptionString sendTextMessage(Map<String,String> headers, String body, 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 senduser - password - Exceptionboolean changeMessagePriority(String 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.Exceptionboolean moveMessage(String messageID, String otherQueueName) throws Exception
true if the message was moved, false elseExceptionboolean moveMessage(String 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.Exceptionboolean retryMessage(String messageID) throws Exception
messageID - true if the message was retried, false elseExceptionint retryMessages()
throws Exception
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() throws Exception
ExceptionCompositeData[] browse(String filter) throws Exception
Exceptionvoid flushExecutor()
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 JSONExceptionCopyright © 2018 The Apache Software Foundation. All rights reserved.