Package org.apache.activemq.artemis.core.server.impl

Class QueueImpl

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	QueueImpl.ConsumerHolder<T extends Consumer>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CHECK_QUEUE_SIZE_PERIOD
protected static final int	CRITICAL_CHECK_DEPAGE
protected static final int	CRITICAL_CONSUMER
protected static final int	CRITICAL_DELIVER
protected static final int	CRITICAL_PATH_ADD_HEAD
protected static final int	CRITICAL_PATH_ADD_TAIL
protected static final int	CRITICAL_PATHS
static final int	DEFAULT_FLUSH_LIMIT
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
int	dispatching
long	dispatchStartTime
static final int	MAX_DELIVERIES_IN_LOOP
protected final PriorityLinkedList<MessageReference>	messageReferences
static final int	NUM_PRIORITIES
protected final PageSubscription	pageSubscription
protected final QueueMessageMetrics	pendingMetrics
protected final QueueConfiguration	queueConfiguration
protected final ScheduledDeliveryHandler	scheduledDeliveryHandler

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

MAX_CONSUMERS_UNLIMITED

Constructor Summary

Constructors

Constructor	Description
QueueImpl(QueueConfiguration queueConfiguration, Filter filter, PagingStore pagingStore, PageSubscription pageSubscription, ScheduledExecutorService scheduledExecutor, PostOffice postOffice, StorageManager storageManager, HierarchicalRepository<AddressSettings> addressSettingsRepository, ArtemisExecutor executor, ActiveMQServer server, QueueFactory factory)

Method Summary

Modifier and Type	Method	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, boolean delivering)	The parameter delivering can be sent as false in situation where the ack is coming outside of the context of delivering.
void	addConsumer(Consumer consumer)
void	addHead(List<MessageReference> refs, boolean scheduling)
void	addHead(MessageReference ref, boolean scheduling)
void	addLingerSession(String sessionId)
void	addRedistributor(long delay)
protected void	addRefSize(MessageReference ref)
void	addSorted(List<MessageReference> refs, boolean scheduling)	Called when a message is cancelled back into the queue
void	addSorted(MessageReference ref, boolean scheduling)	Called when a message is cancelled back into the queue
void	addTail(MessageReference ref)
void	addTail(MessageReference ref, boolean direct)
boolean	allowsReferenceCallback()	the current queue and consumer settings will allow use of the Reference Execution and callback.
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)
Pair<Boolean,Boolean>	checkRedelivery(MessageReference reference, long timeBase, boolean ignoreRedeliveryDelay)	Returns a Pair of Booleans: the first indicates whether redelivery happened; the second indicates whether or not the message was actually sent to a DLA with bindings.
void	close()
boolean	copyReference(long messageID, SimpleString toQueue, Binding binding)
String	debug()
void	decDelivering(MessageReference reference)
int	deleteAllReferences()
int	deleteAllReferences(int flushLimit)
int	deleteMatchingReferences(int flushLimit, Filter filter1, AckReason ackReason)
int	deleteMatchingReferences(Filter filter)
void	deleteQueue()
void	deleteQueue(boolean removeConsumers)
boolean	deleteReference(long messageID)
void	deliverAsync()
void	deliverNow()
void	deliverScheduledMessage(long messageId)	cancels scheduled message with the corresponding message ID and sends it to the head of the queue.
void	deliverScheduledMessages()	cancels scheduled messages and send them to the head of the queue.
void	deliverScheduledMessages(String filterString)	cancels scheduled messages which match the filter and send them to the head of the queue.
void	destroyPaging()
int	durableDown(Message message)
int	durableUp(Message message)
boolean	equals(Object other)
void	errorProcessing(Consumer consumer, Throwable t, MessageReference reference)	This will print errors and decide what to do with the errored consumer from the protocol layer.
void	expire(MessageReference ref)
void	expire(MessageReference ref, ServerConsumer consumer, boolean delivering)	The parameter delivering can be sent as false in situation where the ack is coming outside of the context of delivering.
boolean	expireReference(long messageID)
void	expireReferences(Runnable done)
int	expireReferences(Filter filter)	Expire all the references in the queue which matches the filter
boolean	flushExecutor()
void	flushOnIntermediate(Runnable runnable)
void	forceDelivery()	This method will make sure that any pending message (including paged message) will be delivered
long	getAcknowledgeAttempts()
SimpleString	getAddress()
long	getAutoDeleteDelay()
long	getAutoDeleteMessageCount()
int	getConsumerCount()
long	getConsumerRemovedTimestamp()
Set<Consumer>	getConsumers()
int	getConsumersBeforeDispatch()
ReferenceCounter	getConsumersRefCount()	This will hold a reference counter for every consumer present on the queue.
long	getCreatedTimestamp()
SimpleString	getDeadLetterAddress()
long	getDelayBeforeDispatch()
int	getDeliveringCount()
Map<String,List<MessageReference>>	getDeliveringMessages()	Return a Map consisting of consumer.toString and its messages.
long	getDeliveringSize()
long	getDispatchStartTime()
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	getGroupBuckets()
int	getGroupCount()
SimpleString	getGroupFirstKey()
Map<SimpleString,Consumer>	getGroups()
Long	getID()
int	getInitialQueueBufferSize()
SimpleString	getLastValueKey()
int	getMaxConsumers()
long	getMessageCount()
long	getMessagesAcknowledged()
long	getMessagesAdded()
long	getMessagesExpired()
long	getMessagesKilled()
long	getMessagesReplaced()
SimpleString	getName()
int	getNumberOfReferences()	Used on testing only *
PageSubscription	getPageSubscription()
PagingStore	getPagingStore()
long	getPendingMessageCount()
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
QueueConfiguration	getQueueConfiguration()
Redistributor	getRedistributor()
long	getRingSize()
SimpleString	getRoutingName()
RoutingType	getRoutingType()
int	getScheduledCount()
List<MessageReference>	getScheduledMessages()
long	getScheduledSize()
SimpleString	getUniqueName()
SimpleString	getUser()
static MessageGroups<Consumer>	groupMap(int groupBuckets)
int	hashCode()
boolean	hasMatchingConsumer(Message message)
void	incDelivering(MessageReference ref)
void	incrementMesssagesAdded()
boolean	isAutoCreated()
boolean	isAutoDelete()
boolean	isConfigurationManaged()
boolean	isDirectDeliver()
boolean	isDispatching()
boolean	isDurable()
boolean	isDurableMessage()	The queue definition could be durable, but the messages could eventually be considered non durable.
boolean	isEnabled()
boolean	isExclusive()
boolean	isGroupRebalance()
boolean	isGroupRebalancePauseDispatch()
boolean	isInternalQueue()	We can't send stuff to DLQ on queues used on clustered-bridge-communication
boolean	isLastValue()
boolean	isMirrorController()
boolean	isNonDestructive()
boolean	isPaused()
boolean	isPersistedPause()
boolean	isPurgeOnNoConsumers()
boolean	isSwept()
boolean	isTemporary()
LinkedListIterator<MessageReference>	iterator()	It will iterate through memory only (not paging)
boolean	moveReference(long messageID, SimpleString toAddress, Binding binding, boolean rejectDuplicate)
int	moveReferences(int flushLimit, Filter filter, SimpleString toAddress, boolean rejectDuplicates, int messageCount, Binding binding)
int	moveReferences(int flushLimit, Filter filter, SimpleString toAddress, boolean rejectDuplicates, Binding binding)
int	moveReferences(Filter filter, SimpleString toAddress, Binding binding)
int	moveReferencesBetweenSnFQueues(SimpleString queueSuffix)
void	pause()	Pauses the queue.
void	pause(boolean persist)	Pauses the queue.
MessageReference	peekFirstMessage()
MessageReference	peekFirstScheduledMessage()
void	postAcknowledge(MessageReference ref, AckReason reason)
void	postAcknowledge(MessageReference ref, AckReason reason, boolean delivering)	The parameter delivering can be sent as false in situation where the ack is coming outside of the context of delivering.
protected void	pruneLastValues()
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	refDown(MessageReference messageReference)
void	referenceHandled(MessageReference ref)
protected void	refRemoved(MessageReference ref)
void	refUp(MessageReference messageReference)
void	reload(MessageReference ref)
void	reloadPause(long recordID)
void	reloadSequence(MessageReference ref)
void	removeAddress()	This method will push a removeAddress call into server's remove address
void	removeConsumer(Consumer consumer)
void	removeLingerSession(String sessionId)
protected void	removeMessageReference(QueueImpl.ConsumerHolder<? extends Consumer> holder, MessageReference ref)
MessageReference	removeReferenceWithID(long id1)
MessageReference	removeWithSuppliedID(String serverID, long id, NodeStoreFactory<MessageReference> nodeStore)	Remove item with a supplied non-negative (>= 0) ID.
int	rerouteMessages(SimpleString queueName, Filter filter)
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)
int	retryMessages(Filter filter, Integer expectedHits)
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)
boolean	sendToDeadLetterAddress(Transaction tx, MessageReference ref)	Returns whether the message was actually sent to a DLA with bindings.
void	setConfigurationManaged(boolean configurationManaged)
void	setConsumersBeforeDispatch(int consumersBeforeDispatch)
void	setDelayBeforeDispatch(long delayBeforeDispatch)
void	setDispatching(boolean dispatching)
void	setEnabled(boolean value)
void	setExclusive(boolean exclusive)
void	setFilter(Filter filter)
void	setGroupBuckets(int groupBuckets)
void	setGroupFirstKey(SimpleString groupFirstKey)
void	setGroupRebalance(boolean groupRebalance)
void	setGroupRebalancePauseDispatch(boolean groupRebalancePauseDispatch)
void	setInternalQueue(boolean internalQueue)
void	setMaxConsumer(int maxConsumers)
void	setMirrorController(boolean mirrorController)
void	setNonDestructive(boolean nonDestructive)
void	setPurgeOnNoConsumers(boolean value)
void	setRingSize(long ringSize)
void	setRoutingType(RoutingType routingType)
void	setSwept(boolean swept)
void	setUser(SimpleString user)
String	toString()
void	unproposed(SimpleString groupID)

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

checkExpiration, getCriticalAnalyzer, measureCritical

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

checkExpiration, getCriticalAnalyzer, measureCritical

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

deleteMatchingReferences, expireReferences, forEach

Field Details

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

CRITICAL_CHECK_DEPAGE

protected static final int CRITICAL_CHECK_DEPAGE

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

pageSubscription

protected final PageSubscription pageSubscription

messageReferences

protected final PriorityLinkedList<MessageReference> messageReferences

pendingMetrics

protected final QueueMessageMetrics pendingMetrics

scheduledDeliveryHandler

protected final ScheduledDeliveryHandler scheduledDeliveryHandler

dispatching

public volatile int dispatching

dispatchStartTime

public volatile long dispatchStartTime

queueConfiguration

protected final QueueConfiguration queueConfiguration

Constructor Details

QueueImpl

public QueueImpl(QueueConfiguration queueConfiguration,
 Filter filter,
 PagingStore pagingStore,
 PageSubscription pageSubscription,
 ScheduledExecutorService scheduledExecutor,
 PostOffice postOffice,
 StorageManager storageManager,
 HierarchicalRepository<AddressSettings> addressSettingsRepository,
 ArtemisExecutor executor,
 ActiveMQServer server,
 QueueFactory factory)

Method Details

isSwept

public boolean isSwept()

Specified by:

isSwept in interface Queue

setSwept

public void setSwept(boolean swept)

Specified by:

setSwept in interface Queue

debug

public String debug()

allowsReferenceCallback

public boolean allowsReferenceCallback()

Description copied from interface: Queue

the current queue and consumer settings will allow use of the Reference Execution and callback. This is because

Specified by:

allowsReferenceCallback in interface Queue

isMirrorController

public boolean isMirrorController()

Specified by:

isMirrorController in interface Queue

setMirrorController

public void setMirrorController(boolean mirrorController)

Specified by:

setMirrorController in interface Queue

getRoutingName

public SimpleString getRoutingName()

getUniqueName

public SimpleString getUniqueName()

getUser

public SimpleString getUser()

Specified by:

getUser in interface Queue

setUser

public void setUser(SimpleString user)

Specified by:

setUser in interface Queue

isExclusive

public boolean isExclusive()

Specified by:

isExclusive in interface Queue

setExclusive

public void setExclusive(boolean exclusive)

Specified by:

setExclusive in interface Queue

getConsumersBeforeDispatch

public int getConsumersBeforeDispatch()

Specified by:

getConsumersBeforeDispatch in interface Queue

setConsumersBeforeDispatch

public void setConsumersBeforeDispatch(int consumersBeforeDispatch)

Specified by:

setConsumersBeforeDispatch in interface Queue

getDelayBeforeDispatch

public long getDelayBeforeDispatch()

Specified by:

getDelayBeforeDispatch in interface Queue

setDelayBeforeDispatch

public void setDelayBeforeDispatch(long delayBeforeDispatch)

Specified by:

setDelayBeforeDispatch in interface Queue

getDispatchStartTime

public long getDispatchStartTime()

Specified by:

getDispatchStartTime in interface Queue

isDispatching

public boolean isDispatching()

Specified by:

isDispatching in interface Queue

setDispatching

public void setDispatching(boolean dispatching)

Specified by:

setDispatching in interface Queue

isLastValue

public boolean isLastValue()

Specified by:

isLastValue in interface Queue

getLastValueKey

public SimpleString getLastValueKey()

Specified by:

getLastValueKey in interface Queue

isNonDestructive

public boolean isNonDestructive()

Specified by:

isNonDestructive in interface Queue

setNonDestructive

public void setNonDestructive(boolean nonDestructive)

Specified by:

setNonDestructive 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

getConsumersRefCount

public ReferenceCounter getConsumersRefCount()

Description copied from interface: Queue

This will hold 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:

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

isAutoDelete

public boolean isAutoDelete()

Specified by:

isAutoDelete in interface Queue

getAutoDeleteDelay

public long getAutoDeleteDelay()

Specified by:

getAutoDeleteDelay in interface Queue

getAutoDeleteMessageCount

public long getAutoDeleteMessageCount()

Specified by:

getAutoDeleteMessageCount in interface Queue

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

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Queue

setEnabled

public void setEnabled(boolean value)

Specified by:

setEnabled 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

getGroupBuckets

public int getGroupBuckets()

Specified by:

getGroupBuckets in interface Queue

setGroupBuckets

public void setGroupBuckets(int groupBuckets)

Specified by:

setGroupBuckets in interface Queue

isGroupRebalance

public boolean isGroupRebalance()

Specified by:

isGroupRebalance in interface Queue

setGroupRebalance

public void setGroupRebalance(boolean groupRebalance)

Specified by:

setGroupRebalance in interface Queue

isGroupRebalancePauseDispatch

public boolean isGroupRebalancePauseDispatch()

Specified by:

isGroupRebalancePauseDispatch in interface Queue

setGroupRebalancePauseDispatch

public void setGroupRebalancePauseDispatch(boolean groupRebalancePauseDispatch)

Specified by:

setGroupRebalancePauseDispatch in interface Queue

getGroupFirstKey

public SimpleString getGroupFirstKey()

Specified by:

getGroupFirstKey in interface Queue

setGroupFirstKey

public void setGroupFirstKey(SimpleString groupFirstKey)

Specified by:

setGroupFirstKey in interface Queue

isConfigurationManaged

public boolean isConfigurationManaged()

Specified by:

isConfigurationManaged in interface Queue

setConfigurationManaged

public void setConfigurationManaged(boolean configurationManaged)

Specified by:

setConfigurationManaged 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

durableUp

public int durableUp(Message message)

Specified by:

durableUp in interface Queue

durableDown

public int durableDown(Message message)

Specified by:

durableDown in interface Queue

refUp

public void refUp(MessageReference messageReference)

Specified by:

refUp in interface Queue

refDown

public void refDown(MessageReference messageReference)

Specified by:

refDown in interface Queue

getPagingStore

public PagingStore getPagingStore()

Specified by:

getPagingStore in interface Queue

getPageSubscription

public PageSubscription getPageSubscription()

Specified by:

getPageSubscription in interface Queue

getRoutingType

public RoutingType getRoutingType()

Specified by:

getRoutingType in interface Queue

getInitialQueueBufferSize

public int getInitialQueueBufferSize()

Specified by:

getInitialQueueBufferSize 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

setFilter

public void setFilter(Filter filter)

Specified by:

setFilter 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

addSorted

public void addSorted(MessageReference ref,
 boolean scheduling)

Description copied from interface: Queue

Called when a message is cancelled back into the queue

Specified by:

addSorted in interface Queue

addHead

public void addHead(List<MessageReference> refs,
 boolean scheduling)

Specified by:

addHead in interface Queue

addSorted

public void addSorted(List<MessageReference> refs,
 boolean scheduling)

Description copied from interface: Queue

Called when a message is cancelled back into the queue

Specified by:

addSorted in interface Queue

reload

public void reload(MessageReference ref)

Specified by:

reload in interface Queue

reloadSequence

public void reloadSequence(MessageReference ref)

Specified by:

reloadSequence in interface Queue

addTail

public void addTail(MessageReference ref)

Specified by:

addTail in interface Queue

flushOnIntermediate

public void flushOnIntermediate(Runnable runnable)

Specified by:

flushOnIntermediate 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

addLingerSession

public void addLingerSession(String sessionId)

Specified by:

addLingerSession in interface Queue

removeLingerSession

public void removeLingerSession(String sessionId)

Specified by:

removeLingerSession in interface Queue

removeConsumer

public void removeConsumer(Consumer consumer)

Specified by:

removeConsumer in interface Queue

getRedistributor

public Redistributor getRedistributor()

addRedistributor

public void addRedistributor(long delay)

Specified by:

addRedistributor in interface Queue

cancelRedistributor

public void cancelRedistributor()

Specified by:

cancelRedistributor in interface Queue

getConsumerCount

public int getConsumerCount()

Specified by:

getConsumerCount in interface Queue

getConsumerRemovedTimestamp

public long getConsumerRemovedTimestamp()

Specified by:

getConsumerRemovedTimestamp in interface Queue

getRingSize

public long getRingSize()

Specified by:

getRingSize in interface Queue

setRingSize

public void setRingSize(long ringSize)

Specified by:

setRingSize in interface Queue

getCreatedTimestamp

public long getCreatedTimestamp()

Specified by:

getCreatedTimestamp in interface Queue

getPendingMessageCount

public long getPendingMessageCount()

Specified by:

getPendingMessageCount 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 through memory only (not paging)

Specified by:

iterator in interface Queue

browserIterator

public org.apache.activemq.artemis.core.server.impl.QueueImpl.QueueBrowserIterator browserIterator()

Specified by:

browserIterator in interface Queue

peekFirstMessage

public MessageReference peekFirstMessage()

Specified by:

peekFirstMessage in interface Queue

peekFirstScheduledMessage

public MessageReference peekFirstScheduledMessage()

Specified by:

peekFirstScheduledMessage in interface Queue

removeReferenceWithID

public MessageReference removeReferenceWithID(long id1)
                                       throws Exception

Specified by:

removeReferenceWithID in interface Queue

Throws:

Exception

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

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,
 boolean delivering)
                 throws Exception

The parameter delivering can be sent as false in situation where the ack is coming outside of the context of delivering. Example: Mirror replication will call the ack here without any consumer involved. On that case no previous delivery happened, hence no information about delivering statistics should be updated.

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,
 boolean delivering)
            throws Exception

The parameter delivering can be sent as false in situation where the ack is coming outside of the context of delivering. Example: Mirror replication will call the ack here without any consumer involved. On that case no previous delivery happened, hence no information about delivering statistics should be updated.

Specified by:

expire in interface Queue

Throws:

Exception

getExpiryAddress

public SimpleString getExpiryAddress()

Specified by:

getExpiryAddress in interface Queue

getDeadLetterAddress

public SimpleString getDeadLetterAddress()

Specified by:

getDeadLetterAddress 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

deliverScheduledMessages

public void deliverScheduledMessages(String filterString)
                              throws ActiveMQException

Description copied from interface: Queue

cancels scheduled messages which match the filter and send them to the head of the queue.

Specified by:

deliverScheduledMessages in interface Queue

Throws:

ActiveMQException

deliverScheduledMessage

public void deliverScheduledMessage(long messageId)
                             throws ActiveMQException

Description copied from interface: Queue

cancels scheduled message with the corresponding message ID and sends it to the head of the queue.

Specified by:

deliverScheduledMessage 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

getAcknowledgeAttempts

public long getAcknowledgeAttempts()

Specified by:

getAcknowledgeAttempts in interface Queue

getMessagesExpired

public long getMessagesExpired()

Specified by:

getMessagesExpired in interface Queue

getMessagesKilled

public long getMessagesKilled()

Specified by:

getMessagesKilled in interface Queue

getMessagesReplaced

public long getMessagesReplaced()

Specified by:

getMessagesReplaced 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

removeAddress

public void removeAddress()
                   throws Exception

Description copied from interface: Queue

This method will push a removeAddress call into server's remove address

Specified by:

removeAddress 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(Runnable done)

Specified by:

expireReferences in interface Queue

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

moveReferences

public int moveReferences(int flushLimit,
 Filter filter,
 SimpleString toAddress,
 boolean rejectDuplicates,
 int messageCount,
 Binding binding)
                   throws Exception

Specified by:

moveReferences in interface Queue

Throws:

Exception

moveReferencesBetweenSnFQueues

public int moveReferencesBetweenSnFQueues(SimpleString queueSuffix)
                                   throws Exception

Throws:

Exception

copyReference

public boolean copyReference(long messageID,
 SimpleString toQueue,
 Binding binding)
                      throws Exception

Specified by:

copyReference in interface Queue

Throws:

Exception

rerouteMessages

public int rerouteMessages(SimpleString queueName,
 Filter filter)
                    throws Exception

Throws:

Exception

retryMessages

public int retryMessages(Filter filter)
                  throws Exception

Specified by:

retryMessages in interface Queue

Throws:

Exception

retryMessages

public int retryMessages(Filter filter,
 Integer expectedHits)
                  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 Queue.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 Queue.isPaused().

Specified by:

resume in interface Queue

isPaused

public boolean isPaused()

Specified by:

isPaused in interface Queue

isPersistedPause

public boolean isPersistedPause()

Specified by:

isPersistedPause in interface Queue

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

setInternalQueue

public void setInternalQueue(boolean internalQueue)

Specified by:

setInternalQueue in interface Queue

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

pruneLastValues

protected void pruneLastValues()

removeMessageReference

protected void removeMessageReference(QueueImpl.ConsumerHolder<? extends Consumer> holder,
 MessageReference ref)

refRemoved

protected void refRemoved(MessageReference ref)

addRefSize

protected void addRefSize(MessageReference ref)

refAdded

protected void refAdded(MessageReference ref)

removeWithSuppliedID

public MessageReference removeWithSuppliedID(String serverID,
 long id,
 NodeStoreFactory<MessageReference> nodeStore)

Description copied from interface: Queue

Remove item with a supplied non-negative (>= 0) ID. If the idSupplier returns < 0 the ID is considered a non value (null) and it will be ignored.

Specified by:

removeWithSuppliedID in interface Queue

See Also:

• LinkedList.setNodeStore(NodeStore)

checkRedelivery

public Pair<Boolean,Boolean> checkRedelivery(MessageReference reference,
 long timeBase,
 boolean ignoreRedeliveryDelay)
                                      throws Exception

Description copied from interface: Queue

Returns a Pair of Booleans: the first indicates whether redelivery happened; the second indicates whether or not the message was actually sent to a DLA with bindings.

Specified by:

checkRedelivery in interface Queue

Returns:

a Pair of Booleans: the first indicates whether redelivery happened; the second indicates whether or not the message was actually sent to a DLA with bindings

Throws:

Exception

getNumberOfReferences

public int getNumberOfReferences()

Used on testing only *

sendToDeadLetterAddress

public boolean sendToDeadLetterAddress(Transaction tx,
 MessageReference ref)
                                throws Exception

Description copied from interface: Queue

Returns whether the message was actually sent to a DLA with bindings.

Specified by:

sendToDeadLetterAddress in interface Queue

Returns:

whether the message was actually sent to a DLA with bindings

Throws:

Exception

errorProcessing

public void errorProcessing(Consumer consumer,
 Throwable t,
 MessageReference reference)

This will print errors and decide what to do with the errored consumer from the protocol layer.

Specified by:

errorProcessing in interface Queue

postAcknowledge

public void postAcknowledge(MessageReference ref,
 AckReason reason)

Specified by:

postAcknowledge in interface Queue

postAcknowledge

public void postAcknowledge(MessageReference ref,
 AckReason reason,
 boolean delivering)

The parameter delivering can be sent as false in situation where the ack is coming outside of the context of delivering. Example: Mirror replication will call the ack here without any consumer involved. On that case no previous delivery happened, hence no information about delivering statistics should be updated.

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

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

groupMap

public static MessageGroups<Consumer> groupMap(int groupBuckets)

getQueueConfiguration

public QueueConfiguration getQueueConfiguration()

Specified by:

getQueueConfiguration in interface Queue

incDelivering

public void incDelivering(MessageReference ref)

decDelivering

public void decDelivering(MessageReference reference)