Package org.apache.qpid.server.model
Interface Queue<X extends Queue<X>>
-
- All Superinterfaces:
BaseQueue
,Comparable<X>
,ConfiguredObject<X>
,ContextProvider
,Deletable<X>
,DestinationReferrer
,MessageDestination
,MessageNode
,MessageSource
,PermissionedObject
,TaskExecutorProvider
,TransactionLogResource
- All Known Subinterfaces:
LastValueQueue<X>
,PriorityQueue<X>
,SortedQueue<X>
,StandardQueue<X>
- All Known Implementing Classes:
AbstractQueue
,LastValueQueueImpl
,OutOfOrderQueue
,PriorityQueueImpl
,SortedQueueImpl
,StandardQueueImpl
public interface Queue<X extends Queue<X>> extends ConfiguredObject<X>, Comparable<X>, DestinationReferrer, BaseQueue, MessageSource, MessageDestination, Deletable<X>
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Queue.BehaviourOnUnknownDeclareArgument
static class
Queue.ExpiryPolicy
-
Nested classes/interfaces inherited from interface org.apache.qpid.server.message.MessageSource
MessageSource.ConsumerAccessRefused, MessageSource.ExistingConsumerPreventsExclusive, MessageSource.ExistingExclusiveConsumer, MessageSource.MessageConversionExceptionHandlingPolicy, MessageSource.QueueDeleted
-
-
Field Summary
-
Fields inherited from interface org.apache.qpid.server.model.ConfiguredObject
AWAIT_ATTAINMENT_TIMEOUT, CONTEXT, CREATED_BY, CREATED_TIME, DEFAULT_AWAIT_ATTAINMENT_TIMEOUT, DESCRIPTION, DESIRED_STATE, DURABLE, ID, LAST_UPDATED_BY, LAST_UPDATED_TIME, LIFETIME_POLICY, NAME, OVER_SIZED_ATTRIBUTE_ALTERNATIVE_TEXT, STATE, TYPE
-
-
Method Summary
-
Methods inherited from interface java.lang.Comparable
compareTo
-
Methods inherited from interface org.apache.qpid.server.model.ConfiguredObject
addChangeListener, asObjectRecord, authorise, authorise, authorise, close, closeAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, findConfiguredObject, getActualAttributes, getAttainedChildById, getAttainedChildByName, getAttribute, getAttributeNames, getCategoryClass, getChildById, getChildByName, getChildExecutor, getChildren, getContext, getCreatedBy, getCreatedTime, getDescription, getDesiredState, getId, getLastOpenedTime, getLastUpdatedBy, getLastUpdatedTime, getLifetimePolicy, getModel, getName, getObjectFactory, getParent, getState, getStatistics, getStatistics, getType, getTypeClass, getUserPreferences, hasEncrypter, isDurable, managesChildStorage, newToken, open, openAsync, removeChangeListener, removeContextVariable, setAttributes, setAttributesAsync, setContextVariable, setUserPreferences
-
Methods inherited from interface org.apache.qpid.server.model.ContextProvider
getContextKeys, getContextValue, getContextValue
-
Methods inherited from interface org.apache.qpid.server.util.Deletable
addDeleteTask, removeDeleteTask
-
Methods inherited from interface org.apache.qpid.server.message.MessageDestination
addReference, authorisePublish, getAddressSpace, getAlternateBindingDestination, getName, isDurable, linkAdded, linkRemoved, removeReference, route
-
Methods inherited from interface org.apache.qpid.server.message.MessageSource
addConsumer, close, verifySessionAccess
-
Methods inherited from interface org.apache.qpid.server.model.TaskExecutorProvider
getTaskExecutor
-
Methods inherited from interface org.apache.qpid.server.store.TransactionLogResource
getId, getName
-
-
-
-
Field Detail
-
CLASS_DESCRIPTION
static final String CLASS_DESCRIPTION
- See Also:
- Constant Field Values
-
ALERT_REPEAT_GAP
static final String ALERT_REPEAT_GAP
- See Also:
- Constant Field Values
-
ALERT_THRESHOLD_MESSAGE_AGE
static final String ALERT_THRESHOLD_MESSAGE_AGE
- See Also:
- Constant Field Values
-
ALERT_THRESHOLD_MESSAGE_SIZE
static final String ALERT_THRESHOLD_MESSAGE_SIZE
- See Also:
- Constant Field Values
-
ALERT_THRESHOLD_QUEUE_DEPTH_BYTES
static final String ALERT_THRESHOLD_QUEUE_DEPTH_BYTES
- See Also:
- Constant Field Values
-
ALERT_THRESHOLD_QUEUE_DEPTH_MESSAGES
static final String ALERT_THRESHOLD_QUEUE_DEPTH_MESSAGES
- See Also:
- Constant Field Values
-
ALTERNATE_BINDING
static final String ALTERNATE_BINDING
- See Also:
- Constant Field Values
-
EXCLUSIVE
static final String EXCLUSIVE
- See Also:
- Constant Field Values
-
MESSAGE_DURABILITY
static final String MESSAGE_DURABILITY
- See Also:
- Constant Field Values
-
MESSAGE_GROUP_KEY_OVERRIDE
static final String MESSAGE_GROUP_KEY_OVERRIDE
- See Also:
- Constant Field Values
-
MESSAGE_GROUP_TYPE
static final String MESSAGE_GROUP_TYPE
- See Also:
- Constant Field Values
-
MESSAGE_GROUP_DEFAULT_GROUP
static final String MESSAGE_GROUP_DEFAULT_GROUP
- See Also:
- Constant Field Values
-
MAXIMUM_DELIVERY_ATTEMPTS
static final String MAXIMUM_DELIVERY_ATTEMPTS
- See Also:
- Constant Field Values
-
NO_LOCAL
static final String NO_LOCAL
- See Also:
- Constant Field Values
-
OWNER
static final String OWNER
- See Also:
- Constant Field Values
-
CREATING_LINK_INFO
static final String CREATING_LINK_INFO
- See Also:
- Constant Field Values
-
QUEUE_FLOW_STOPPED
static final String QUEUE_FLOW_STOPPED
- See Also:
- Constant Field Values
-
MAXIMUM_MESSAGE_TTL
static final String MAXIMUM_MESSAGE_TTL
- See Also:
- Constant Field Values
-
MINIMUM_MESSAGE_TTL
static final String MINIMUM_MESSAGE_TTL
- See Also:
- Constant Field Values
-
DEFAULT_FILTERS
static final String DEFAULT_FILTERS
- See Also:
- Constant Field Values
-
ENSURE_NONDESTRUCTIVE_CONSUMERS
static final String ENSURE_NONDESTRUCTIVE_CONSUMERS
- See Also:
- Constant Field Values
-
HOLD_ON_PUBLISH_ENABLED
static final String HOLD_ON_PUBLISH_ENABLED
- See Also:
- Constant Field Values
-
OVERFLOW_POLICY
static final String OVERFLOW_POLICY
- See Also:
- Constant Field Values
-
MAXIMUM_QUEUE_DEPTH_MESSAGES
static final String MAXIMUM_QUEUE_DEPTH_MESSAGES
- See Also:
- Constant Field Values
-
MAXIMUM_QUEUE_DEPTH_BYTES
static final String MAXIMUM_QUEUE_DEPTH_BYTES
- See Also:
- Constant Field Values
-
EXPIRY_POLICY
static final String EXPIRY_POLICY
- See Also:
- Constant Field Values
-
MAXIMUM_LIVE_CONSUMERS
static final String MAXIMUM_LIVE_CONSUMERS
- See Also:
- Constant Field Values
-
QUEUE_SCAVANGE_COUNT
static final String QUEUE_SCAVANGE_COUNT
- See Also:
- Constant Field Values
-
DEFAULT_QUEUE_SCAVANGE_COUNT
static final int DEFAULT_QUEUE_SCAVANGE_COUNT
- See Also:
- Constant Field Values
-
MIME_TYPE_TO_FILE_EXTENSION
static final String MIME_TYPE_TO_FILE_EXTENSION
- See Also:
- Constant Field Values
-
DEFAULT_MIME_TYPE_TO_FILE_EXTENSION
static final String DEFAULT_MIME_TYPE_TO_FILE_EXTENSION
- See Also:
- Constant Field Values
-
QUEUE_DEFAULT_ALTERNATE_BINDING
static final String QUEUE_DEFAULT_ALTERNATE_BINDING
- See Also:
- Constant Field Values
-
DEFAULT_ALTERNATE_BINDING
static final String DEFAULT_ALTERNATE_BINDING
- See Also:
- Constant Field Values
-
QUEUE_DEFAULT_EXCLUSIVITY_POLICY
static final String QUEUE_DEFAULT_EXCLUSIVITY_POLICY
- See Also:
- Constant Field Values
-
DEFAULT_EXCLUSIVITY
static final String DEFAULT_EXCLUSIVITY
- See Also:
- Constant Field Values
-
DEFAULT_ENSURE_NON_DESTRUCTIVE_CONSUMERS
static final String DEFAULT_ENSURE_NON_DESTRUCTIVE_CONSUMERS
- See Also:
- Constant Field Values
-
MESSAGE_CONVERSION_EXCEPTION_HANDLING_POLICY
static final String MESSAGE_CONVERSION_EXCEPTION_HANDLING_POLICY
- See Also:
- Constant Field Values
-
DEFAULT_MESSAGE_CONVERSION_EXCEPTION_HANDLING_POLICY
static final MessageSource.MessageConversionExceptionHandlingPolicy DEFAULT_MESSAGE_CONVERSION_EXCEPTION_HANDLING_POLICY
-
UNKNOWN_QUEUE_DECLARE_ARGUMENT_BEHAVIOUR_NAME
static final String UNKNOWN_QUEUE_DECLARE_ARGUMENT_BEHAVIOUR_NAME
- See Also:
- Constant Field Values
-
ON_UNKNOWN_QUEUE_DECLARE_OPTION
static final Queue.BehaviourOnUnknownDeclareArgument ON_UNKNOWN_QUEUE_DECLARE_OPTION
-
DEFAULT_SHARED_MESSAGE_GROUP
static final String DEFAULT_SHARED_MESSAGE_GROUP
- See Also:
- Constant Field Values
-
DEFAULT_MAXIMUM_DISTINCT_GROUPS
static final int DEFAULT_MAXIMUM_DISTINCT_GROUPS
- See Also:
- Constant Field Values
-
DEFAULT_MESSAGE_GROUP_TYPE
static final MessageGroupType DEFAULT_MESSAGE_GROUP_TYPE
-
DEFAULT_MAXIMUM_DELIVERY_ATTEMPTS
static final int DEFAULT_MAXIMUM_DELIVERY_ATTEMPTS
- See Also:
- Constant Field Values
-
QUEUE_FLOW_RESUME_LIMIT
static final String QUEUE_FLOW_RESUME_LIMIT
- See Also:
- Constant Field Values
-
DEFAULT_FLOW_CONTROL_RESUME_LIMIT
static final double DEFAULT_FLOW_CONTROL_RESUME_LIMIT
- See Also:
- Constant Field Values
-
DEFAULT_ALERT_THRESHOLD_MESSAGE_AGE
static final long DEFAULT_ALERT_THRESHOLD_MESSAGE_AGE
- See Also:
- Constant Field Values
-
DEFAULT_ALERT_THRESHOLD_MESSAGE_SIZE
static final long DEFAULT_ALERT_THRESHOLD_MESSAGE_SIZE
- See Also:
- Constant Field Values
-
DEFAULT_ALERT_THRESHOLD_QUEUE_DEPTH
static final long DEFAULT_ALERT_THRESHOLD_QUEUE_DEPTH
- See Also:
- Constant Field Values
-
DEFAULT_ALERT_THRESHOLD_MESSAGE_COUNT
static final long DEFAULT_ALERT_THRESHOLD_MESSAGE_COUNT
- See Also:
- Constant Field Values
-
DEFAULT_ALERT_REPEAT_GAP
static final long DEFAULT_ALERT_REPEAT_GAP
- See Also:
- Constant Field Values
-
DEFAULT_MESSAGE_DURABILTY
static final String DEFAULT_MESSAGE_DURABILTY
- See Also:
- Constant Field Values
-
DEFAULT_MINIMUM_MESSAGE_TTL
static final long DEFAULT_MINIMUM_MESSAGE_TTL
- See Also:
- Constant Field Values
-
DEFAULT_MAXIMUM_MESSAGE_TTL
static final long DEFAULT_MAXIMUM_MESSAGE_TTL
- See Also:
- Constant Field Values
-
DEFAULT_HOLD_ON_PUBLISH_ENABLED
static final boolean DEFAULT_HOLD_ON_PUBLISH_ENABLED
- See Also:
- Constant Field Values
-
DEFAULT_MAXIMUM_QUEUE_DEPTH_MESSAGES
static final long DEFAULT_MAXIMUM_QUEUE_DEPTH_MESSAGES
- See Also:
- Constant Field Values
-
DEFAULT_MAXIMUM_QUEUE_DEPTH_BYTES
static final long DEFAULT_MAXIMUM_QUEUE_DEPTH_BYTES
- See Also:
- Constant Field Values
-
DEFAULT_OVERFLOW_POLICY
static final OverflowPolicy DEFAULT_OVERFLOW_POLICY
-
DEFAULT_EXPIRY_POLICY
static final Queue.ExpiryPolicy DEFAULT_EXPIRY_POLICY
-
DEFAULT_MAXIMUM_LIVE_CONSUMERS
static final int DEFAULT_MAXIMUM_LIVE_CONSUMERS
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAlternateBinding
AlternateBinding getAlternateBinding()
-
getExclusive
ExclusivityPolicy getExclusive()
-
isEnsureNondestructiveConsumers
boolean isEnsureNondestructiveConsumers()
-
getOwner
String getOwner()
-
getCreatingLinkInfo
CreatingLinkInfo getCreatingLinkInfo()
-
isNoLocal
boolean isNoLocal()
-
getMessageGroupKeyOverride
String getMessageGroupKeyOverride()
-
getMessageGroupDefaultGroup
String getMessageGroupDefaultGroup()
-
getMaximumDistinctGroups
int getMaximumDistinctGroups()
-
getMessageGroupType
MessageGroupType getMessageGroupType()
-
getMaximumDeliveryAttempts
int getMaximumDeliveryAttempts()
-
isQueueFlowStopped
boolean isQueueFlowStopped()
-
getMessageConversionExceptionHandlingPolicy
MessageSource.MessageConversionExceptionHandlingPolicy getMessageConversionExceptionHandlingPolicy()
- Specified by:
getMessageConversionExceptionHandlingPolicy
in interfaceMessageSource
-
getAlertThresholdMessageAge
long getAlertThresholdMessageAge()
-
getAlertThresholdMessageSize
long getAlertThresholdMessageSize()
-
getAlertThresholdQueueDepthBytes
long getAlertThresholdQueueDepthBytes()
-
getAlertThresholdQueueDepthMessages
long getAlertThresholdQueueDepthMessages()
-
getAlertRepeatGap
long getAlertRepeatGap()
-
getMessageDurability
MessageDurability getMessageDurability()
- Specified by:
getMessageDurability
in interfaceTransactionLogResource
-
getMinimumMessageTtl
long getMinimumMessageTtl()
-
getMaximumMessageTtl
long getMaximumMessageTtl()
-
isHoldOnPublishEnabled
boolean isHoldOnPublishEnabled()
-
getMaximumQueueDepthMessages
long getMaximumQueueDepthMessages()
-
getMaximumQueueDepthBytes
long getMaximumQueueDepthBytes()
-
getOverflowPolicy
OverflowPolicy getOverflowPolicy()
-
getExpiryPolicy
Queue.ExpiryPolicy getExpiryPolicy()
-
getMaximumLiveConsumers
int getMaximumLiveConsumers()
-
getPublishingLinks
Collection<PublishingLink> getPublishingLinks()
-
getConsumers
Collection<QueueConsumer<?,?>> getConsumers()
- Specified by:
getConsumers
in interfaceMessageSource
-
visit
void visit(QueueEntryVisitor visitor)
-
deleteAndReturnCountAsync
com.google.common.util.concurrent.ListenableFuture<Integer> deleteAndReturnCountAsync()
-
deleteAndReturnCount
int deleteAndReturnCount()
-
setNotificationListener
void setNotificationListener(QueueNotificationListener listener)
-
getBindingCount
int getBindingCount()
-
getConsumerCount
int getConsumerCount()
-
getConsumerCountWithCredit
int getConsumerCountWithCredit()
-
getPersistentDequeuedBytes
long getPersistentDequeuedBytes()
-
getPersistentDequeuedMessages
long getPersistentDequeuedMessages()
-
getPersistentEnqueuedBytes
long getPersistentEnqueuedBytes()
-
getPersistentEnqueuedMessages
long getPersistentEnqueuedMessages()
-
getQueueDepthBytes
long getQueueDepthBytes()
-
getQueueDepthMessages
int getQueueDepthMessages()
-
getTotalDequeuedBytes
long getTotalDequeuedBytes()
-
getTotalDequeuedMessages
long getTotalDequeuedMessages()
-
getTotalEnqueuedBytes
long getTotalEnqueuedBytes()
-
getTotalEnqueuedMessages
long getTotalEnqueuedMessages()
-
getTotalExpiredBytes
long getTotalExpiredBytes()
-
getTotalExpiredMessages
long getTotalExpiredMessages()
-
getUnacknowledgedBytes
long getUnacknowledgedBytes()
-
getUnacknowledgedMessages
long getUnacknowledgedMessages()
-
getAvailableBytes
long getAvailableBytes()
-
getAvailableMessages
int getAvailableMessages()
-
getAvailableBytesHighWatermark
long getAvailableBytesHighWatermark()
-
getAvailableMessagesHighWatermark
int getAvailableMessagesHighWatermark()
-
getQueueDepthBytesHighWatermark
long getQueueDepthBytesHighWatermark()
-
getQueueDepthMessagesHighWatermark
int getQueueDepthMessagesHighWatermark()
-
getOldestMessageAge
long getOldestMessageAge()
-
getTotalMalformedBytes
long getTotalMalformedBytes()
-
getTotalMalformedMessages
long getTotalMalformedMessages()
-
resetStatistics
void resetStatistics()
-
getProducerCount
long getProducerCount()
-
moveMessages
List<Long> moveMessages(Queue<?> destination, List<Long> messageIds, String selector, int limit)
-
copyMessages
List<Long> copyMessages(Queue<?> destination, List<Long> messageIds, String selector, int limit)
-
clearQueue
long clearQueue()
-
getMessageContent
Content getMessageContent(long messageId, long limit, boolean returnJson, boolean decompressBeforeLimiting)
-
getMessageInfo
List<MessageInfo> getMessageInfo(int first, int last, boolean includeHeaders)
-
getMessageInfoById
MessageInfo getMessageInfoById(long messageId, boolean includeHeaders)
-
isExclusive
boolean isExclusive()
-
getLogSubject
LogSubject getLogSubject()
-
getVirtualHost
QueueManagingVirtualHost<?> getVirtualHost()
-
isUnused
boolean isUnused()
-
isEmpty
boolean isEmpty()
-
getOldestMessageArrivalTime
long getOldestMessageArrivalTime()
-
requeue
void requeue(QueueEntry entry)
-
getMessagesOnTheQueue
List<? extends QueueEntry> getMessagesOnTheQueue()
-
getMessageOnTheQueue
QueueEntry getMessageOnTheQueue(long messageId)
-
checkMessageStatus
void checkMessageStatus()
Checks the status of messages on the queue, purging expired ones, firing age related alerts etc.
-
reallocateMessages
void reallocateMessages()
-
getNotificationChecks
Set<NotificationCheck> getNotificationChecks()
-
getAvailableAttributes
Collection<String> getAvailableAttributes()
-
completeRecovery
void completeRecovery()
-
recover
void recover(ServerMessage<?> message, MessageEnqueueRecord enqueueRecord)
-
isHeld
boolean isHeld(QueueEntry queueEntry, long evaluationTime)
-
checkCapacity
void checkCapacity()
-
deleteEntry
void deleteEntry(QueueEntry entry)
-
getLeastSignificantOldestEntry
QueueEntry getLeastSignificantOldestEntry()
-
queueEntryIterator
QueueEntryIterator queueEntryIterator()
-
checkValid
boolean checkValid(QueueEntry queueEntry)
-
-