AbstractQueue (Qpid Java Build 6.0.4 API)

java.lang.Object
- org.apache.qpid.server.model.AbstractConfiguredObject<X>
- - org.apache.qpid.server.queue.AbstractQueue<X>

All Implemented Interfaces:

Comparable<AMQQueue>, ExchangeReferrer, MessageDestination, MessageNode, MessageSource, ConfiguredObject<X>, Queue<X>, CapacityChecker, AMQQueue<X>, BaseQueue, MessageGroupManager.ConsumerResetHelper, TransactionLogResource, Deletable<AMQQueue>, StateChangeListener<QueueConsumer<?>,State>

Direct Known Subclasses:

LastValueQueueImpl, OutOfOrderQueue, StandardQueueImpl
```
public abstract class AbstractQueue<X extends AbstractQueue<X>>
extends AbstractConfiguredObject<X>
implements AMQQueue<X>, StateChangeListener<QueueConsumer<?>,State>, MessageGroupManager.ConsumerResetHelper
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractQueue.MessageContent

static interface AbstractQueue.QueueEntryFilter
- Nested classes/interfaces inherited from class org.apache.qpid.server.model.AbstractConfiguredObject
  AbstractConfiguredObject.CallableWithArgument<V,A>, AbstractConfiguredObject.ChainedListenableFuture<V>, AbstractConfiguredObject.ChainedSettableFuture<V>, AbstractConfiguredObject.DuplicateIdException, AbstractConfiguredObject.DuplicateNameException
- Nested classes/interfaces inherited from interface org.apache.qpid.server.message.MessageSource
  MessageSource.ConsumerAccessRefused, MessageSource.ExistingConsumerPreventsExclusive, MessageSource.ExistingExclusiveConsumer

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractQueue.MessageContent`
`static interface`	`AbstractQueue.QueueEntryFilter`

Field Summary

Fields
Modifier and Type Field and Description

static String SHARED_MSG_GROUP_ARG_VALUE
- Fields inherited from class org.apache.qpid.server.model.AbstractConfiguredObject
  SECURED_STRING_VALUE
- Fields inherited from interface org.apache.qpid.server.model.Queue
  ALERT_REPEAT_GAP, ALERT_THRESHOLD_MESSAGE_AGE, ALERT_THRESHOLD_MESSAGE_SIZE, ALERT_THRESHOLD_QUEUE_DEPTH_BYTES, ALERT_THRESHOLD_QUEUE_DEPTH_MESSAGES, ALTERNATE_EXCHANGE, CLASS_DESCRIPTION, DEFAULT_ALERT_REPEAT_GAP, DEFAULT_ALERT_THRESHOLD_MESSAGE_AGE, DEFAULT_ALERT_THRESHOLD_MESSAGE_COUNT, DEFAULT_ALERT_THRESHOLD_MESSAGE_SIZE, DEFAULT_ALERT_THRESHOLD_QUEUE_DEPTH, DEFAULT_ESTIMATED_MESSAGE_MEMORY_OVERHEAD, DEFAULT_FILTERS, DEFAULT_FLOW_CONTROL_RESUME_SIZE_BYTES, DEFAULT_FLOW_CONTROL_SIZE_BYTES, DEFAULT_HOLD_ON_PUBLISH_ENABLED, DEFAULT_MAX_ASYNCHRONOUS_DELIVERIES, DEFAULT_MAXIMUM_DELIVERY_ATTEMPTS, DEFAULT_MAXIMUM_DISTINCT_GROUPS, DEFAULT_MINIMUM_ESTIMATED_MEMORY_FOOTPRINT, DEFAULT_SHARED_MESSAGE_GROUP, ENSURE_NONDESTRUCTIVE_CONSUMERS, EXCLUSIVE, HOLD_ON_PUBLISH_ENABLED, MAX_ASYNCHRONOUS_DELIVERIES, MAXIMUM_DELIVERY_ATTEMPTS, MAXIMUM_MESSAGE_TTL, MESSAGE_DURABILITY, MESSAGE_GROUP_DEFAULT_GROUP, MESSAGE_GROUP_KEY, MESSAGE_GROUP_SHARED_GROUPS, MINIMUM_MESSAGE_TTL, NO_LOCAL, OWNER, QUEUE_ESTIMATED_MESSAGE_MEMORY_OVERHEAD, QUEUE_FLOW_CONTROL_SIZE_BYTES, QUEUE_FLOW_RESUME_SIZE_BYTES, QUEUE_FLOW_STOPPED, QUEUE_MINIMUM_ESTIMATED_MEMORY_FOOTPRINT
- Fields inherited from interface org.apache.qpid.server.model.ConfiguredObject
  CONTEXT, CREATED_BY, CREATED_TIME, DESCRIPTION, DESIRED_STATE, DURABLE, ID, LAST_UPDATED_BY, LAST_UPDATED_TIME, LIFETIME_POLICY, NAME, OVER_SIZED_ATTRIBUTE_ALTERNATIVE_TEXT, STATE, TYPE

Fields
Modifier and Type	Field and Description
`static String`	`SHARED_MSG_GROUP_ARG_VALUE`

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractQueue(Map<String,Object> attributes, VirtualHostImpl virtualHost)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractQueue(Map<String,Object> attributes, VirtualHostImpl virtualHost)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBinding(BindingImpl binding)`
`protected <C extends ConfiguredObject> com.google.common.util.concurrent.ListenableFuture<C>`	`addChildAsync(Class<C> childClass, Map<String,Object> attributes, ConfiguredObject... otherParents)`
`org.apache.qpid.server.queue.QueueConsumerImpl`	`addConsumer(ConsumerTarget target, FilterManager filters, Class<? extends ServerMessage> messageClass, String consumerName, EnumSet<ConsumerImpl.Option> optionSet)`
`void`	`addDeleteTask(Action<? super AMQQueue> task)`
`protected void`	`advanceAllConsumers()`
`protected com.google.common.util.concurrent.ListenableFuture<Void>`	`beforeClose()`
`boolean`	`changeAttribute(String name, Object expected, Object desired)`
`void`	`checkCapacity(AMQSessionModel channel)`
`protected void`	`checkConsumersNotAheadOfDelivery(QueueEntry entry)`
`void`	`checkMessageStatus()` Checks the status of messages on the queue, purging expired ones, firing age related alerts etc.
`long`	`clearQueue()`
`int`	`compareTo(AMQQueue o)`
`void`	`completeRecovery()`
`List<Long>`	`copyMessages(Queue<?> destination, List<Long> messageIds, String selector, int limit)`
`void`	`decrementUnackedMsgCount(QueueEntry queueEntry)`
`com.google.common.util.concurrent.ListenableFuture<Integer>`	`deleteAndReturnCount()`
`List<Long>`	`deleteMessages(List<Long> messageIds, String selector, int limit)`
`void`	`deliverAsync()`
`void`	`dequeue(QueueEntry entry)`
`protected void`	`doEnqueue(ServerMessage message, Action<? super MessageInstance> action, MessageEnqueueRecord enqueueRecord)`
`void`	`enqueue(ServerMessage message, Action<? super MessageInstance> action, MessageEnqueueRecord enqueueRecord)`
`void`	`execute(String name, Runnable runnable, AccessControlContext context)`
`long`	`getAlertRepeatGap()`
`long`	`getAlertThresholdMessageAge()`
`long`	`getAlertThresholdMessageSize()`
`long`	`getAlertThresholdQueueDepthBytes()`
`long`	`getAlertThresholdQueueDepthMessages()`
`Exchange<?>`	`getAlternateExchange()`
`AtomicInteger`	`getAtomicQueueCount()`
`AtomicLong`	`getAtomicQueueSize()`
`Collection<String>`	`getAvailableAttributes()`
`int`	`getBindingCount()`
`Collection<BindingImpl>`	`getBindings()`
`<C extends ConfiguredObject> Collection<C>`	`getChildren(Class<C> clazz)` Return children of the ConfiguredObject of the given class
`int`	`getConsumerCount()`
`int`	`getConsumerCountWithCredit()`
`protected org.apache.qpid.server.queue.QueueConsumerList`	`getConsumerList()`
`Collection<QueueConsumer<?>>`	`getConsumers()`
`protected LogMessage`	`getCreatedLogMessage()`
`Map<String,Map<String,List<String>>>`	`getDefaultFilters()`
`EventLogger`	`getEventLogger()`
`ExclusivityPolicy`	`getExclusive()`
`LogSubject`	`getLogSubject()`
`int`	`getMaximumDeliveryAttempts()`
`int`	`getMaximumDistinctGroups()`
`long`	`getMaximumMessageTtl()`
`Content`	`getMessageContent(long messageId)`
`MessageDurability`	`getMessageDurability()`
`String`	`getMessageGroupDefaultGroup()`
`String`	`getMessageGroupKey()`
`List<MessageInfo>`	`getMessageInfo(int first, int last)`
`MessageInfo`	`getMessageInfoById(long messageId)`
`QueueEntry`	`getMessageOnTheQueue(long messageId)`
`List<QueueEntry>`	`getMessagesOnTheQueue()`
`List<QueueEntry>`	`getMessagesOnTheQueue(AbstractQueue.QueueEntryFilter filter)`
`List<Long>`	`getMessagesOnTheQueue(int num)`
`List<Long>`	`getMessagesOnTheQueue(int num, int offset)`
`List<QueueEntry>`	`getMessagesOnTheQueue(long fromMessageId, long toMessageId)`
`List<QueueEntry>`	`getMessagesRangeOnTheQueue(long fromPosition, long toPosition)` Returns a list of QueueEntries from a given range of queue positions, eg messages 5 to 10 on the queue.
`long`	`getMinimumMessageTtl()`
`Set<NotificationCheck>`	`getNotificationChecks()`
`long`	`getOldestMessageAge()`
`long`	`getOldestMessageArrivalTime()`
`String`	`getOwner()`
`long`	`getPersistentDequeuedBytes()`
`long`	`getPersistentDequeuedMessages()`
`long`	`getPersistentEnqueuedBytes()`
`long`	`getPersistentEnqueuedMessages()`
`long`	`getPotentialMemoryFootprint()`
`long`	`getQueueDepthBytes()`
`int`	`getQueueDepthMessages()`
`long`	`getQueueFlowControlSizeBytes()`
`long`	`getQueueFlowResumeSizeBytes()`
`long`	`getReceivedMessageCount()`
`long`	`getTotalDequeuedBytes()`
`long`	`getTotalDequeuedMessages()`
`long`	`getTotalEnqueuedBytes()`
`long`	`getTotalEnqueuedMessages()`
`long`	`getUnacknowledgedBytes()`
`long`	`getUnacknowledgedMessages()`
`int`	`getUndeliveredMessageCount()`
`VirtualHostImpl`	`getVirtualHost()`
`void`	`incrementUnackedMsgCount(QueueEntry entry)`
`boolean`	`isDeleted()`
`boolean`	`isEmpty()`
`boolean`	`isEnsureNondestructiveConsumers()`
`boolean`	`isEntryAheadOfConsumer(QueueEntry entry, QueueConsumer<?> sub)`
`boolean`	`isExclusive()`
`boolean`	`isHeld(QueueEntry queueEntry, long evaluationTime)`
`boolean`	`isHoldOnPublishEnabled()`
`boolean`	`isMessageGroupSharedGroups()`
`boolean`	`isNoLocal()`
`boolean`	`isQueueFlowStopped()`
`boolean`	`isUnused()`
`List<Long>`	`moveMessages(Queue<?> destination, List<Long> messageIds, String selector, int limit)`
`protected void`	`onClose()`
`protected void`	`onCreate()`
`protected void`	`onOpen()`
`void`	`onValidate()` Validation performed for configured object creation and opening.
`long`	`processQueue(QueueRunner runner)` Used by queue Runners to asynchronously deliver messages to consumers.
`void`	`recover(ServerMessage message, MessageEnqueueRecord enqueueRecord)`
`void`	`removeBinding(BindingImpl binding)`
`void`	`removeDeleteTask(Action<? super AMQQueue> task)`
`void`	`requeue(QueueEntry entry)`
`boolean`	`resend(QueueEntry entry, QueueConsumer<?> consumer)`
`void`	`resetSubPointersForGroups(QueueConsumer<?> consumer)`
`void`	`resetSubPointersForGroups(QueueEntry entry)`
`<M extends ServerMessage<? extends StorableMessageMetaData>> int`	`send(M message, String routingAddress, InstanceProperties instanceProperties, ServerTransaction txn, Action<? super MessageInstance> postEnqueueAction)` Routes a message
`void`	`setAlternateExchange(ExchangeImpl exchange)`
`void`	`setNotificationListener(QueueNotificationListener listener)`
`void`	`setTargetSize(long targetSize)`
`void`	`stateChanged(QueueConsumer<?> sub, State oldState, State newState)`
`String`	`toString()`
`protected void`	`validateChange(ConfiguredObject<?> proxyForValidation, Set<String> changedAttributes)`
`boolean`	`verifySessionAccess(AMQSessionModel<?> session)`
`void`	`visit(QueueEntryVisitor visitor)`

Methods inherited from class org.apache.qpid.server.model.AbstractConfiguredObject
addChangeListener, applyToChildren, asObjectRecord, attainState, attributeSet, authoriseCreate, authoriseCreateChild, authoriseDelete, authoriseSetAttributes, changeAttributes, childAdded, childRemoved, close, closeAsync, closeChildren, create, createAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, deleted, doAfter, doAfter, doAfter, doAfter, doAfter, doAfter, doAfterAlways, doAfterAlways, doCreation, doOnConfigThread, doOpening, doResolution, doSync, doSync, doValidation, findConfiguredObject, forceUpdateAllSecureAttributes, getActualAttributes, getAttainedChildById, getAttainedChildByName, getAttribute, getAttributeNames, getCategoryClass, getChildById, getChildByName, getChildExecutor, getContext, getContextKeys, getContextValue, getContextValue, getCreatedBy, getCreatedTime, getDescription, getDesiredState, getId, getLastOpenedTime, getLastUpdatedBy, getLastUpdatedTime, getLifetimePolicy, getModel, getName, getObjectFactory, getParent, getSecurityManager, getState, getStatistics, getTaskExecutor, getType, getTypeClass, handleExceptionOnOpen, isDurable, managesChildStorage, notifyStateChanged, onExceptionInOpen, onResolve, open, openAsync, parentsMap, postResolve, postResolveChildren, registerWithParents, removeChangeListener, rethrowRuntimeExceptionsOnOpen, runTask, setAttribute, setAttributes, setAttributesAsync, setEncrypter, setState, start, startAsync, stop, validateOnCreate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.qpid.server.queue.BaseQueue
getName, isDurable

Methods inherited from interface org.apache.qpid.server.store.TransactionLogResource
getId

Methods inherited from interface org.apache.qpid.server.message.MessageDestination
getName

- Field Detail
  - SHARED_MSG_GROUP_ARG_VALUE
```
public static final String SHARED_MSG_GROUP_ARG_VALUE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractQueue
```
protected AbstractQueue(Map<String,Object> attributes,
                        VirtualHostImpl virtualHost)
```
- Method Detail
  - onCreate
```
protected void onCreate()
```
    Overrides:
    
    onCreate in class AbstractConfiguredObject<X extends AbstractQueue<X>>
  - onValidate
```
public void onValidate()
```
    Description copied from class: AbstractConfiguredObject
    
    Validation performed for configured object creation and opening.
    
    Overrides:
    
    onValidate in class AbstractConfiguredObject<X extends AbstractQueue<X>>
  - onOpen
```
protected void onOpen()
```
    Overrides:
    
    onOpen in class AbstractConfiguredObject<X extends AbstractQueue<X>>
  - getCreatedLogMessage
```
protected LogMessage getCreatedLogMessage()
```
  - execute
```
public void execute(String name,
                    Runnable runnable,
                    AccessControlContext context)
```
  - isExclusive
```
public boolean isExclusive()
```
    Specified by:
    
    isExclusive in interface AMQQueue<X extends AbstractQueue<X>>
  - getAlternateExchange
```
public Exchange<?> getAlternateExchange()
```
    Specified by:
    
    getAlternateExchange in interface Queue<X extends AbstractQueue<X>>
  - setAlternateExchange
```
public void setAlternateExchange(ExchangeImpl exchange)
```
  - getDefaultFilters
```
public Map<String,Map<String,List<String>>> getDefaultFilters()
```
    Specified by:
    
    getDefaultFilters in interface Queue<X extends AbstractQueue<X>>
  - getMessageDurability
```
public final MessageDurability getMessageDurability()
```
    Specified by:
    
    getMessageDurability in interface Queue<X extends AbstractQueue<X>>
    
    Specified by:
    
    getMessageDurability in interface TransactionLogResource
  - getMinimumMessageTtl
```
public long getMinimumMessageTtl()
```
    Specified by:
    
    getMinimumMessageTtl in interface Queue<X extends AbstractQueue<X>>
  - getMaximumMessageTtl
```
public long getMaximumMessageTtl()
```
    Specified by:
    
    getMaximumMessageTtl in interface Queue<X extends AbstractQueue<X>>
  - isEnsureNondestructiveConsumers
```
public boolean isEnsureNondestructiveConsumers()
```
    Specified by:
    
    isEnsureNondestructiveConsumers in interface Queue<X extends AbstractQueue<X>>
  - isHoldOnPublishEnabled
```
public boolean isHoldOnPublishEnabled()
```
    Specified by:
    
    isHoldOnPublishEnabled in interface Queue<X extends AbstractQueue<X>>
  - getAvailableAttributes
```
public Collection<String> getAvailableAttributes()
```
    Specified by:
    
    getAvailableAttributes in interface AMQQueue<X extends AbstractQueue<X>>
  - getOwner
```
public String getOwner()
```
    Specified by:
    
    getOwner in interface Queue<X extends AbstractQueue<X>>
  - getVirtualHost
```
public VirtualHostImpl getVirtualHost()
```
    Specified by:
    
    getVirtualHost in interface AMQQueue<X extends AbstractQueue<X>>
  - addConsumer
```
public org.apache.qpid.server.queue.QueueConsumerImpl addConsumer(ConsumerTarget target,
                                                                  FilterManager filters,
                                                                  Class<? extends ServerMessage> messageClass,
                                                                  String consumerName,
                                                                  EnumSet<ConsumerImpl.Option> optionSet)
                                                           throws MessageSource.ExistingExclusiveConsumer,
                                                                  MessageSource.ExistingConsumerPreventsExclusive,
                                                                  MessageSource.ConsumerAccessRefused
```
    Specified by:
    
    addConsumer in interface MessageSource
    
    Throws:
    
    MessageSource.ExistingExclusiveConsumer
    
    MessageSource.ExistingConsumerPreventsExclusive
    
    MessageSource.ConsumerAccessRefused
  - beforeClose
```
protected com.google.common.util.concurrent.ListenableFuture<Void> beforeClose()
```
    Overrides:
    
    beforeClose in class AbstractConfiguredObject<X extends AbstractQueue<X>>
  - getConsumers
```
public Collection<QueueConsumer<?>> getConsumers()
```
    Specified by:
    
    getConsumers in interface MessageSource
    
    Specified by:
    
    getConsumers in interface Queue<X extends AbstractQueue<X>>
    
    Specified by:
    
    getConsumers in interface AMQQueue<X extends AbstractQueue<X>>
  - resetSubPointersForGroups
```
public void resetSubPointersForGroups(QueueConsumer<?> consumer)
```
  - resetSubPointersForGroups
```
public void resetSubPointersForGroups(QueueEntry entry)
```
    Specified by:
    
    resetSubPointersForGroups in interface MessageGroupManager.ConsumerResetHelper
  - addBinding
```
public void addBinding(BindingImpl binding)
```
    Specified by:
    
    addBinding in interface AMQQueue<X extends AbstractQueue<X>>
  - removeBinding
```
public void removeBinding(BindingImpl binding)
```
    Specified by:
    
    removeBinding in interface AMQQueue<X extends AbstractQueue<X>>
  - getBindings
```
public Collection<BindingImpl> getBindings()
```
    Specified by:
    
    getBindings in interface Queue<X extends AbstractQueue<X>>
    
    Specified by:
    
    getBindings in interface AMQQueue<X extends AbstractQueue<X>>
  - getBindingCount
```
public int getBindingCount()
```
    Specified by:
    
    getBindingCount in interface Queue<X extends AbstractQueue<X>>
  - getLogSubject
```
public LogSubject getLogSubject()
```
    Specified by:
    
    getLogSubject in interface AMQQueue<X extends AbstractQueue<X>>
  - enqueue
```
public final void enqueue(ServerMessage message,
                          Action<? super MessageInstance> action,
                          MessageEnqueueRecord enqueueRecord)
```
    Specified by:
    
    enqueue in interface BaseQueue
  - recover
```
public final void recover(ServerMessage message,
                          MessageEnqueueRecord enqueueRecord)
```
    Specified by:
    
    recover in interface AMQQueue<X extends AbstractQueue<X>>
  - completeRecovery
```
public final void completeRecovery()
```
    Specified by:
    
    completeRecovery in interface AMQQueue<X extends AbstractQueue<X>>
  - doEnqueue
```
protected void doEnqueue(ServerMessage message,
                         Action<? super MessageInstance> action,
                         MessageEnqueueRecord enqueueRecord)
```
  - checkConsumersNotAheadOfDelivery
```
protected void checkConsumersNotAheadOfDelivery(QueueEntry entry)
```
  - setTargetSize
```
public void setTargetSize(long targetSize)
```
    Specified by:
    
    setTargetSize in interface AMQQueue<X extends AbstractQueue<X>>
  - getTotalDequeuedMessages
```
public long getTotalDequeuedMessages()
```
    Specified by:
    
    getTotalDequeuedMessages in interface Queue<X extends AbstractQueue<X>>
  - getTotalEnqueuedMessages
```
public long getTotalEnqueuedMessages()
```
    Specified by:
    
    getTotalEnqueuedMessages in interface Queue<X extends AbstractQueue<X>>
  - requeue
```
public void requeue(QueueEntry entry)
```
    Specified by:
    
    requeue in interface AMQQueue<X extends AbstractQueue<X>>
  - dequeue
```
public void dequeue(QueueEntry entry)
```
    Specified by:
    
    dequeue in interface AMQQueue<X extends AbstractQueue<X>>
  - resend
```
public boolean resend(QueueEntry entry,
                      QueueConsumer<?> consumer)
```
    Specified by:
    
    resend in interface AMQQueue<X extends AbstractQueue<X>>
  - getConsumerCount
```
public int getConsumerCount()
```
    Specified by:
    
    getConsumerCount in interface Queue<X extends AbstractQueue<X>>
  - getConsumerCountWithCredit
```
public int getConsumerCountWithCredit()
```
    Specified by:
    
    getConsumerCountWithCredit in interface Queue<X extends AbstractQueue<X>>
  - isUnused
```
public boolean isUnused()
```
    Specified by:
    
    isUnused in interface AMQQueue<X extends AbstractQueue<X>>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface AMQQueue<X extends AbstractQueue<X>>
  - getQueueDepthMessages
```
public int getQueueDepthMessages()
```
    Specified by:
    
    getQueueDepthMessages in interface Queue<X extends AbstractQueue<X>>
  - getQueueDepthBytes
```
public long getQueueDepthBytes()
```
    Specified by:
    
    getQueueDepthBytes in interface Queue<X extends AbstractQueue<X>>
  - getUndeliveredMessageCount
```
public int getUndeliveredMessageCount()
```
  - getReceivedMessageCount
```
public long getReceivedMessageCount()
```
  - getOldestMessageArrivalTime
```
public long getOldestMessageArrivalTime()
```
    Specified by:
    
    getOldestMessageArrivalTime in interface AMQQueue<X extends AbstractQueue<X>>
  - getOldestMessageAge
```
public long getOldestMessageAge()
```
    Specified by:
    
    getOldestMessageAge in interface Queue<X extends AbstractQueue<X>>
  - isDeleted
```
public boolean isDeleted()
```
    Specified by:
    
    isDeleted in interface AMQQueue<X extends AbstractQueue<X>>
    
    Specified by:
    
    isDeleted in interface BaseQueue
  - getMessagesOnTheQueue
```
public List<QueueEntry> getMessagesOnTheQueue()
```
    Specified by:
    
    getMessagesOnTheQueue in interface AMQQueue<X extends AbstractQueue<X>>
  - stateChanged
```
public void stateChanged(QueueConsumer<?> sub,
                         State oldState,
                         State newState)
```
    Specified by:
    
    stateChanged in interface StateChangeListener<QueueConsumer<?>,State>
  - compareTo
```
public int compareTo(AMQQueue o)
```
    Specified by:
    
    compareTo in interface Comparable<AMQQueue>
  - getAtomicQueueCount
```
public AtomicInteger getAtomicQueueCount()
```
  - getAtomicQueueSize
```
public AtomicLong getAtomicQueueSize()
```
  - getConsumerList
```
protected org.apache.qpid.server.queue.QueueConsumerList getConsumerList()
```
  - getEventLogger
```
public EventLogger getEventLogger()
```
  - getMessagesOnTheQueue
```
public List<QueueEntry> getMessagesOnTheQueue(long fromMessageId,
                                              long toMessageId)
```
  - getMessageOnTheQueue
```
public QueueEntry getMessageOnTheQueue(long messageId)
```
    Specified by:
    
    getMessageOnTheQueue in interface AMQQueue<X extends AbstractQueue<X>>
  - getMessagesOnTheQueue
```
public List<QueueEntry> getMessagesOnTheQueue(AbstractQueue.QueueEntryFilter filter)
```
  - visit
```
public void visit(QueueEntryVisitor visitor)
```
    Specified by:
    
    visit in interface Queue<X extends AbstractQueue<X>>
  - getMessagesRangeOnTheQueue
```
public List<QueueEntry> getMessagesRangeOnTheQueue(long fromPosition,
                                                   long toPosition)
```
    Returns a list of QueueEntries 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.
    
    Specified by:
    
    getMessagesRangeOnTheQueue in interface AMQQueue<X extends AbstractQueue<X>>
    
    Parameters:
    
    fromPosition - first message position
    
    toPosition - last message position
    
    Returns:
    
    list of messages
  - clearQueue
```
public long clearQueue()
```
    Specified by:
    
    clearQueue in interface Queue<X extends AbstractQueue<X>>
    
    Specified by:
    
    clearQueue in interface AMQQueue<X extends AbstractQueue<X>>
  - addDeleteTask
```
public void addDeleteTask(Action<? super AMQQueue> task)
```
    Specified by:
    
    addDeleteTask in interface Deletable<AMQQueue>
  - removeDeleteTask
```
public void removeDeleteTask(Action<? super AMQQueue> task)
```
    Specified by:
    
    removeDeleteTask in interface Deletable<AMQQueue>
  - deleteAndReturnCount
```
public com.google.common.util.concurrent.ListenableFuture<Integer> deleteAndReturnCount()
```
    Specified by:
    
    deleteAndReturnCount in interface Queue<X extends AbstractQueue<X>>
  - onClose
```
protected void onClose()
```
    Overrides:
    
    onClose in class AbstractConfiguredObject<X extends AbstractQueue<X>>
  - checkCapacity
```
public void checkCapacity(AMQSessionModel channel)
```
    Specified by:
    
    checkCapacity in interface CapacityChecker
  - deliverAsync
```
public void deliverAsync()
```
    Specified by:
    
    deliverAsync in interface AMQQueue<X extends AbstractQueue<X>>
  - advanceAllConsumers
```
protected void advanceAllConsumers()
```
  - isEntryAheadOfConsumer
```
public boolean isEntryAheadOfConsumer(QueueEntry entry,
                                      QueueConsumer<?> sub)
```
    Specified by:
    
    isEntryAheadOfConsumer in interface MessageGroupManager.ConsumerResetHelper
  - processQueue
```
public long processQueue(QueueRunner runner)
```
    Used by queue Runners to asynchronously deliver messages to consumers. A queue Runner is started whenever a state change occurs, e.g when a new message arrives on the queue and cannot be immediately delivered to a consumer (i.e. asynchronous delivery is required). processQueue should be running while there are messages on the queue AND there are consumers that can deliver them. If there are no consumers capable of delivering the remaining messages on the queue then processQueue should stop to prevent spinning. Since processQueue is runs in a fixed size Executor, it should not run indefinitely to prevent starving other tasks of CPU (e.g jobs to process incoming messages may not be able to be scheduled in the thread pool because all threads are working on clearing down large queues). To solve this problem, after an arbitrary number of message deliveries the processQueue job stops iterating, resubmits itself to the executor, and ends the current instance
    
    Parameters:
    
    runner - the Runner to schedule
  - checkMessageStatus
```
public void checkMessageStatus()
```
    Description copied from interface: AMQQueue
    
    Checks the status of messages on the queue, purging expired ones, firing age related alerts etc.
    
    Specified by:
    
    checkMessageStatus in interface AMQQueue<X extends AbstractQueue<X>>
  - getPotentialMemoryFootprint
```
public long getPotentialMemoryFootprint()
```
    Specified by:
    
    getPotentialMemoryFootprint in interface AMQQueue<X extends AbstractQueue<X>>
  - getAlertRepeatGap
```
public long getAlertRepeatGap()
```
    Specified by:
    
    getAlertRepeatGap in interface Queue<X extends AbstractQueue<X>>
  - getAlertThresholdMessageAge
```
public long getAlertThresholdMessageAge()
```
    Specified by:
    
    getAlertThresholdMessageAge in interface Queue<X extends AbstractQueue<X>>
  - getAlertThresholdQueueDepthMessages
```
public long getAlertThresholdQueueDepthMessages()
```
    Specified by:
    
    getAlertThresholdQueueDepthMessages in interface Queue<X extends AbstractQueue<X>>
  - getAlertThresholdQueueDepthBytes
```
public long getAlertThresholdQueueDepthBytes()
```
    Specified by:
    
    getAlertThresholdQueueDepthBytes in interface Queue<X extends AbstractQueue<X>>
  - getAlertThresholdMessageSize
```
public long getAlertThresholdMessageSize()
```
    Specified by:
    
    getAlertThresholdMessageSize in interface Queue<X extends AbstractQueue<X>>
  - getQueueFlowControlSizeBytes
```
public long getQueueFlowControlSizeBytes()
```
    Specified by:
    
    getQueueFlowControlSizeBytes in interface Queue<X extends AbstractQueue<X>>
  - getQueueFlowResumeSizeBytes
```
public long getQueueFlowResumeSizeBytes()
```
    Specified by:
    
    getQueueFlowResumeSizeBytes in interface Queue<X extends AbstractQueue<X>>
  - getNotificationChecks
```
public Set<NotificationCheck> getNotificationChecks()
```
    Specified by:
    
    getNotificationChecks in interface AMQQueue<X extends AbstractQueue<X>>
  - getMessagesOnTheQueue
```
public List<Long> getMessagesOnTheQueue(int num)
```
    Specified by:
    
    getMessagesOnTheQueue in interface AMQQueue<X extends AbstractQueue<X>>
  - getMessagesOnTheQueue
```
public List<Long> getMessagesOnTheQueue(int num,
                                        int offset)
```
    Specified by:
    
    getMessagesOnTheQueue in interface AMQQueue<X extends AbstractQueue<X>>
  - getTotalEnqueuedBytes
```
public long getTotalEnqueuedBytes()
```
    Specified by:
    
    getTotalEnqueuedBytes in interface Queue<X extends AbstractQueue<X>>
  - getTotalDequeuedBytes
```
public long getTotalDequeuedBytes()
```
    Specified by:
    
    getTotalDequeuedBytes in interface Queue<X extends AbstractQueue<X>>
  - getPersistentEnqueuedBytes
```
public long getPersistentEnqueuedBytes()
```
    Specified by:
    
    getPersistentEnqueuedBytes in interface Queue<X extends AbstractQueue<X>>
  - getPersistentDequeuedBytes
```
public long getPersistentDequeuedBytes()
```
    Specified by:
    
    getPersistentDequeuedBytes in interface Queue<X extends AbstractQueue<X>>
  - getPersistentEnqueuedMessages
```
public long getPersistentEnqueuedMessages()
```
    Specified by:
    
    getPersistentEnqueuedMessages in interface Queue<X extends AbstractQueue<X>>
  - getPersistentDequeuedMessages
```
public long getPersistentDequeuedMessages()
```
    Specified by:
    
    getPersistentDequeuedMessages in interface Queue<X extends AbstractQueue<X>>
  - isHeld
```
public boolean isHeld(QueueEntry queueEntry,
                      long evaluationTime)
```
    Specified by:
    
    isHeld in interface Queue<X extends AbstractQueue<X>>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractConfiguredObject<X extends AbstractQueue<X>>
  - getUnacknowledgedMessages
```
public long getUnacknowledgedMessages()
```
    Specified by:
    
    getUnacknowledgedMessages in interface Queue<X extends AbstractQueue<X>>
  - getUnacknowledgedBytes
```
public long getUnacknowledgedBytes()
```
    Specified by:
    
    getUnacknowledgedBytes in interface Queue<X extends AbstractQueue<X>>
  - decrementUnackedMsgCount
```
public void decrementUnackedMsgCount(QueueEntry queueEntry)
```
    Specified by:
    
    decrementUnackedMsgCount in interface AMQQueue<X extends AbstractQueue<X>>
  - incrementUnackedMsgCount
```
public void incrementUnackedMsgCount(QueueEntry entry)
```
    Specified by:
    
    incrementUnackedMsgCount in interface AMQQueue<X extends AbstractQueue<X>>
  - getMaximumDeliveryAttempts
```
public int getMaximumDeliveryAttempts()
```
    Specified by:
    
    getMaximumDeliveryAttempts in interface Queue<X extends AbstractQueue<X>>
  - setNotificationListener
```
public void setNotificationListener(QueueNotificationListener listener)
```
    Specified by:
    
    setNotificationListener in interface Queue<X extends AbstractQueue<X>>
    
    Specified by:
    
    setNotificationListener in interface AMQQueue<X extends AbstractQueue<X>>
  - send
```
public final <M extends ServerMessage<? extends StorableMessageMetaData>> int send(M message,
                                                                                   String routingAddress,
                                                                                   InstanceProperties instanceProperties,
                                                                                   ServerTransaction txn,
                                                                                   Action<? super MessageInstance> postEnqueueAction)
```
    Description copied from interface: MessageDestination
    
    Routes a message
    
    Specified by:
    
    send in interface MessageDestination
    
    Parameters:
    
    message - the message to be routed
    
    instanceProperties - the instance properties
    
    txn - the transaction to enqueue within
    
    postEnqueueAction - action to perform on the result of every enqueue (may be null)
    
    Returns:
    
    the number of queues in which the message was enqueued performed
  - verifySessionAccess
```
public boolean verifySessionAccess(AMQSessionModel<?> session)
```
    Specified by:
    
    verifySessionAccess in interface MessageSource
  - getExclusive
```
public ExclusivityPolicy getExclusive()
```
    Specified by:
    
    getExclusive in interface Queue<X extends AbstractQueue<X>>
  - isNoLocal
```
public boolean isNoLocal()
```
    Specified by:
    
    isNoLocal in interface Queue<X extends AbstractQueue<X>>
  - getMessageGroupKey
```
public String getMessageGroupKey()
```
    Specified by:
    
    getMessageGroupKey in interface Queue<X extends AbstractQueue<X>>
  - isMessageGroupSharedGroups
```
public boolean isMessageGroupSharedGroups()
```
    Specified by:
    
    isMessageGroupSharedGroups in interface Queue<X extends AbstractQueue<X>>
  - getMessageGroupDefaultGroup
```
public String getMessageGroupDefaultGroup()
```
    Specified by:
    
    getMessageGroupDefaultGroup in interface Queue<X extends AbstractQueue<X>>
  - getMaximumDistinctGroups
```
public int getMaximumDistinctGroups()
```
    Specified by:
    
    getMaximumDistinctGroups in interface Queue<X extends AbstractQueue<X>>
  - isQueueFlowStopped
```
public boolean isQueueFlowStopped()
```
    Specified by:
    
    isQueueFlowStopped in interface Queue<X extends AbstractQueue<X>>
  - getChildren
```
public <C extends ConfiguredObject> Collection<C> getChildren(Class<C> clazz)
```
    Description copied from interface: ConfiguredObject
    
    Return children of the ConfiguredObject of the given class
    
    Specified by:
    
    getChildren in interface ConfiguredObject<X extends AbstractQueue<X>>
    
    Overrides:
    
    getChildren in class AbstractConfiguredObject<X extends AbstractQueue<X>>
    
    Parameters:
    
    clazz - the class of the children to return
    
    Returns:
    
    the children
  - addChildAsync
```
protected <C extends ConfiguredObject> com.google.common.util.concurrent.ListenableFuture<C> addChildAsync(Class<C> childClass,
                                                                                                           Map<String,Object> attributes,
                                                                                                           ConfiguredObject... otherParents)
```
    Overrides:
    
    addChildAsync in class AbstractConfiguredObject<X extends AbstractQueue<X>>
  - changeAttribute
```
public boolean changeAttribute(String name,
                               Object expected,
                               Object desired)
                        throws IllegalStateException,
                               AccessControlException,
                               IllegalArgumentException
```
    Overrides:
    
    changeAttribute in class AbstractConfiguredObject<X extends AbstractQueue<X>>
    
    Throws:
    
    IllegalStateException
    
    AccessControlException
    
    IllegalArgumentException
  - validateChange
```
protected void validateChange(ConfiguredObject<?> proxyForValidation,
                              Set<String> changedAttributes)
```
    Overrides:
    
    validateChange in class AbstractConfiguredObject<X extends AbstractQueue<X>>
  - moveMessages
```
public List<Long> moveMessages(Queue<?> destination,
                               List<Long> messageIds,
                               String selector,
                               int limit)
```
    Specified by:
    
    moveMessages in interface Queue<X extends AbstractQueue<X>>
  - copyMessages
```
public List<Long> copyMessages(Queue<?> destination,
                               List<Long> messageIds,
                               String selector,
                               int limit)
```
    Specified by:
    
    copyMessages in interface Queue<X extends AbstractQueue<X>>
  - deleteMessages
```
public List<Long> deleteMessages(List<Long> messageIds,
                                 String selector,
                                 int limit)
```
    Specified by:
    
    deleteMessages in interface Queue<X extends AbstractQueue<X>>
  - getMessageContent
```
public Content getMessageContent(long messageId)
```
    Specified by:
    
    getMessageContent in interface Queue<X extends AbstractQueue<X>>
  - getMessageInfo
```
public List<MessageInfo> getMessageInfo(int first,
                                        int last)
```
    Specified by:
    
    getMessageInfo in interface Queue<X extends AbstractQueue<X>>
  - getMessageInfoById
```
public MessageInfo getMessageInfoById(long messageId)
```
    Specified by:
    
    getMessageInfoById in interface Queue<X extends AbstractQueue<X>>

Class AbstractQueue<X extends AbstractQueue<X>>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

Nested classes/interfaces inherited from interface org.apache.qpid.server.message.MessageSource

Field Summary

Fields inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

Fields inherited from interface org.apache.qpid.server.model.Queue

Fields inherited from interface org.apache.qpid.server.model.ConfiguredObject

Constructor Summary

Method Summary

Methods inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.qpid.server.model.ConfiguredObject

Methods inherited from interface org.apache.qpid.server.queue.BaseQueue

Methods inherited from interface org.apache.qpid.server.store.TransactionLogResource

Methods inherited from interface org.apache.qpid.server.message.MessageDestination

Field Detail

SHARED_MSG_GROUP_ARG_VALUE

Constructor Detail

AbstractQueue

Method Detail

onCreate

onValidate

onOpen

getCreatedLogMessage

execute

isExclusive

getAlternateExchange

setAlternateExchange

getDefaultFilters

getMessageDurability

getMinimumMessageTtl

getMaximumMessageTtl

isEnsureNondestructiveConsumers

isHoldOnPublishEnabled

getAvailableAttributes

getOwner

getVirtualHost

addConsumer

beforeClose

getConsumers

resetSubPointersForGroups

resetSubPointersForGroups

addBinding

removeBinding

getBindings

getBindingCount

getLogSubject

enqueue

recover

completeRecovery

doEnqueue

checkConsumersNotAheadOfDelivery

setTargetSize

getTotalDequeuedMessages

getTotalEnqueuedMessages

requeue

dequeue

resend

getConsumerCount

getConsumerCountWithCredit

isUnused

isEmpty

getQueueDepthMessages

getQueueDepthBytes

getUndeliveredMessageCount

getReceivedMessageCount

getOldestMessageArrivalTime

getOldestMessageAge

isDeleted

getMessagesOnTheQueue

stateChanged

compareTo

getAtomicQueueCount

getAtomicQueueSize

getConsumerList

getEventLogger

getMessagesOnTheQueue

getMessageOnTheQueue

getMessagesOnTheQueue