org.apache.qpid.server.queue
Interface AMQQueue
- All Superinterfaces:
- BaseQueue, Comparable<AMQQueue>, ConfiguredObject<QueueConfigType,QueueConfig>, ExchangeReferrer, Managable, QueueConfig, TransactionLogResource
- All Known Implementing Classes:
- AMQPriorityQueue, ConflationQueue, SimpleAMQQueue
public interface AMQQueue
- extends Managable, Comparable<AMQQueue>, ExchangeReferrer, TransactionLogResource, BaseQueue, QueueConfig
Method Summary |
void |
addBinding(Binding binding)
|
void |
addQueueDeleteTask(AMQQueue.Task task)
|
void |
checkCapacity(AMQChannel channel)
|
void |
checkMessageStatus()
Checks the status of messages on the queue, purging expired ones, firing age related alerts etc. |
long |
clearQueue()
|
void |
configure(ConfigurationPlugin config)
|
void |
copyMessagesToAnotherQueue(long fromMessageId,
long toMessageId,
String queueName,
ServerTransaction transaction)
|
void |
decrementUnackedMsgCount()
|
int |
delete()
|
void |
deleteMessageFromTop()
|
void |
deliverAsync()
|
void |
deliverAsync(Subscription sub)
|
void |
dequeue(QueueEntry entry,
Subscription sub)
|
void |
flushSubscription(Subscription sub)
|
int |
getActiveConsumerCount()
|
Exchange |
getAlternateExchange()
|
Map<String,Object> |
getArguments()
|
int |
getBindingCount()
|
List<Binding> |
getBindings()
|
long |
getCapacity()
|
ConfigurationPlugin |
getConfiguration()
|
int |
getConsumerCount()
|
boolean |
getDeleteOnNoConsumers()
|
AMQSessionModel |
getExclusiveOwningSession()
|
long |
getFlowResumeCapacity()
|
LogSubject |
getLogSubject()
|
ManagedObject |
getManagedObject()
|
long |
getMaximumMessageAge()
|
long |
getMaximumMessageCount()
|
long |
getMaximumMessageSize()
|
long |
getMaximumQueueDepth()
|
int |
getMessageCount()
|
QueueEntry |
getMessageOnTheQueue(long messageId)
|
List<QueueEntry> |
getMessagesOnTheQueue()
|
List<Long> |
getMessagesOnTheQueue(int num)
|
List<Long> |
getMessagesOnTheQueue(int num,
int offest)
|
List<QueueEntry> |
getMessagesOnTheQueue(long fromMessageId,
long toMessageId)
|
List<QueueEntry> |
getMessagesRangeOnTheQueue(long fromPosition,
long toPosition)
Returns a list of QueEntries from a given range of queue positions, eg messages 5 to 10 on the queue. |
long |
getMinimumAlertRepeatGap()
|
Set<NotificationCheck> |
getNotificationChecks()
|
long |
getOldestMessageArrivalTime()
|
org.apache.qpid.framing.AMQShortString |
getOwner()
|
PrincipalHolder |
getPrincipalHolder()
|
long |
getQueueDepth()
|
long |
getReceivedMessageCount()
|
int |
getUndeliveredMessageCount()
|
VirtualHost |
getVirtualHost()
|
boolean |
hasExclusiveSubscriber()
|
boolean |
isAutoDelete()
|
boolean |
isDeleted()
|
boolean |
isEmpty()
|
boolean |
isExclusive()
|
boolean |
isOverfull()
|
boolean |
isUnused()
|
void |
moveMessagesToAnotherQueue(long fromMessageId,
long toMessageId,
String queueName,
ServerTransaction transaction)
|
void |
registerSubscription(Subscription subscription,
boolean exclusive)
|
void |
removeBinding(Binding binding)
|
void |
removeMessagesFromQueue(long fromMessageId,
long toMessageId)
|
void |
removeQueueDeleteTask(AMQQueue.Task task)
|
void |
requeue(QueueEntry entry)
|
void |
requeue(QueueEntryImpl storeContext,
Subscription subscription)
|
boolean |
resend(QueueEntry entry,
Subscription subscription)
|
void |
setAlternateExchange(Exchange exchange)
|
void |
setCapacity(long capacity)
|
void |
setDeleteOnNoConsumers(boolean b)
|
void |
setExclusive(boolean exclusive)
|
void |
setExclusiveOwningSession(AMQSessionModel owner)
|
void |
setFlowResumeCapacity(long flowResumeCapacity)
|
void |
setMaximumMessageAge(long maximumMessageAge)
|
void |
setMaximumMessageCount(long value)
|
void |
setMaximumMessageSize(long value)
|
void |
setMaximumQueueDepth(long value)
|
void |
setMinimumAlertRepeatGap(long value)
|
void |
setNoLocal(boolean b)
|
void |
setPrincipalHolder(PrincipalHolder principalHolder)
|
void |
stop()
|
void |
unregisterSubscription(Subscription subscription)
|
Methods inherited from interface org.apache.qpid.server.configuration.QueueConfig |
getBindingCountHigh, getByteTxnDequeues, getByteTxnEnqueues, getConfigStore, getConsumerCountHigh, getMessageDequeueCount, getMsgTxnDequeues, getMsgTxnEnqueues, getName, getPersistentByteDequeues, getPersistentByteEnqueues, getPersistentMsgDequeues, getPersistentMsgEnqueues, getTotalDequeueSize, getTotalEnqueueSize, getUnackedMessageCount, getUnackedMessageCountHigh, purge |
getDeleteOnNoConsumers
boolean getDeleteOnNoConsumers()
setDeleteOnNoConsumers
void setDeleteOnNoConsumers(boolean b)
addBinding
void addBinding(Binding binding)
removeBinding
void removeBinding(Binding binding)
getBindings
List<Binding> getBindings()
getBindingCount
int getBindingCount()
- Specified by:
getBindingCount
in interface QueueConfig
getLogSubject
LogSubject getLogSubject()
setNoLocal
void setNoLocal(boolean b)
isAutoDelete
boolean isAutoDelete()
- Specified by:
isAutoDelete
in interface QueueConfig
getOwner
org.apache.qpid.framing.AMQShortString getOwner()
getPrincipalHolder
PrincipalHolder getPrincipalHolder()
setPrincipalHolder
void setPrincipalHolder(PrincipalHolder principalHolder)
setExclusiveOwningSession
void setExclusiveOwningSession(AMQSessionModel owner)
getExclusiveOwningSession
AMQSessionModel getExclusiveOwningSession()
getVirtualHost
VirtualHost getVirtualHost()
- Specified by:
getVirtualHost
in interface QueueConfig
registerSubscription
void registerSubscription(Subscription subscription,
boolean exclusive)
throws org.apache.qpid.AMQException
- Throws:
org.apache.qpid.AMQException
unregisterSubscription
void unregisterSubscription(Subscription subscription)
throws org.apache.qpid.AMQException
- Throws:
org.apache.qpid.AMQException
getConsumerCount
int getConsumerCount()
- Specified by:
getConsumerCount
in interface QueueConfig
getActiveConsumerCount
int getActiveConsumerCount()
hasExclusiveSubscriber
boolean hasExclusiveSubscriber()
isUnused
boolean isUnused()
isEmpty
boolean isEmpty()
getMessageCount
int getMessageCount()
- Specified by:
getMessageCount
in interface QueueConfig
getUndeliveredMessageCount
int getUndeliveredMessageCount()
getQueueDepth
long getQueueDepth()
- Specified by:
getQueueDepth
in interface QueueConfig
getReceivedMessageCount
long getReceivedMessageCount()
- Specified by:
getReceivedMessageCount
in interface QueueConfig
getOldestMessageArrivalTime
long getOldestMessageArrivalTime()
isDeleted
boolean isDeleted()
delete
int delete()
throws org.apache.qpid.AMQException
- Throws:
org.apache.qpid.AMQException
requeue
void requeue(QueueEntry entry)
requeue
void requeue(QueueEntryImpl storeContext,
Subscription subscription)
dequeue
void dequeue(QueueEntry entry,
Subscription sub)
decrementUnackedMsgCount
void decrementUnackedMsgCount()
resend
boolean resend(QueueEntry entry,
Subscription subscription)
throws org.apache.qpid.AMQException
- Throws:
org.apache.qpid.AMQException
addQueueDeleteTask
void addQueueDeleteTask(AMQQueue.Task task)
removeQueueDeleteTask
void removeQueueDeleteTask(AMQQueue.Task task)
getMessagesOnTheQueue
List<QueueEntry> getMessagesOnTheQueue()
getMessagesOnTheQueue
List<QueueEntry> getMessagesOnTheQueue(long fromMessageId,
long toMessageId)
getMessagesOnTheQueue
List<Long> getMessagesOnTheQueue(int num)
getMessagesOnTheQueue
List<Long> getMessagesOnTheQueue(int num,
int offest)
getMessageOnTheQueue
QueueEntry getMessageOnTheQueue(long messageId)
getMessagesRangeOnTheQueue
List<QueueEntry> getMessagesRangeOnTheQueue(long fromPosition,
long toPosition)
- Returns a list of QueEntries from a given range of queue positions, eg messages 5 to 10 on the queue.
The 'queue position' index starts from 1. Using 0 in 'from' will be ignored and continue from 1.
Using 0 in the 'to' field will return an empty list regardless of the 'from' value.
- Parameters:
fromPosition
- toPosition
-
- Returns:
moveMessagesToAnotherQueue
void moveMessagesToAnotherQueue(long fromMessageId,
long toMessageId,
String queueName,
ServerTransaction transaction)
copyMessagesToAnotherQueue
void copyMessagesToAnotherQueue(long fromMessageId,
long toMessageId,
String queueName,
ServerTransaction transaction)
removeMessagesFromQueue
void removeMessagesFromQueue(long fromMessageId,
long toMessageId)
getMaximumMessageSize
long getMaximumMessageSize()
setMaximumMessageSize
void setMaximumMessageSize(long value)
getMaximumMessageCount
long getMaximumMessageCount()
setMaximumMessageCount
void setMaximumMessageCount(long value)
getMaximumQueueDepth
long getMaximumQueueDepth()
setMaximumQueueDepth
void setMaximumQueueDepth(long value)
getMaximumMessageAge
long getMaximumMessageAge()
setMaximumMessageAge
void setMaximumMessageAge(long maximumMessageAge)
getMinimumAlertRepeatGap
long getMinimumAlertRepeatGap()
setMinimumAlertRepeatGap
void setMinimumAlertRepeatGap(long value)
getCapacity
long getCapacity()
setCapacity
void setCapacity(long capacity)
getFlowResumeCapacity
long getFlowResumeCapacity()
setFlowResumeCapacity
void setFlowResumeCapacity(long flowResumeCapacity)
isOverfull
boolean isOverfull()
deleteMessageFromTop
void deleteMessageFromTop()
clearQueue
long clearQueue()
throws org.apache.qpid.AMQException
- Throws:
org.apache.qpid.AMQException
checkMessageStatus
void checkMessageStatus()
throws org.apache.qpid.AMQException
- Checks the status of messages on the queue, purging expired ones, firing age related alerts etc.
- Throws:
org.apache.qpid.AMQException
getNotificationChecks
Set<NotificationCheck> getNotificationChecks()
flushSubscription
void flushSubscription(Subscription sub)
throws org.apache.qpid.AMQException
- Throws:
org.apache.qpid.AMQException
deliverAsync
void deliverAsync(Subscription sub)
deliverAsync
void deliverAsync()
stop
void stop()
isExclusive
boolean isExclusive()
- Specified by:
isExclusive
in interface QueueConfig
getAlternateExchange
Exchange getAlternateExchange()
- Specified by:
getAlternateExchange
in interface QueueConfig
setAlternateExchange
void setAlternateExchange(Exchange exchange)
getArguments
Map<String,Object> getArguments()
- Specified by:
getArguments
in interface QueueConfig
checkCapacity
void checkCapacity(AMQChannel channel)
configure
void configure(ConfigurationPlugin config)
getConfiguration
ConfigurationPlugin getConfiguration()
getManagedObject
ManagedObject getManagedObject()
- Specified by:
getManagedObject
in interface Managable
setExclusive
void setExclusive(boolean exclusive)
throws org.apache.qpid.AMQException
- Throws:
org.apache.qpid.AMQException
Licensed to the Apache Software Foundation