QueueImpl (Red Hat JBoss Enterprise Application Platform 7.2.0.GA public API)

java.lang.Object
- org.apache.activemq.artemis.utils.critical.CriticalComponentImpl
- - org.apache.activemq.artemis.core.server.impl.QueueImpl

All Implemented Interfaces:

Bindable, Queue, CriticalComponent

Direct Known Subclasses:

LastValueQueue
```
public class QueueImpl
extends CriticalComponentImpl
implements Queue
```
Implementation of a Queue
Completely non blocking between adding to queue and delivering to consumers.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CHECK_QUEUE_SIZE_PERIOD`
`protected static int`	`CRITICAL_CONSUMER`
`protected static int`	`CRITICAL_DELIVER`
`protected static int`	`CRITICAL_PATH_ADD_HEAD`
`protected static int`	`CRITICAL_PATH_ADD_TAIL`
`protected static int`	`CRITICAL_PATHS`
`static int`	`DEFAULT_FLUSH_LIMIT`
`static int`	`DELIVERY_TIMEOUT` If The system gets slow for any reason, this is the maximum time a Delivery or or depage executor should be hanging on
`static int`	`MAX_DELIVERIES_IN_LOOP`
`static int`	`NUM_PRIORITIES`
`static int`	`REDISTRIBUTOR_BATCH_SIZE`

Fields inherited from interface org.apache.activemq.artemis.core.server.Queue
MAX_CONSUMERS_UNLIMITED

Constructor Summary

Constructors
Constructor and Description
QueueImpl(long id, SimpleString address, SimpleString name, Filter filter, PageSubscription pageSubscription, SimpleString user, boolean durable, boolean temporary, boolean autoCreated, RoutingType routingType, Integer maxConsumers, Boolean exclusive, Boolean purgeOnNoConsumers, ScheduledExecutorService scheduledExecutor, PostOffice postOffice, StorageManager storageManager, HierarchicalRepository<AddressSettings> addressSettingsRepository, ArtemisExecutor executor, ActiveMQServer server, QueueFactory factory)
QueueImpl(long id, SimpleString address, SimpleString name, Filter filter, PageSubscription pageSubscription, SimpleString user, boolean durable, boolean temporary, boolean autoCreated, RoutingType routingType, Integer maxConsumers, Boolean purgeOnNoConsumers, ScheduledExecutorService scheduledExecutor, PostOffice postOffice, StorageManager storageManager, HierarchicalRepository<AddressSettings> addressSettingsRepository, ArtemisExecutor executor, ActiveMQServer server, QueueFactory factory)
`QueueImpl(long id, SimpleString address, SimpleString name, Filter filter, PageSubscription pageSubscription, SimpleString user, boolean durable, boolean temporary, boolean autoCreated, ScheduledExecutorService scheduledExecutor, PostOffice postOffice, StorageManager storageManager, HierarchicalRepository<AddressSettings> addressSettingsRepository, ArtemisExecutor executor, ActiveMQServer server, QueueFactory factory)`
`QueueImpl(long id, SimpleString address, SimpleString name, Filter filter, SimpleString user, boolean durable, boolean temporary, boolean autoCreated, ScheduledExecutorService scheduledExecutor, PostOffice postOffice, StorageManager storageManager, HierarchicalRepository<AddressSettings> addressSettingsRepository, ArtemisExecutor executor, ActiveMQServer server, QueueFactory factory)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acknowledge(MessageReference ref)`
`void`	`acknowledge(MessageReference ref, AckReason reason, ServerConsumer consumer)`
`void`	`acknowledge(MessageReference ref, ServerConsumer consumer)`
`void`	`acknowledge(Transaction tx, MessageReference ref)`
`void`	`acknowledge(Transaction tx, MessageReference ref, AckReason reason, ServerConsumer consumer)`
`void`	`addConsumer(Consumer consumer)`
`void`	`addHead(List<MessageReference> refs, boolean scheduling)`
`void`	`addHead(MessageReference ref, boolean scheduling)`
`void`	`addRedistributor(long delay)`
`void`	`addTail(MessageReference ref)`
`void`	`addTail(MessageReference ref, boolean direct)`
`org.apache.activemq.artemis.core.server.impl.QueueImpl.QueueBrowserIterator`	`browserIterator()`
`void`	`cancel(MessageReference reference, long timeBase)`
`void`	`cancel(Transaction tx, MessageReference reference)`
`void`	`cancel(Transaction tx, MessageReference reference, boolean ignoreRedeliveryCheck)`
`void`	`cancelRedistributor()`
`boolean`	`changeReferencePriority(long messageID, byte newPriority)`
`int`	`changeReferencesPriority(Filter filter, byte newPriority)`
`boolean`	`checkRedelivery(MessageReference reference, long timeBase, boolean ignoreRedeliveryDelay)`
`void`	`close()`
`String`	`debug()`
`void`	`decDelivering(MessageReference reference)`
`int`	`deleteAllReferences()`
`int`	`deleteAllReferences(int flushLimit)`
`int`	`deleteMatchingReferences(Filter filter)`
`int`	`deleteMatchingReferences(int flushLimit, Filter filter1, AckReason ackReason)`
`void`	`deleteQueue()`
`void`	`deleteQueue(boolean removeConsumers)`
`boolean`	`deleteReference(long messageID)`
`void`	`deliverAsync()`
`void`	`deliverNow()`
`void`	`deliverScheduledMessages()` cancels scheduled messages and send them to the head of the queue.
`void`	`destroyPaging()`
`boolean`	`equals(Object other)`
`void`	`expire(MessageReference ref)`
`void`	`expire(MessageReference ref, ServerConsumer consumer)`
`boolean`	`expireReference(long messageID)`
`void`	`expireReferences()`
`int`	`expireReferences(Filter filter)` Expire all the references in the queue which matches the filter
`protected void`	`finalize()`
`boolean`	`flushExecutor()`
`void`	`forceDelivery()` This method will make sure that any pending message (including paged message) will be delivered
`SimpleString`	`getAddress()`
`int`	`getConsumerCount()`
`Set<Consumer>`	`getConsumers()`
`ReferenceCounter`	`getConsumersRefCount()`
`int`	`getDeliveringCount()`
`Map<String,List<MessageReference>>`	`getDeliveringMessages()` Return a Map consisting of consumer.toString and its messages Delivering message is a property of the consumer, this method will aggregate the results per Server's consumer object
`long`	`getDeliveringSize()`
`int`	`getDurableDeliveringCount()`
`long`	`getDurableDeliveringSize()`
`long`	`getDurableMessageCount()` This is the number of the durable messages in the queue
`long`	`getDurablePersistentSize()` This is the persistent size of all the durable messages in the queue
`int`	`getDurableScheduledCount()`
`long`	`getDurableScheduledSize()`
`ArtemisExecutor`	`getExecutor()`
`SimpleString`	`getExpiryAddress()`
`Filter`	`getFilter()`
`int`	`getGroupCount()`
`Map<SimpleString,Consumer>`	`getGroups()`
`List<SimpleString>`	`getGroupsUsed()` For testing only
`long`	`getID()`
`int`	`getMaxConsumers()`
`long`	`getMessageCount()`
`long`	`getMessagesAcknowledged()`
`long`	`getMessagesAdded()`
`long`	`getMessagesExpired()`
`long`	`getMessagesKilled()`
`SimpleString`	`getName()`
`int`	`getNumberOfReferences()` Used on testing only *
`PageSubscription`	`getPageSubscription()`
`long`	`getPersistentSize()` This is the size of the messages in the queue when persisted on disk which is used for metrics tracking to give an idea of the amount of data on the queue to be consumed Note that this includes all messages on the queue, even messages that are non-durable which may only be in memory
`float`	`getRate()`
`MessageReference`	`getReference(long id1)`
`SimpleString`	`getRoutingName()`
`RoutingType`	`getRoutingType()`
`int`	`getScheduledCount()`
`List<MessageReference>`	`getScheduledMessages()`
`long`	`getScheduledSize()`
`SimpleString`	`getUniqueName()`
`SimpleString`	`getUser()`
`int`	`hashCode()`
`boolean`	`hasMatchingConsumer(Message message)`
`void`	`incrementMesssagesAdded()`
`boolean`	`isAutoCreated()`
`boolean`	`isDirectDeliver()`
`boolean`	`isDurable()`
`boolean`	`isDurableMessage()` The queue definition could be durable, but the messages could eventually be considered non durable.
`boolean`	`isExclusive()`
`boolean`	`isExpirationRedundant()`
`boolean`	`isInternalQueue()` We can't send stuff to DLQ on queues used on clustered-bridge-communication
`boolean`	`isLastValue()`
`boolean`	`isPaused()`
`boolean`	`isPersistedPause()` if the pause was persisted
`boolean`	`isPurgeOnNoConsumers()`
`boolean`	`isTemporary()`
`LinkedListIterator<MessageReference>`	`iterator()` It will iterate thorugh memory only (not paging)
`boolean`	`moveReference(long messageID, SimpleString toAddress, Binding binding, boolean rejectDuplicate)`
`int`	`moveReferences(Filter filter, SimpleString toAddress, Binding binding)`
`int`	`moveReferences(int flushLimit, Filter filter, SimpleString toAddress, boolean rejectDuplicates, Binding binding)`
`int`	`moveReferencesBetweenSnFQueues(SimpleString queueSuffix)`
`void`	`pause()` Pauses the queue.
`void`	`pause(boolean persist)` Pauses the queue.
`void`	`postAcknowledge(MessageReference ref)`
`void`	`reacknowledge(Transaction tx, MessageReference ref)`
`void`	`recheckRefCount(OperationContext context)` This is to perform a check on the counter again
`protected void`	`refAdded(MessageReference ref)`
`void`	`referenceHandled(MessageReference ref)`
`protected void`	`refRemoved(MessageReference ref)`
`void`	`reload(MessageReference ref)`
`void`	`reloadPause(long recordID)`
`void`	`removeConsumer(Consumer consumer)`
`MessageReference`	`removeReferenceWithID(long id1)`
`void`	`resetAllGroups()`
`void`	`resetAllIterators()`
`void`	`resetGroup(SimpleString groupId)`
`void`	`resetMessagesAcknowledged()`
`void`	`resetMessagesAdded()`
`void`	`resetMessagesExpired()`
`void`	`resetMessagesKilled()`
`void`	`resume()` Resumes the delivery of message for the queue.
`int`	`retryMessages(Filter filter)`
`void`	`route(Message message, RoutingContext context)`
`void`	`routeWithAck(Message message, RoutingContext context)`
`protected boolean`	`scheduleIfPossible(MessageReference ref)`
`int`	`sendMessagesToDeadLetterAddress(Filter filter)`
`boolean`	`sendMessageToDeadLetterAddress(long messageID)`
`void`	`sendToDeadLetterAddress(Transaction tx, MessageReference ref)`
`void`	`setConsumersRefCount(ReferenceCounter referenceCounter)` This will set a reference counter for every consumer present on the queue.
`void`	`setExclusive(boolean exclusive)`
`void`	`setInternalQueue(boolean internalQueue)`
`void`	`setMaxConsumer(int maxConsumers)`
`void`	`setPurgeOnNoConsumers(boolean value)`
`void`	`setRoutingType(RoutingType routingType)`
`String`	`toString()`
`void`	`unproposed(SimpleString groupID)`

Methods inherited from class org.apache.activemq.artemis.utils.critical.CriticalComponentImpl
enterCritical, getCriticalAnalyzer, isExpired, leaveCritical

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

Methods inherited from interface org.apache.activemq.artemis.core.server.Queue
deleteMatchingReferences

Methods inherited from interface org.apache.activemq.artemis.utils.critical.CriticalComponent
enterCritical, isExpired, leaveCritical

Field Detail
- CRITICAL_PATHS
```
protected static final int CRITICAL_PATHS
```
  See Also:
  
  Constant Field Values
- CRITICAL_PATH_ADD_TAIL
```
protected static final int CRITICAL_PATH_ADD_TAIL
```
  See Also:
  
  Constant Field Values
- CRITICAL_PATH_ADD_HEAD
```
protected static final int CRITICAL_PATH_ADD_HEAD
```
  See Also:
  
  Constant Field Values
- CRITICAL_DELIVER
```
protected static final int CRITICAL_DELIVER
```
  See Also:
  
  Constant Field Values
- CRITICAL_CONSUMER
```
protected static final int CRITICAL_CONSUMER
```
  See Also:
  
  Constant Field Values
- REDISTRIBUTOR_BATCH_SIZE
```
public static final int REDISTRIBUTOR_BATCH_SIZE
```
  See Also:
  
  Constant Field Values
- NUM_PRIORITIES
```
public static final int NUM_PRIORITIES
```
  See Also:
  
  Constant Field Values
- MAX_DELIVERIES_IN_LOOP
```
public static final int MAX_DELIVERIES_IN_LOOP
```
  See Also:
  
  Constant Field Values
- CHECK_QUEUE_SIZE_PERIOD
```
public static final int CHECK_QUEUE_SIZE_PERIOD
```
  See Also:
  
  Constant Field Values
- DELIVERY_TIMEOUT
```
public static final int DELIVERY_TIMEOUT
```
  If The system gets slow for any reason, this is the maximum time a Delivery or or depage executor should be hanging on
  
  See Also:
  
  Constant Field Values
- DEFAULT_FLUSH_LIMIT
```
public static final int DEFAULT_FLUSH_LIMIT
```
  See Also:
  
  Constant Field Values

Constructor Detail

QueueImpl

public QueueImpl(long id,
                 SimpleString address,
                 SimpleString name,
                 Filter filter,
                 SimpleString user,
                 boolean durable,
                 boolean temporary,
                 boolean autoCreated,
                 ScheduledExecutorService scheduledExecutor,
                 PostOffice postOffice,
                 StorageManager storageManager,
                 HierarchicalRepository<AddressSettings> addressSettingsRepository,
                 ArtemisExecutor executor,
                 ActiveMQServer server,
                 QueueFactory factory)

QueueImpl

public QueueImpl(long id,
                 SimpleString address,
                 SimpleString name,
                 Filter filter,
                 PageSubscription pageSubscription,
                 SimpleString user,
                 boolean durable,
                 boolean temporary,
                 boolean autoCreated,
                 ScheduledExecutorService scheduledExecutor,
                 PostOffice postOffice,
                 StorageManager storageManager,
                 HierarchicalRepository<AddressSettings> addressSettingsRepository,
                 ArtemisExecutor executor,
                 ActiveMQServer server,
                 QueueFactory factory)

QueueImpl

public QueueImpl(long id,
                 SimpleString address,
                 SimpleString name,
                 Filter filter,
                 PageSubscription pageSubscription,
                 SimpleString user,
                 boolean durable,
                 boolean temporary,
                 boolean autoCreated,
                 RoutingType routingType,
                 Integer maxConsumers,
                 Boolean purgeOnNoConsumers,
                 ScheduledExecutorService scheduledExecutor,
                 PostOffice postOffice,
                 StorageManager storageManager,
                 HierarchicalRepository<AddressSettings> addressSettingsRepository,
                 ArtemisExecutor executor,
                 ActiveMQServer server,
                 QueueFactory factory)

QueueImpl

public QueueImpl(long id,
                 SimpleString address,
                 SimpleString name,
                 Filter filter,
                 PageSubscription pageSubscription,
                 SimpleString user,
                 boolean durable,
                 boolean temporary,
                 boolean autoCreated,
                 RoutingType routingType,
                 Integer maxConsumers,
                 Boolean exclusive,
                 Boolean purgeOnNoConsumers,
                 ScheduledExecutorService scheduledExecutor,
                 PostOffice postOffice,
                 StorageManager storageManager,
                 HierarchicalRepository<AddressSettings> addressSettingsRepository,
                 ArtemisExecutor executor,
                 ActiveMQServer server,
                 QueueFactory factory)

Method Detail
- getGroupsUsed
```
public List<SimpleString> getGroupsUsed()
```
  For testing only
- debug
```
public String debug()
```
- getRoutingName
```
public SimpleString getRoutingName()
```
- getUniqueName
```
public SimpleString getUniqueName()
```
- getUser
```
public SimpleString getUser()
```
  Specified by:
  
  getUser in interface Queue
  
  Returns:
  
  the user who created this queue
- isExclusive
```
public boolean isExclusive()
```
  Specified by:
  
  isExclusive in interface Queue
- setExclusive
```
public void setExclusive(boolean exclusive)
```
  Specified by:
  
  setExclusive in interface Queue
- isLastValue
```
public boolean isLastValue()
```
  Specified by:
  
  isLastValue in interface Queue
- route
```
public void route(Message message,
                  RoutingContext context)
           throws Exception
```
  Specified by:
  
  route in interface Bindable
  
  Throws:
  
  Exception
- routeWithAck
```
public void routeWithAck(Message message,
                         RoutingContext context)
```
  Specified by:
  
  routeWithAck in interface Bindable
- setConsumersRefCount
```
public void setConsumersRefCount(ReferenceCounter referenceCounter)
```
  Description copied from interface: Queue
  
  This will set a reference counter for every consumer present on the queue. The ReferenceCounter will know what to do when the counter became zeroed. This is used to control what to do with temporary queues, especially on shared subscriptions where the queue needs to be deleted when all the consumers are closed.
  
  Specified by:
  
  setConsumersRefCount in interface Queue
- getConsumersRefCount
```
public ReferenceCounter getConsumersRefCount()
```
  Specified by:
  
  getConsumersRefCount in interface Queue
- isDurable
```
public boolean isDurable()
```
  Specified by:
  
  isDurable in interface Queue
- isDurableMessage
```
public boolean isDurableMessage()
```
  Description copied from interface: Queue
  
  The queue definition could be durable, but the messages could eventually be considered non durable. (e.g. purgeOnNoConsumers)
  
  Specified by:
  
  isDurableMessage in interface Queue
  
  Returns:
- isTemporary
```
public boolean isTemporary()
```
  Specified by:
  
  isTemporary in interface Queue
- isAutoCreated
```
public boolean isAutoCreated()
```
  Specified by:
  
  isAutoCreated in interface Queue
- isPurgeOnNoConsumers
```
public boolean isPurgeOnNoConsumers()
```
  Specified by:
  
  isPurgeOnNoConsumers in interface Queue
- setPurgeOnNoConsumers
```
public void setPurgeOnNoConsumers(boolean value)
```
  Specified by:
  
  setPurgeOnNoConsumers in interface Queue
- getMaxConsumers
```
public int getMaxConsumers()
```
  Specified by:
  
  getMaxConsumers in interface Queue
- setMaxConsumer
```
public void setMaxConsumer(int maxConsumers)
```
  Specified by:
  
  setMaxConsumer in interface Queue
- getName
```
public SimpleString getName()
```
  Specified by:
  
  getName in interface Queue
- getAddress
```
public SimpleString getAddress()
```
  Specified by:
  
  getAddress in interface Queue
- getID
```
public long getID()
```
  Specified by:
  
  getID in interface Queue
- getPageSubscription
```
public PageSubscription getPageSubscription()
```
  Specified by:
  
  getPageSubscription in interface Queue
- getRoutingType
```
public RoutingType getRoutingType()
```
  Specified by:
  
  getRoutingType in interface Queue
- setRoutingType
```
public void setRoutingType(RoutingType routingType)
```
  Specified by:
  
  setRoutingType in interface Queue
- getFilter
```
public Filter getFilter()
```
  Specified by:
  
  getFilter in interface Queue
- unproposed
```
public void unproposed(SimpleString groupID)
```
  Specified by:
  
  unproposed in interface Queue
- addHead
```
public void addHead(MessageReference ref,
                    boolean scheduling)
```
  Specified by:
  
  addHead in interface Queue
- addHead
```
public void addHead(List<MessageReference> refs,
                    boolean scheduling)
```
  Specified by:
  
  addHead in interface Queue
- reload
```
public void reload(MessageReference ref)
```
  Specified by:
  
  reload in interface Queue
- addTail
```
public void addTail(MessageReference ref)
```
  Specified by:
  
  addTail in interface Queue
- addTail
```
public void addTail(MessageReference ref,
                    boolean direct)
```
  Specified by:
  
  addTail in interface Queue
- scheduleIfPossible
```
protected boolean scheduleIfPossible(MessageReference ref)
```
- forceDelivery
```
public void forceDelivery()
```
  Description copied from interface: Queue
  
  This method will make sure that any pending message (including paged message) will be delivered
  
  Specified by:
  
  forceDelivery in interface Queue
- deliverAsync
```
public void deliverAsync()
```
  Specified by:
  
  deliverAsync in interface Queue
- close
```
public void close()
           throws Exception
```
  Specified by:
  
  close in interface Queue
  
  Throws:
  
  Exception
- getExecutor
```
public ArtemisExecutor getExecutor()
```
  Specified by:
  
  getExecutor in interface Queue
- deliverNow
```
public void deliverNow()
```
- flushExecutor
```
public boolean flushExecutor()
```
  Specified by:
  
  flushExecutor in interface Queue
- addConsumer
```
public void addConsumer(Consumer consumer)
                 throws Exception
```
  Specified by:
  
  addConsumer in interface Queue
  
  Throws:
  
  Exception
- removeConsumer
```
public void removeConsumer(Consumer consumer)
```
  Specified by:
  
  removeConsumer in interface Queue
- addRedistributor
```
public void addRedistributor(long delay)
```
  Specified by:
  
  addRedistributor in interface Queue
- cancelRedistributor
```
public void cancelRedistributor()
                         throws Exception
```
  Specified by:
  
  cancelRedistributor in interface Queue
  
  Throws:
  
  Exception
- finalize
```
protected void finalize()
                 throws Throwable
```
  Overrides:
  
  finalize in class Object
  
  Throws:
  
  Throwable
- getConsumerCount
```
public int getConsumerCount()
```
  Specified by:
  
  getConsumerCount in interface Queue
- getConsumers
```
public Set<Consumer> getConsumers()
```
  Specified by:
  
  getConsumers in interface Queue
- getGroups
```
public Map<SimpleString,Consumer> getGroups()
```
  Specified by:
  
  getGroups in interface Queue
- resetGroup
```
public void resetGroup(SimpleString groupId)
```
  Specified by:
  
  resetGroup in interface Queue
- resetAllGroups
```
public void resetAllGroups()
```
  Specified by:
  
  resetAllGroups in interface Queue
- getGroupCount
```
public int getGroupCount()
```
  Specified by:
  
  getGroupCount in interface Queue
- hasMatchingConsumer
```
public boolean hasMatchingConsumer(Message message)
```
  Specified by:
  
  hasMatchingConsumer in interface Queue
- iterator
```
public LinkedListIterator<MessageReference> iterator()
```
  Description copied from interface: Queue
  
  It will iterate thorugh memory only (not paging)
  
  Specified by:
  
  iterator in interface Queue
  
  Returns:
- browserIterator
```
public org.apache.activemq.artemis.core.server.impl.QueueImpl.QueueBrowserIterator browserIterator()
```
  Specified by:
  
  browserIterator in interface Queue
- removeReferenceWithID
```
public MessageReference removeReferenceWithID(long id1)
                                       throws Exception
```
  Specified by:
  
  removeReferenceWithID in interface Queue
  
  Throws:
  
  Exception
- getReference
```
public MessageReference getReference(long id1)
                              throws ActiveMQException
```
  Specified by:
  
  getReference in interface Queue
  
  Throws:
  
  ActiveMQException
- getMessageCount
```
public long getMessageCount()
```
  Specified by:
  
  getMessageCount in interface Queue
- getPersistentSize
```
public long getPersistentSize()
```
  Description copied from interface: Queue
  
  This is the size of the messages in the queue when persisted on disk which is used for metrics tracking to give an idea of the amount of data on the queue to be consumed Note that this includes all messages on the queue, even messages that are non-durable which may only be in memory
  
  Specified by:
  
  getPersistentSize in interface Queue
- getDurableMessageCount
```
public long getDurableMessageCount()
```
  Description copied from interface: Queue
  
  This is the number of the durable messages in the queue
  
  Specified by:
  
  getDurableMessageCount in interface Queue
- getDurablePersistentSize
```
public long getDurablePersistentSize()
```
  Description copied from interface: Queue
  
  This is the persistent size of all the durable messages in the queue
  
  Specified by:
  
  getDurablePersistentSize in interface Queue
- getScheduledCount
```
public int getScheduledCount()
```
  Specified by:
  
  getScheduledCount in interface Queue
- getScheduledSize
```
public long getScheduledSize()
```
  Specified by:
  
  getScheduledSize in interface Queue
- getDurableScheduledCount
```
public int getDurableScheduledCount()
```
  Specified by:
  
  getDurableScheduledCount in interface Queue
- getDurableScheduledSize
```
public long getDurableScheduledSize()
```
  Specified by:
  
  getDurableScheduledSize in interface Queue
- getScheduledMessages
```
public List<MessageReference> getScheduledMessages()
```
  Specified by:
  
  getScheduledMessages in interface Queue
- getDeliveringMessages
```
public Map<String,List<MessageReference>> getDeliveringMessages()
```
  Description copied from interface: Queue
  
  Return a Map consisting of consumer.toString and its messages Delivering message is a property of the consumer, this method will aggregate the results per Server's consumer object
  
  Specified by:
  
  getDeliveringMessages in interface Queue
  
  Returns:
- getDeliveringCount
```
public int getDeliveringCount()
```
  Specified by:
  
  getDeliveringCount in interface Queue
- getDeliveringSize
```
public long getDeliveringSize()
```
  Specified by:
  
  getDeliveringSize in interface Queue
- getDurableDeliveringCount
```
public int getDurableDeliveringCount()
```
  Specified by:
  
  getDurableDeliveringCount in interface Queue
- getDurableDeliveringSize
```
public long getDurableDeliveringSize()
```
  Specified by:
  
  getDurableDeliveringSize in interface Queue
- acknowledge
```
public void acknowledge(MessageReference ref)
                 throws Exception
```
  Specified by:
  
  acknowledge in interface Queue
  
  Throws:
  
  Exception
- acknowledge
```
public void acknowledge(MessageReference ref,
                        ServerConsumer consumer)
                 throws Exception
```
  Specified by:
  
  acknowledge in interface Queue
  
  Throws:
  
  Exception
- acknowledge
```
public void acknowledge(MessageReference ref,
                        AckReason reason,
                        ServerConsumer consumer)
                 throws Exception
```
  Specified by:
  
  acknowledge in interface Queue
  
  Throws:
  
  Exception
- acknowledge
```
public void acknowledge(Transaction tx,
                        MessageReference ref)
                 throws Exception
```
  Specified by:
  
  acknowledge in interface Queue
  
  Throws:
  
  Exception
- acknowledge
```
public void acknowledge(Transaction tx,
                        MessageReference ref,
                        AckReason reason,
                        ServerConsumer consumer)
                 throws Exception
```
  Specified by:
  
  acknowledge in interface Queue
  
  Throws:
  
  Exception
- reacknowledge
```
public void reacknowledge(Transaction tx,
                          MessageReference ref)
                   throws Exception
```
  Specified by:
  
  reacknowledge in interface Queue
  
  Throws:
  
  Exception
- cancel
```
public void cancel(Transaction tx,
                   MessageReference reference)
```
  Specified by:
  
  cancel in interface Queue
- cancel
```
public void cancel(Transaction tx,
                   MessageReference reference,
                   boolean ignoreRedeliveryCheck)
```
  Specified by:
  
  cancel in interface Queue
- cancel
```
public void cancel(MessageReference reference,
                   long timeBase)
            throws Exception
```
  Specified by:
  
  cancel in interface Queue
  
  Throws:
  
  Exception
- expire
```
public void expire(MessageReference ref)
            throws Exception
```
  Specified by:
  
  expire in interface Queue
  
  Throws:
  
  Exception
- expire
```
public void expire(MessageReference ref,
                   ServerConsumer consumer)
            throws Exception
```
  Specified by:
  
  expire in interface Queue
  
  Throws:
  
  Exception
- getExpiryAddress
```
public SimpleString getExpiryAddress()
```
  Specified by:
  
  getExpiryAddress in interface Queue
- referenceHandled
```
public void referenceHandled(MessageReference ref)
```
  Specified by:
  
  referenceHandled in interface Queue
- incrementMesssagesAdded
```
public void incrementMesssagesAdded()
```
  Specified by:
  
  incrementMesssagesAdded in interface Queue
- deliverScheduledMessages
```
public void deliverScheduledMessages()
                              throws ActiveMQException
```
  Description copied from interface: Queue
  
  cancels scheduled messages and send them to the head of the queue.
  
  Specified by:
  
  deliverScheduledMessages in interface Queue
  
  Throws:
  
  ActiveMQException
- getMessagesAdded
```
public long getMessagesAdded()
```
  Specified by:
  
  getMessagesAdded in interface Queue
- getMessagesAcknowledged
```
public long getMessagesAcknowledged()
```
  Specified by:
  
  getMessagesAcknowledged in interface Queue
- getMessagesExpired
```
public long getMessagesExpired()
```
  Specified by:
  
  getMessagesExpired in interface Queue
- getMessagesKilled
```
public long getMessagesKilled()
```
  Specified by:
  
  getMessagesKilled in interface Queue
- deleteAllReferences
```
public int deleteAllReferences()
                        throws Exception
```
  Specified by:
  
  deleteAllReferences in interface Queue
  
  Throws:
  
  Exception
- deleteAllReferences
```
public int deleteAllReferences(int flushLimit)
                        throws Exception
```
  Specified by:
  
  deleteAllReferences in interface Queue
  
  Throws:
  
  Exception
- deleteMatchingReferences
```
public int deleteMatchingReferences(Filter filter)
                             throws Exception
```
  Specified by:
  
  deleteMatchingReferences in interface Queue
  
  Throws:
  
  Exception
- deleteMatchingReferences
```
public int deleteMatchingReferences(int flushLimit,
                                    Filter filter1,
                                    AckReason ackReason)
                             throws Exception
```
  Specified by:
  
  deleteMatchingReferences in interface Queue
  
  Throws:
  
  Exception
- destroyPaging
```
public void destroyPaging()
                   throws Exception
```
  Specified by:
  
  destroyPaging in interface Queue
  
  Throws:
  
  Exception
- deleteReference
```
public boolean deleteReference(long messageID)
                        throws Exception
```
  Specified by:
  
  deleteReference in interface Queue
  
  Throws:
  
  Exception
- deleteQueue
```
public void deleteQueue()
                 throws Exception
```
  Specified by:
  
  deleteQueue in interface Queue
  
  Throws:
  
  Exception
- deleteQueue
```
public void deleteQueue(boolean removeConsumers)
                 throws Exception
```
  Specified by:
  
  deleteQueue in interface Queue
  
  Throws:
  
  Exception
- expireReference
```
public boolean expireReference(long messageID)
                        throws Exception
```
  Specified by:
  
  expireReference in interface Queue
  
  Throws:
  
  Exception
- expireReferences
```
public int expireReferences(Filter filter)
                     throws Exception
```
  Description copied from interface: Queue
  
  Expire all the references in the queue which matches the filter
  
  Specified by:
  
  expireReferences in interface Queue
  
  Throws:
  
  Exception
- expireReferences
```
public void expireReferences()
```
  Specified by:
  
  expireReferences in interface Queue
- isExpirationRedundant
```
public boolean isExpirationRedundant()
```
- sendMessageToDeadLetterAddress
```
public boolean sendMessageToDeadLetterAddress(long messageID)
                                       throws Exception
```
  Specified by:
  
  sendMessageToDeadLetterAddress in interface Queue
  
  Throws:
  
  Exception
- sendMessagesToDeadLetterAddress
```
public int sendMessagesToDeadLetterAddress(Filter filter)
                                    throws Exception
```
  Specified by:
  
  sendMessagesToDeadLetterAddress in interface Queue
  
  Throws:
  
  Exception
- moveReference
```
public boolean moveReference(long messageID,
                             SimpleString toAddress,
                             Binding binding,
                             boolean rejectDuplicate)
                      throws Exception
```
  Specified by:
  
  moveReference in interface Queue
  
  Throws:
  
  Exception
- moveReferences
```
public int moveReferences(Filter filter,
                          SimpleString toAddress,
                          Binding binding)
                   throws Exception
```
  Specified by:
  
  moveReferences in interface Queue
  
  Throws:
  
  Exception
- moveReferences
```
public int moveReferences(int flushLimit,
                          Filter filter,
                          SimpleString toAddress,
                          boolean rejectDuplicates,
                          Binding binding)
                   throws Exception
```
  Specified by:
  
  moveReferences in interface Queue
  
  Throws:
  
  Exception
- moveReferencesBetweenSnFQueues
```
public int moveReferencesBetweenSnFQueues(SimpleString queueSuffix)
                                   throws Exception
```
  Throws:
  
  Exception
- retryMessages
```
public int retryMessages(Filter filter)
                  throws Exception
```
  Specified by:
  
  retryMessages in interface Queue
  
  Throws:
  
  Exception
- changeReferencePriority
```
public boolean changeReferencePriority(long messageID,
                                       byte newPriority)
                                throws Exception
```
  Specified by:
  
  changeReferencePriority in interface Queue
  
  Throws:
  
  Exception
- changeReferencesPriority
```
public int changeReferencesPriority(Filter filter,
                                    byte newPriority)
                             throws Exception
```
  Specified by:
  
  changeReferencesPriority in interface Queue
  
  Throws:
  
  Exception
- resetAllIterators
```
public void resetAllIterators()
```
  Specified by:
  
  resetAllIterators in interface Queue
- pause
```
public void pause()
```
  Description copied from interface: Queue
  
  Pauses the queue. It will receive messages but won't give them to the consumers until resumed. If a queue is paused, pausing it again will only throw a warning. To check if a queue is paused, invoke isPaused()
  
  Specified by:
  
  pause in interface Queue
- reloadPause
```
public void reloadPause(long recordID)
```
  Specified by:
  
  reloadPause in interface Queue
- pause
```
public void pause(boolean persist)
```
  Description copied from interface: Queue
  
  Pauses the queue. It will receive messages but won't give them to the consumers until resumed. If a queue is paused, pausing it again will only throw a warning. To check if a queue is paused, invoke isPaused()
  
  Specified by:
  
  pause in interface Queue
- resume
```
public void resume()
```
  Description copied from interface: Queue
  
  Resumes the delivery of message for the queue. If a queue is resumed, resuming it again will only throw a warning. To check if a queue is resumed, invoke isPaused()
  
  Specified by:
  
  resume in interface Queue
- isPaused
```
public boolean isPaused()
```
  Specified by:
  
  isPaused in interface Queue
  
  Returns:
  
  true if paused, false otherwise.
- isPersistedPause
```
public boolean isPersistedPause()
```
  Description copied from interface: Queue
  
  if the pause was persisted
  
  Specified by:
  
  isPersistedPause in interface Queue
  
  Returns:
- isDirectDeliver
```
public boolean isDirectDeliver()
```
  Specified by:
  
  isDirectDeliver in interface Queue
- isInternalQueue
```
public boolean isInternalQueue()
```
  Description copied from interface: Queue
  
  We can't send stuff to DLQ on queues used on clustered-bridge-communication
  
  Specified by:
  
  isInternalQueue in interface Queue
  
  Returns:
  
  the internalQueue
- setInternalQueue
```
public void setInternalQueue(boolean internalQueue)
```
  Specified by:
  
  setInternalQueue in interface Queue
  
  Parameters:
  
  internalQueue - the internalQueue to set
- equals
```
public boolean equals(Object other)
```
  Overrides:
  
  equals in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- refRemoved
```
protected void refRemoved(MessageReference ref)
```
- refAdded
```
protected void refAdded(MessageReference ref)
```
- checkRedelivery
```
public boolean checkRedelivery(MessageReference reference,
                               long timeBase,
                               boolean ignoreRedeliveryDelay)
                        throws Exception
```
  Specified by:
  
  checkRedelivery in interface Queue
  
  Throws:
  
  Exception
- getNumberOfReferences
```
public int getNumberOfReferences()
```
  Used on testing only *
- sendToDeadLetterAddress
```
public void sendToDeadLetterAddress(Transaction tx,
                                    MessageReference ref)
                             throws Exception
```
  Specified by:
  
  sendToDeadLetterAddress in interface Queue
  
  Throws:
  
  Exception
- postAcknowledge
```
public void postAcknowledge(MessageReference ref)
```
  Specified by:
  
  postAcknowledge in interface Queue
- resetMessagesAdded
```
public void resetMessagesAdded()
```
  Specified by:
  
  resetMessagesAdded in interface Queue
- resetMessagesAcknowledged
```
public void resetMessagesAcknowledged()
```
  Specified by:
  
  resetMessagesAcknowledged in interface Queue
- resetMessagesExpired
```
public void resetMessagesExpired()
```
  Specified by:
  
  resetMessagesExpired in interface Queue
- resetMessagesKilled
```
public void resetMessagesKilled()
```
  Specified by:
  
  resetMessagesKilled in interface Queue
- getRate
```
public float getRate()
```
  Specified by:
  
  getRate in interface Queue
- recheckRefCount
```
public void recheckRefCount(OperationContext context)
```
  Description copied from interface: Queue
  
  This is to perform a check on the counter again
  
  Specified by:
  
  recheckRefCount in interface Queue
- decDelivering
```
public void decDelivering(MessageReference reference)
```

Class QueueImpl

Field Summary

Fields inherited from interface org.apache.activemq.artemis.core.server.Queue

Constructor Summary

Method Summary

Methods inherited from class org.apache.activemq.artemis.utils.critical.CriticalComponentImpl

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.activemq.artemis.core.server.Queue

Methods inherited from interface org.apache.activemq.artemis.utils.critical.CriticalComponent

Field Detail

CRITICAL_PATHS

CRITICAL_PATH_ADD_TAIL

CRITICAL_PATH_ADD_HEAD

CRITICAL_DELIVER

CRITICAL_CONSUMER

REDISTRIBUTOR_BATCH_SIZE

NUM_PRIORITIES

MAX_DELIVERIES_IN_LOOP

CHECK_QUEUE_SIZE_PERIOD

DELIVERY_TIMEOUT

DEFAULT_FLUSH_LIMIT

Constructor Detail

QueueImpl

QueueImpl

QueueImpl

QueueImpl

Method Detail

getGroupsUsed

debug

getRoutingName

getUniqueName

getUser

isExclusive

setExclusive

isLastValue

route

routeWithAck

setConsumersRefCount

getConsumersRefCount

isDurable

isDurableMessage

isTemporary

isAutoCreated

isPurgeOnNoConsumers

setPurgeOnNoConsumers

getMaxConsumers

setMaxConsumer

getName

getAddress

getID

getPageSubscription

getRoutingType

setRoutingType

getFilter

unproposed

addHead

addHead

reload

addTail

addTail

scheduleIfPossible

forceDelivery

deliverAsync

close

getExecutor

deliverNow

flushExecutor

addConsumer

removeConsumer

addRedistributor

cancelRedistributor

finalize

getConsumerCount

getConsumers

getGroups

resetGroup

resetAllGroups

getGroupCount

hasMatchingConsumer

iterator