org.apache.activemq.artemis.core.server

Interface Queue

All Superinterfaces:

Bindable

All Known Implementing Classes:

LastValueQueue, QueueImpl

public interface Queue
extends Bindable

Method Summary

Modifier and Type	Method and Description
void	acknowledge(MessageReference ref)
void	acknowledge(MessageReference ref, AckReason reason)
void	acknowledge(Transaction tx, MessageReference ref)
void	acknowledge(Transaction tx, MessageReference ref, AckReason reason)
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)
LinkedListIterator<MessageReference>	browserIterator()
void	cancel(MessageReference reference, long timeBase)
void	cancel(Transaction tx, MessageReference ref)
void	cancel(Transaction tx, MessageReference ref, boolean ignoreRedeliveryCheck)
void	cancelRedistributor()
boolean	changeReferencePriority(long messageID, byte newPriority)
int	changeReferencesPriority(Filter filter, byte newPriority)
boolean	checkRedelivery(MessageReference ref, long timeBase, boolean ignoreRedeliveryDelay)
void	close()
void	decDelivering(int size)
int	deleteAllReferences()
int	deleteAllReferences(int flushLimit)
int	deleteMatchingReferences(Filter filter)
int	deleteMatchingReferences(int flushLImit, Filter filter)
void	deleteQueue()
void	deleteQueue(boolean removeConsumers)
boolean	deleteReference(long messageID)
void	deliverAsync()
void	deliverScheduledMessages() cancels scheduled messages and send them to the head of the queue.
void	destroyPaging()
void	expire(MessageReference ref)
boolean	expireReference(long messageID)
void	expireReferences()
int	expireReferences(Filter filter) Expire all the references in the queue which matches the filter
boolean	flushExecutor()
void	forceDelivery() This method will make sure that any pending message (including paged message) will be delivered
SimpleString	getAddress()
int	getConsumerCount()
Collection<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
Executor	getExecutor()
SimpleString	getExpiryAddress()
Filter	getFilter()
long	getID()
long	getMessageCount()
long	getMessagesAcknowledged()
long	getMessagesAdded()
long	getMessagesExpired()
long	getMessagesKilled()
SimpleString	getName()
PageSubscription	getPageSubscription()
float	getRate()
MessageReference	getReference(long id)
int	getScheduledCount()
List<MessageReference>	getScheduledMessages()
SimpleString	getUser()
boolean	hasMatchingConsumer(ServerMessage message)
void	incrementMesssagesAdded()
boolean	isAutoCreated()
boolean	isDirectDeliver()
boolean	isDurable()
boolean	isInternalQueue() We can't send stuff to DLQ on queues used on clustered-bridge-communication
boolean	isPaused()
boolean	isPersistedPause() if the pause was persisted
boolean	isTemporary()
LinkedListIterator<MessageReference>	iterator() It will iterate thorugh memory only (not paging)
boolean	moveReference(long messageID, SimpleString toAddress)
boolean	moveReference(long messageID, SimpleString toAddress, boolean rejectDuplicates)
int	moveReferences(Filter filter, SimpleString toAddress)
int	moveReferences(int flushLimit, Filter filter, SimpleString toAddress, boolean rejectDuplicates)
void	pause() Pauses the queue.
void	pause(boolean persist) Pauses the queue.
void	postAcknowledge(MessageReference ref)
void	reacknowledge(Transaction tx, MessageReference ref)
void	referenceHandled()
void	reload(MessageReference ref)
void	reloadPause(long recordID)
void	removeConsumer(Consumer consumer)
MessageReference	removeReferenceWithID(long id)
void	resetAllIterators()
void	resetMessagesAcknowledged()
void	resetMessagesAdded()
void	resetMessagesExpired()
void	resetMessagesKilled()
void	resume() Resumes the delivery of message for the queue.
int	retryMessages(Filter filter)
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	setInternalQueue(boolean internalQueue)
void	unproposed(SimpleString groupID)

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

route, routeWithAck

Method Detail

getName

SimpleString getName()

getID

long getID()

getFilter

Filter getFilter()

getPageSubscription

PageSubscription getPageSubscription()

isDurable

boolean isDurable()

isTemporary

boolean isTemporary()

isAutoCreated

boolean isAutoCreated()

addConsumer

void addConsumer(Consumer consumer)
          throws Exception

Throws:

Exception

removeConsumer

void removeConsumer(Consumer consumer)

getConsumerCount

int getConsumerCount()

setConsumersRefCount

void setConsumersRefCount(ReferenceCounter referenceCounter)

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.

getConsumersRefCount

ReferenceCounter getConsumersRefCount()

reload

void reload(MessageReference ref)

addTail

void addTail(MessageReference ref)

addTail

void addTail(MessageReference ref,
             boolean direct)

addHead

void addHead(MessageReference ref,
             boolean scheduling)

addHead

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

acknowledge

void acknowledge(MessageReference ref)
          throws Exception

Throws:

Exception

acknowledge

void acknowledge(MessageReference ref,
                 AckReason reason)
          throws Exception

Throws:

Exception

acknowledge

void acknowledge(Transaction tx,
                 MessageReference ref)
          throws Exception

Throws:

Exception

acknowledge

void acknowledge(Transaction tx,
                 MessageReference ref,
                 AckReason reason)
          throws Exception

Throws:

Exception

reacknowledge

void reacknowledge(Transaction tx,
                   MessageReference ref)
            throws Exception

Throws:

Exception

cancel

void cancel(Transaction tx,
            MessageReference ref)

cancel

void cancel(Transaction tx,
            MessageReference ref,
            boolean ignoreRedeliveryCheck)

cancel

void cancel(MessageReference reference,
            long timeBase)
     throws Exception

Throws:

Exception

deliverAsync

void deliverAsync()

unproposed

void unproposed(SimpleString groupID)

forceDelivery

void forceDelivery()

This method will make sure that any pending message (including paged message) will be delivered

deleteQueue

void deleteQueue()
          throws Exception

Throws:

Exception

deleteQueue

void deleteQueue(boolean removeConsumers)
          throws Exception

Throws:

Exception

destroyPaging

void destroyPaging()
            throws Exception

Throws:

Exception

getMessageCount

long getMessageCount()

getDeliveringCount

int getDeliveringCount()

referenceHandled

void referenceHandled()

getScheduledCount

int getScheduledCount()

getScheduledMessages

List<MessageReference> getScheduledMessages()

getDeliveringMessages

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

Returns:

getMessagesAdded

long getMessagesAdded()

getMessagesAcknowledged

long getMessagesAcknowledged()

getMessagesExpired

long getMessagesExpired()

getMessagesKilled

long getMessagesKilled()

removeReferenceWithID

MessageReference removeReferenceWithID(long id)
                                throws Exception

Throws:

Exception

getReference

MessageReference getReference(long id)
                       throws ActiveMQException

Throws:

ActiveMQException

deleteAllReferences

int deleteAllReferences()
                 throws Exception

Throws:

Exception

deleteAllReferences

int deleteAllReferences(int flushLimit)
                 throws Exception

Throws:

Exception

deleteReference

boolean deleteReference(long messageID)
                 throws Exception

Throws:

Exception

deleteMatchingReferences

int deleteMatchingReferences(Filter filter)
                      throws Exception

Throws:

Exception

deleteMatchingReferences

int deleteMatchingReferences(int flushLImit,
                             Filter filter)
                      throws Exception

Throws:

Exception

expireReference

boolean expireReference(long messageID)
                 throws Exception

Throws:

Exception

expireReferences

int expireReferences(Filter filter)
              throws Exception

Expire all the references in the queue which matches the filter

Throws:

Exception

expireReferences

void expireReferences()
               throws Exception

Throws:

Exception

expire

void expire(MessageReference ref)
     throws Exception

Throws:

Exception

sendMessageToDeadLetterAddress

boolean sendMessageToDeadLetterAddress(long messageID)
                                throws Exception

Throws:

Exception

sendMessagesToDeadLetterAddress

int sendMessagesToDeadLetterAddress(Filter filter)
                             throws Exception

Throws:

Exception

sendToDeadLetterAddress

void sendToDeadLetterAddress(Transaction tx,
                             MessageReference ref)
                      throws Exception

Throws:

Exception

changeReferencePriority

boolean changeReferencePriority(long messageID,
                                byte newPriority)
                         throws Exception

Throws:

Exception

changeReferencesPriority

int changeReferencesPriority(Filter filter,
                             byte newPriority)
                      throws Exception

Throws:

Exception

moveReference

boolean moveReference(long messageID,
                      SimpleString toAddress)
               throws Exception

Throws:

Exception

moveReference

boolean moveReference(long messageID,
                      SimpleString toAddress,
                      boolean rejectDuplicates)
               throws Exception

Throws:

Exception

moveReferences

int moveReferences(Filter filter,
                   SimpleString toAddress)
            throws Exception

Throws:

Exception

moveReferences

int moveReferences(int flushLimit,
                   Filter filter,
                   SimpleString toAddress,
                   boolean rejectDuplicates)
            throws Exception

Throws:

Exception

retryMessages

int retryMessages(Filter filter)
           throws Exception

Throws:

Exception

addRedistributor

void addRedistributor(long delay)

cancelRedistributor

void cancelRedistributor()
                  throws Exception

Throws:

Exception

hasMatchingConsumer

boolean hasMatchingConsumer(ServerMessage message)

getConsumers

Collection<Consumer> getConsumers()

checkRedelivery

boolean checkRedelivery(MessageReference ref,
                        long timeBase,
                        boolean ignoreRedeliveryDelay)
                 throws Exception

Throws:

Exception

iterator

LinkedListIterator<MessageReference> iterator()

It will iterate thorugh memory only (not paging)

Returns:

browserIterator

LinkedListIterator<MessageReference> browserIterator()

getExpiryAddress

SimpleString getExpiryAddress()

pause

void pause()

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()

pause

void pause(boolean persist)

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()

reloadPause

void reloadPause(long recordID)

resume

void resume()

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()

isPaused

boolean isPaused()

Returns:

true if paused, false otherwise.

isPersistedPause

boolean isPersistedPause()

if the pause was persisted

Returns:

getExecutor

Executor getExecutor()

resetAllIterators

void resetAllIterators()

flushExecutor

boolean flushExecutor()

close

void close()
    throws Exception

Throws:

Exception

isDirectDeliver

boolean isDirectDeliver()

getAddress

SimpleString getAddress()

isInternalQueue

boolean isInternalQueue()

We can't send stuff to DLQ on queues used on clustered-bridge-communication

Returns:

setInternalQueue

void setInternalQueue(boolean internalQueue)

resetMessagesAdded

void resetMessagesAdded()

resetMessagesAcknowledged

void resetMessagesAcknowledged()

resetMessagesExpired

void resetMessagesExpired()

resetMessagesKilled

void resetMessagesKilled()

incrementMesssagesAdded

void incrementMesssagesAdded()

deliverScheduledMessages

void deliverScheduledMessages()
                       throws ActiveMQException

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

Throws:

ActiveMQException

postAcknowledge

void postAcknowledge(MessageReference ref)

getRate

float getRate()

getUser

SimpleString getUser()

Returns:

the user who created this queue

decDelivering

void decDelivering(int size)