public interface ManagedQueue
Modifier and Type | Method and Description |
---|---|
Long |
clearQueue()
Clears the queue by deleting all the messages from the queue that have not been acquired by consumers"
Since Qpid JMX API 1.3 this returns the number of messages deleted.
|
void |
copyMessages(long fromMessageId,
long toMessageId,
String toQueue)
Copies the messages in given range of AMQ message Ids to a given Queue.
|
void |
deleteMessageFromTop()
Deprecated.
|
void |
deleteMessages(long fromMessageId,
long toMessageId)
Deletes the messages in given range of AMQ message Ids in the given Queue.
|
Integer |
getActiveConsumerCount()
Returns the total number of active subscribers to the queue.
|
String |
getAlternateExchange()
Returns the name of the Alternate Exchange for the queue, or null if there isn't one.
|
Long |
getCapacity()
Returns the current flow control Capacity of the queue in bytes.
|
Integer |
getConsumerCount()
Returns the total number of subscribers to the queue.
|
String |
getDescription()
Gets the free text queue description.
|
Long |
getFlowResumeCapacity()
Returns the current flow control FlowResumeCapacity of the queue in bytes.
|
Integer |
getMaximumDeliveryCount()
Maximum number of times a message is permitted to be delivered or zero if not enforced.
|
Long |
getMaximumMessageAge()
Returns the maximum age of a message (expiration time) in milliseconds
|
Long |
getMaximumMessageCount()
Tells the maximum number of messages that can be stored in the queue.
|
Long |
getMaximumMessageSize()
Returns the maximum size of a message (in Bytes) allowed to be accepted by the
ManagedQueue.
|
Long |
getMaximumQueueDepth()
This is useful for setting notifications or taking required action if the size of messages
stored in the queue increases over this limit.
|
Integer |
getMessageCount()
Total number of messages on the queue, which are yet to be delivered to the consumer(s).
|
String |
getMessageGroupKey()
Gets the message group key
|
String |
getName()
Returns the Name of the ManagedQueue.
|
Long |
getOldestMessageAge()
Gets the arrival time of the oldest message in the queue
|
String |
getOwner()
Tells the Owner of the ManagedQueue.
|
Long |
getQueueDepth()
Size of messages in the queue
Since Qpid JMX API 1.2 this operation returns in units of bytes.
|
String |
getQueueType()
Gets the queue type
|
Long |
getReceivedMessageCount()
Tells the total number of messages receieved by the queue since startup.
|
boolean |
isAutoDelete()
Tells if the ManagedQueue is set to AutoDelete.
|
boolean |
isDurable()
Tells whether this ManagedQueue is durable or not.
|
boolean |
isExclusive()
Returns whether the queue is exclusive or not.
|
boolean |
isFlowOverfull()
Indicates whether the Queue is currently considered overfull by the FlowControl system
|
boolean |
isMessageGroupSharedGroups()
Gets the message group key
|
void |
moveMessages(long fromMessageId,
long toMessageId,
String toQueue)
Moves the messages in given range of message Ids to given Queue.
|
void |
setAlternateExchange(String exchangeName)
Sets the Alternate Exchange for the queue, for use in dead letter queue functionality.
|
void |
setCapacity(Long value)
Sets the Capacity in bytes above which flow is blocked.
|
void |
setDescription(String string)
Sets the free text queue description.
|
void |
setExclusive(boolean exclusive)
Sets whether the queue is exclusive or not.
|
void |
setFlowResumeCapacity(Long value)
Sets the FlowResumeCapacity in bytes below which flow resumes.
|
void |
setMaximumMessageAge(Long age)
Sets the maximum age of a message in milliseconds
|
void |
setMaximumMessageCount(Long value)
Sets the maximum number of messages allowed to be stored in the queue.
|
void |
setMaximumMessageSize(Long size)
Sets the maximum size of the message (in Bytes) that is allowed to be
accepted by the Queue.
|
void |
setMaximumQueueDepth(Long value)
Sets the maximum size of all the messages together, that can be stored
in the queue.
|
CompositeData |
viewMessageContent(long messageId)
Returns the content for the given AMQ Message ID.
|
TabularData |
viewMessages(int fromIndex,
int toIndex)
Deprecated.
|
TabularData |
viewMessages(long startPosition,
long endPosition)
Returns a subset (up to 2^31 messages at a time) of all the messages stored on the queue.
|
static final String TYPE
static final String MSG_AMQ_ID
static final String MSG_HEADER
static final String MSG_SIZE
static final String MSG_REDELIVERED
static final String MSG_QUEUE_POS
static final String MSG_DELIVERY_COUNT
static final String MIME
static final String ENCODING
static final String CONTENT
static final List<String> VIEW_MSG_CONTENT_COMPOSITE_ITEM_NAMES_DESC
static final String JMSTIMESTAMP_DATETIME_FORMAT
static final String ATTR_NAME
static final String ATTR_DESCRIPTION
static final String ATTR_QUEUE_TYPE
static final String ATTR_OWNER
static final String ATTR_MAX_MSG_AGE
static final String ATTR_MAX_MSG_COUNT
static final String ATTR_MAX_QUEUE_DEPTH
static final String ATTR_MAX_MSG_SIZE
static final String ATTR_MAXIMUM_DELIVERY_COUNT
static final String ATTR_DURABLE
static final String ATTR_AUTODELETE
static final String ATTR_CONSUMER_COUNT
static final String ATTR_ACTIVE_CONSUMER_COUNT
static final String ATTR_MSG_COUNT
static final String ATTR_QUEUE_DEPTH
static final String ATTR_RCVD_MSG_COUNT
static final String ATTR_CAPACITY
static final String ATTR_FLOW_OVERFULL
static final String ATTR_FLOW_RESUME_CAPACITY
static final String ATTR_EXCLUSIVE
static final String ATTR_ALT_EXCHANGE
static final String ATTR_SHARED_MESSAGE_GROUP
static final String ATTR_MESSAGE_GROUP_KEY
static final String ATTR_OLDEST_MESSAGE_AGE
String getName() throws IOException
IOException
Integer getMessageCount() throws IOException
IOException
Integer getMaximumDeliveryCount() throws IOException
IOException
Long getReceivedMessageCount() throws IOException
IOException
Long getQueueDepth() throws IOException, JMException
IOException
JMException
Integer getActiveConsumerCount() throws IOException
IOException
Integer getConsumerCount() throws IOException
IOException
String getOwner() throws IOException
IOException
boolean isDurable() throws IOException
IOException
boolean isAutoDelete() throws IOException
IOException
Long getMaximumMessageAge() throws IOException
IOException
void setMaximumMessageAge(Long age) throws IOException
age
- maximum age of message.IOException
Long getMaximumMessageSize() throws IOException
IOException
void setMaximumMessageSize(Long size) throws IOException
size
- maximum size of message.IOException
Long getMaximumMessageCount() throws IOException
IOException
void setMaximumMessageCount(Long value) throws IOException
value
- the maximum number of messages allowed to be stored in the queue.IOException
Long getMaximumQueueDepth() throws IOException
IOException
void setMaximumQueueDepth(Long value) throws IOException
value
- IOException
Long getCapacity() throws IOException
IOException
void setCapacity(Long value) throws IOException, IllegalArgumentException
value
- the capacity in bytesIOException
IllegalArgumentException
- If the given value is less than the queue FloeResumeCapacityString getDescription()
void setDescription(String string)
Long getFlowResumeCapacity() throws IOException
IOException
void setFlowResumeCapacity(Long value) throws IOException, IllegalArgumentException
value
- of the resume capacity in bytesIOException
IllegalArgumentException
- If the given value exceeds the queue Capacityboolean isFlowOverfull() throws IOException
IOException
boolean isExclusive() throws IOException
IOException
void setExclusive(boolean exclusive) throws IOException, JMException
exclusive
- the capacity in bytesIOException
JMException
void setAlternateExchange(String exchangeName) throws IOException, JMException
exchangeName
- the name of the exchange to use. Specifying null or the empty string will clear the
alternate exchange.IOException
JMException
String getAlternateExchange() throws IOException
IOException
String getQueueType()
String getMessageGroupKey()
boolean isMessageGroupSharedGroups()
Long getOldestMessageAge()
@Deprecated TabularData viewMessages(int fromIndex, int toIndex) throws IOException, JMException
fromIndex
- toIndex
- IOException
JMException
TabularData viewMessages(long startPosition, long endPosition) throws IOException, JMException
startPosition
- endPosition
- IOException
JMException
CompositeData viewMessageContent(long messageId) throws IOException, JMException
IOException
JMException
@Deprecated void deleteMessageFromTop() throws IOException, JMException
IOException
JMException
Long clearQueue() throws IOException, JMException
IOException
JMException
void moveMessages(long fromMessageId, long toMessageId, String toQueue) throws IOException, JMException
fromMessageId
- first in the range of message idstoMessageId
- last in the range of message idstoQueue
- where the messages are to be movedIOException
JMException
void deleteMessages(long fromMessageId, long toMessageId) throws IOException, JMException
fromMessageId
- first in the range of message idstoMessageId
- last in the range of message idsIOException
JMException
void copyMessages(long fromMessageId, long toMessageId, String toQueue) throws IOException, JMException
fromMessageId
- first in the range of message idstoMessageId
- last in the range of message idstoQueue
- where the messages are to be copiedIOException
JMException
Copyright © 2006–2016 The Apache Software Foundation. All rights reserved.