org.apache.qpid.server.queue

Interface AMQQueue<X extends AMQQueue<X>>

All Superinterfaces:

BaseQueue, CapacityChecker, Comparable<AMQQueue>, ConfiguredObject<X>, Deletable<AMQQueue>, ExchangeReferrer, MessageDestination, MessageNode, MessageSource, Queue<X>, TransactionLogResource

All Known Subinterfaces:

LastValueQueue<X>, PriorityQueue<X>, SortedQueue<X>, StandardQueue<X>

All Known Implementing Classes:

AbstractQueue, LastValueQueueImpl, OutOfOrderQueue, PriorityQueueImpl, SortedQueueImpl, StandardQueueImpl

public interface AMQQueue<X extends AMQQueue<X>>
extends Queue<X>, Comparable<AMQQueue>, ExchangeReferrer, BaseQueue, MessageSource, CapacityChecker, MessageDestination, Deletable<AMQQueue>

Nested Class Summary

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

MessageSource.ConsumerAccessRefused, MessageSource.ExistingConsumerPreventsExclusive, MessageSource.ExistingExclusiveConsumer

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	addBinding(BindingImpl binding)
void	checkMessageStatus() Checks the status of messages on the queue, purging expired ones, firing age related alerts etc.
long	clearQueue()
void	completeRecovery()
void	decrementUnackedMsgCount(QueueEntry queueEntry)
void	deliverAsync()
void	dequeue(QueueEntry entry)
Collection<String>	getAvailableAttributes()
Collection<BindingImpl>	getBindings()
Collection<QueueConsumer<?>>	getConsumers()
LogSubject	getLogSubject()
QueueEntry	getMessageOnTheQueue(long messageId)
List<? extends QueueEntry>	getMessagesOnTheQueue()
List<Long>	getMessagesOnTheQueue(int num)
List<Long>	getMessagesOnTheQueue(int num, int offset)
List<? extends 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.
Set<NotificationCheck>	getNotificationChecks()
long	getOldestMessageArrivalTime()
long	getPotentialMemoryFootprint()
VirtualHostImpl	getVirtualHost()
void	incrementUnackedMsgCount(QueueEntry entry)
boolean	isDeleted()
boolean	isEmpty()
boolean	isExclusive()
boolean	isUnused()
void	recover(ServerMessage<?> message, MessageEnqueueRecord enqueueRecord)
void	removeBinding(BindingImpl binding)
void	requeue(QueueEntry entry)
boolean	resend(QueueEntry entry, QueueConsumer<?> consumer)
void	setNotificationListener(QueueNotificationListener listener)
void	setTargetSize(long targetSize)

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

copyMessages, deleteAndReturnCount, deleteMessages, getAlertRepeatGap, getAlertThresholdMessageAge, getAlertThresholdMessageSize, getAlertThresholdQueueDepthBytes, getAlertThresholdQueueDepthMessages, getAlternateExchange, getBindingCount, getConsumerCount, getConsumerCountWithCredit, getDefaultFilters, getExclusive, getMaximumDeliveryAttempts, getMaximumDistinctGroups, getMaximumMessageTtl, getMessageContent, getMessageDurability, getMessageGroupDefaultGroup, getMessageGroupKey, getMessageInfo, getMessageInfoById, getMinimumMessageTtl, getOldestMessageAge, getOwner, getPersistentDequeuedBytes, getPersistentDequeuedMessages, getPersistentEnqueuedBytes, getPersistentEnqueuedMessages, getQueueDepthBytes, getQueueDepthMessages, getQueueFlowControlSizeBytes, getQueueFlowResumeSizeBytes, getTotalDequeuedBytes, getTotalDequeuedMessages, getTotalEnqueuedBytes, getTotalEnqueuedMessages, getUnacknowledgedBytes, getUnacknowledgedMessages, isEnsureNondestructiveConsumers, isHeld, isHoldOnPublishEnabled, isMessageGroupSharedGroups, isNoLocal, isQueueFlowStopped, moveMessages, visit

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

addChangeListener, asObjectRecord, close, closeAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, findConfiguredObject, getActualAttributes, getAttainedChildById, getAttainedChildByName, getAttribute, getAttributeNames, getCategoryClass, getChildById, getChildByName, getChildExecutor, getChildren, getContext, getContextKeys, getContextValue, getContextValue, getCreatedBy, getCreatedTime, getDescription, getDesiredState, getId, getLastOpenedTime, getLastUpdatedBy, getLastUpdatedTime, getLifetimePolicy, getModel, getName, getObjectFactory, getParent, getState, getStatistics, getTaskExecutor, getType, getTypeClass, isDurable, managesChildStorage, open, openAsync, removeChangeListener, setAttribute, setAttributes, setAttributesAsync

Methods inherited from interface java.lang.Comparable

compareTo

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

enqueue, getName, isDurable

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

addConsumer, verifySessionAccess

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

getId, getMessageDurability

Methods inherited from interface org.apache.qpid.server.protocol.CapacityChecker

checkCapacity

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

getName, send

Methods inherited from interface org.apache.qpid.server.util.Deletable

addDeleteTask, removeDeleteTask

Method Detail

isExclusive

boolean isExclusive()

addBinding

void addBinding(BindingImpl binding)

removeBinding

void removeBinding(BindingImpl binding)

getBindings

Collection<BindingImpl> getBindings()

Specified by:

getBindings in interface Queue<X extends AMQQueue<X>>

getLogSubject

LogSubject getLogSubject()

getVirtualHost

VirtualHostImpl getVirtualHost()

getConsumers

Collection<QueueConsumer<?>> getConsumers()

Specified by:

getConsumers in interface MessageSource

Specified by:

getConsumers in interface Queue<X extends AMQQueue<X>>

isUnused

boolean isUnused()

isEmpty

boolean isEmpty()

getOldestMessageArrivalTime

long getOldestMessageArrivalTime()

isDeleted

boolean isDeleted()

Specified by:

isDeleted in interface BaseQueue

requeue

void requeue(QueueEntry entry)

dequeue

void dequeue(QueueEntry entry)

decrementUnackedMsgCount

void decrementUnackedMsgCount(QueueEntry queueEntry)

incrementUnackedMsgCount

void incrementUnackedMsgCount(QueueEntry entry)

resend

boolean resend(QueueEntry entry,
               QueueConsumer<?> consumer)

getMessagesOnTheQueue

List<? extends QueueEntry> getMessagesOnTheQueue()

getMessagesOnTheQueue

List<Long> getMessagesOnTheQueue(int num)

getMessagesOnTheQueue

List<Long> getMessagesOnTheQueue(int num,
                                 int offset)

getMessageOnTheQueue

QueueEntry getMessageOnTheQueue(long messageId)

getMessagesRangeOnTheQueue

List<? extends 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:

clearQueue

long clearQueue()

Specified by:

clearQueue in interface Queue<X extends AMQQueue<X>>

checkMessageStatus

void checkMessageStatus()

Checks the status of messages on the queue, purging expired ones, firing age related alerts etc.

getNotificationChecks

Set<NotificationCheck> getNotificationChecks()

deliverAsync

void deliverAsync()

getAvailableAttributes

Collection<String> getAvailableAttributes()

setNotificationListener

void setNotificationListener(QueueNotificationListener listener)

Specified by:

setNotificationListener in interface Queue<X extends AMQQueue<X>>

completeRecovery

void completeRecovery()

recover

void recover(ServerMessage<?> message,
             MessageEnqueueRecord enqueueRecord)

setTargetSize

void setTargetSize(long targetSize)

getPotentialMemoryFootprint

long getPotentialMemoryFootprint()