org.apache.activemq.broker.region
Class Queue

java.lang.Object
  org.apache.activemq.broker.region.BaseDestination
      org.apache.activemq.broker.region.Queue

All Implemented Interfaces:

Destination, Message.MessageDestination, Service, Task, UsageListener

Direct Known Subclasses:

TempQueue

public class Queue
extends BaseDestination
implements Task, UsageListener

The Queue is a List of MessageEntry objects that are dispatched to matching subscriptions.

Field Summary

protected List<Subscription>	consumers
protected static org.slf4j.Logger	LOG
protected PendingMessageCursor	messages
protected PendingList	pagedInPendingDispatch
protected PendingList	redeliveredWaitingDispatch
protected TaskRunnerFactory	taskFactory
protected TaskRunner	taskRunner

Fields inherited from class org.apache.activemq.broker.region.BaseDestination

blockedProducerWarningInterval, broker, brokerService, cursorMemoryHighWaterMark, deadLetterStrategy, DEFAULT_INACTIVE_TIMEOUT_BEFORE_GC, destination, destinationStatistics, EXPIRE_MESSAGE_PERIOD, expireMessagesPeriod, MAX_AUDIT_DEPTH, MAX_BROWSE_PAGE_SIZE, MAX_PAGE_SIZE, MAX_PRODUCERS_TO_AUDIT, memoryUsage, regionBroker, scheduler, store, storeUsageHighWaterMark, systemUsage, warnOnProducerFlowControl

Fields inherited from interface org.apache.activemq.broker.region.Destination

DEFAULT_BLOCKED_PRODUCER_WARNING_INTERVAL, DEFAULT_DEAD_LETTER_STRATEGY

Constructor Summary

Queue(BrokerService brokerService, ActiveMQDestination destination, MessageStore store, DestinationStatistics parentStats, TaskRunnerFactory taskFactory)

Method Summary

void	acknowledge(ConnectionContext context, Subscription sub, MessageAck ack, MessageReference node)
void	addSubscription(ConnectionContext context, Subscription sub)
protected void	assignGroup(Subscription subs, MessageGroupMap messageGroupOwners, MessageReference n, String groupId)
protected boolean	assignMessageGroup(Subscription subscription, QueueMessageReference node)
Message[]	browse()
void	clearPendingMessages()
int	copyMatchingMessages(ConnectionContext context, MessageReferenceFilter filter, ActiveMQDestination dest, int maximumMessages) Copies the messages matching the given filter up to the maximum number of matched messages
int	copyMatchingMessagesTo(ConnectionContext context, String selector, ActiveMQDestination dest) Copies the messages matching the given selector
int	copyMatchingMessagesTo(ConnectionContext context, String selector, ActiveMQDestination dest, int maximumMessages) Copies the messages matching the given selector up to the maximum number of matched messages
boolean	copyMessageTo(ConnectionContext context, String messageId, ActiveMQDestination dest) Copies the message matching the given messageId
protected MessageReferenceFilter	createMessageIdFilter(String messageId)
protected MessageReferenceFilter	createSelectorFilter(String selector)
void	doBrowse(List<Message> browseList, int max)
void	gc()
ActiveMQDestination	getActiveMQDestination()
List<Subscription>	getConsumers()
int	getConsumersBeforeDispatchStarts()
DispatchPolicy	getDispatchPolicy()
protected org.slf4j.Logger	getLog()
QueueMessageReference	getMessage(String id)
MessageGroupMapFactory	getMessageGroupMapFactory()
MessageGroupMap	getMessageGroupOwners()
PendingMessageCursor	getMessages()
int	getTimeBeforeDispatchStarts()
void	initialize() initialize the destination
boolean	isAllConsumersExclusiveByDefault()
boolean	isOptimizedDispatch()
protected boolean	isOptimizeStorage()
boolean	isStrictOrderDispatch()
boolean	isUseConsumerPriority()
boolean	iterate()
void	messageExpired(ConnectionContext context, MessageReference reference)
void	messageExpired(ConnectionContext context, Subscription subs, MessageReference reference) Inform the Destination a message has expired
int	moveMatchingMessagesTo(ConnectionContext context, MessageReferenceFilter filter, ActiveMQDestination dest, int maximumMessages) Moves the messages matching the given filter up to the maximum number of matched messages
int	moveMatchingMessagesTo(ConnectionContext context, String selector, ActiveMQDestination dest) Moves the messages matching the given selector
int	moveMatchingMessagesTo(ConnectionContext context, String selector, ActiveMQDestination dest, int maximumMessages) Moves the messages matching the given selector up to the maximum number of matched messages
boolean	moveMessageTo(ConnectionContext context, QueueMessageReference m, ActiveMQDestination dest) Move a message
boolean	moveMessageTo(ConnectionContext context, String messageId, ActiveMQDestination dest) Moves the message matching the given messageId
void	onUsageChanged(Usage usage, int oldPercentUsage, int newPercentUsage)
protected void	pageInMessages(boolean force)
void	processDispatchNotification(MessageDispatchNotification messageDispatchNotification) called on Queues in slave mode to allow dispatch to follow subscription choice of master
void	purge()
int	removeMatchingMessages(MessageReferenceFilter filter, int maximumMessages) Removes the messages matching the given filter up to the maximum number of matched messages
int	removeMatchingMessages(String selector) Removes the messages matching the given selector
int	removeMatchingMessages(String selector, int maximumMessages) Removes the messages matching the given selector up to the maximum number of matched messages
protected void	removeMessage(ConnectionContext c, QueueMessageReference r)
protected void	removeMessage(ConnectionContext c, Subscription subs, QueueMessageReference r)
protected void	removeMessage(ConnectionContext context, Subscription sub, QueueMessageReference reference, MessageAck ack)
boolean	removeMessage(String messageId) Removes the message matching the given messageId
void	removeSubscription(ConnectionContext context, Subscription sub, long lastDeiveredSequenceId)
int	retryMessages(ConnectionContext context, int maximumMessages)
void	send(ProducerBrokerExchange producerExchange, Message message)
void	setAllConsumersExclusiveByDefault(boolean allConsumersExclusiveByDefault)
void	setConsumersBeforeDispatchStarts(int consumersBeforeDispatchStarts)
void	setDispatchPolicy(DispatchPolicy dispatchPolicy)
void	setMessageGroupMapFactory(MessageGroupMapFactory messageGroupMapFactory)
void	setMessages(PendingMessageCursor messages)
void	setOptimizedDispatch(boolean optimizedDispatch)
void	setPrioritizedMessages(boolean prioritizedMessages)
void	setStrictOrderDispatch(boolean strictOrderDispatch)
void	setTimeBeforeDispatchStarts(int timeBeforeDispatchStarts)
void	setUseConsumerPriority(boolean useConsumerPriority)
void	start()
void	stop()
String	toString()
void	wakeup() optionally called by a Subscriber - to inform the Destination its ready for more messages

Methods inherited from class org.apache.activemq.broker.region.BaseDestination

addProducer, canGC, convertToNonRangedAck, createConnectionContext, dispose, fastProducer, getBlockedProducerWarningInterval, getCursorMemoryHighWaterMark, getDeadLetterStrategy, getDestinationSequenceId, getDestinationStatistics, getExpireMessagesPeriod, getInactiveTimoutBeforeGC, getMaxAuditDepth, getMaxBrowsePageSize, getMaxExpirePageSize, getMaxPageSize, getMaxProducersToAudit, getMemoryUsage, getMessageStore, getMinimumMessageSize, getName, getOptimizeMessageStoreInFlightLimit, getSlowConsumerStrategy, getStoreUsageHighWaterMark, hasRegularConsumers, isActive, isAdvisoryForConsumed, isAdvisoryForDelivery, isAdvisoryForDiscardingMessages, isAdvisoryForFastProducers, isAdvisoryForSlowConsumers, isAdvisoryWhenFull, isAlwaysRetroactive, isDisposed, isDLQ, isDoOptimzeMessageStorage, isEnableAudit, isFull, isGcIfInactive, isGcWithNetworkConsumers, isLazyDispatch, isPrioritizedMessages, isProducerFlowControl, isReduceMemoryFootprint, isSendAdvisoryIfNoConsumers, isUseCache, markForGC, messageConsumed, messageDelivered, messageDiscarded, onMessageWithNoConsumers, removeProducer, setAdvisoryForConsumed, setAdvisoryForDelivery, setAdvisoryForDiscardingMessages, setAdvisoryForFastProducers, setAdvisoryForSlowConsumers, setAdvisoryWhenFull, setAlwaysRetroactive, setBlockedProducerWarningInterval, setCursorMemoryHighWaterMark, setDeadLetterStrategy, setDoOptimzeMessageStorage, setEnableAudit, setExpireMessagesPeriod, setGcIfInactive, setGcWithNetworkConsumers, setInactiveTimoutBeforeGC, setLazyDispatch, setMaxAuditDepth, setMaxBrowsePageSize, setMaxExpirePageSize, setMaxPageSize, setMaxProducersToAudit, setMemoryUsage, setMinimumMessageSize, setOptimizeMessageStoreInFlightLimit, setProducerFlowControl, setReduceMemoryFootprint, setSendAdvisoryIfNoConsumers, setSlowConsumerStrategy, setStoreUsageHighWaterMark, setUseCache, slowConsumer, waitForSpace, waitForSpace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LOG

protected static final org.slf4j.Logger LOG

taskFactory

protected final TaskRunnerFactory taskFactory

taskRunner

protected TaskRunner taskRunner

consumers

protected final List<Subscription> consumers

messages

protected PendingMessageCursor messages

pagedInPendingDispatch

protected PendingList pagedInPendingDispatch

redeliveredWaitingDispatch

protected PendingList redeliveredWaitingDispatch

Constructor Detail

Queue

public Queue(BrokerService brokerService,
             ActiveMQDestination destination,
             MessageStore store,
             DestinationStatistics parentStats,
             TaskRunnerFactory taskFactory)
      throws Exception

Throws:

Exception

Method Detail

getConsumers

public List<Subscription> getConsumers()

Specified by:

getConsumers in interface Destination

Specified by:

getConsumers in class BaseDestination

setPrioritizedMessages

public void setPrioritizedMessages(boolean prioritizedMessages)

Overrides:

setPrioritizedMessages in class BaseDestination

initialize

public void initialize()
                throws Exception

Description copied from class: BaseDestination

initialize the destination

Overrides:

initialize in class BaseDestination

Throws:

Exception

addSubscription

public void addSubscription(ConnectionContext context,
                            Subscription sub)
                     throws Exception

Specified by:

addSubscription in interface Destination

Overrides:

addSubscription in class BaseDestination

Throws:

Exception

removeSubscription

public void removeSubscription(ConnectionContext context,
                               Subscription sub,
                               long lastDeiveredSequenceId)
                        throws Exception

Specified by:

removeSubscription in interface Destination

Overrides:

removeSubscription in class BaseDestination

Throws:

Exception

send

public void send(ProducerBrokerExchange producerExchange,
                 Message message)
          throws Exception

Specified by:

send in interface Destination

Throws:

Exception

gc

public void gc()

Specified by:

gc in interface Destination

acknowledge

public void acknowledge(ConnectionContext context,
                        Subscription sub,
                        MessageAck ack,
                        MessageReference node)
                 throws IOException

Specified by:

acknowledge in interface Destination

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

start

public void start()
           throws Exception

Specified by:

start in interface Service

Throws:

Exception

stop

public void stop()
          throws Exception

Specified by:

stop in interface Service

Throws:

Exception

getActiveMQDestination

public ActiveMQDestination getActiveMQDestination()

Specified by:

getActiveMQDestination in interface Destination

Overrides:

getActiveMQDestination in class BaseDestination

getMessageGroupOwners

public MessageGroupMap getMessageGroupOwners()

getDispatchPolicy

public DispatchPolicy getDispatchPolicy()

setDispatchPolicy

public void setDispatchPolicy(DispatchPolicy dispatchPolicy)

getMessageGroupMapFactory

public MessageGroupMapFactory getMessageGroupMapFactory()

setMessageGroupMapFactory

public void setMessageGroupMapFactory(MessageGroupMapFactory messageGroupMapFactory)

getMessages

public PendingMessageCursor getMessages()

setMessages

public void setMessages(PendingMessageCursor messages)

isUseConsumerPriority

public boolean isUseConsumerPriority()

setUseConsumerPriority

public void setUseConsumerPriority(boolean useConsumerPriority)

isStrictOrderDispatch

public boolean isStrictOrderDispatch()

setStrictOrderDispatch

public void setStrictOrderDispatch(boolean strictOrderDispatch)

isOptimizedDispatch

public boolean isOptimizedDispatch()

setOptimizedDispatch

public void setOptimizedDispatch(boolean optimizedDispatch)

getTimeBeforeDispatchStarts

public int getTimeBeforeDispatchStarts()

setTimeBeforeDispatchStarts

public void setTimeBeforeDispatchStarts(int timeBeforeDispatchStarts)

getConsumersBeforeDispatchStarts

public int getConsumersBeforeDispatchStarts()

setConsumersBeforeDispatchStarts

public void setConsumersBeforeDispatchStarts(int consumersBeforeDispatchStarts)

setAllConsumersExclusiveByDefault

public void setAllConsumersExclusiveByDefault(boolean allConsumersExclusiveByDefault)

isAllConsumersExclusiveByDefault

public boolean isAllConsumersExclusiveByDefault()

browse

public Message[] browse()

Specified by:

browse in interface Destination

doBrowse

public void doBrowse(List<Message> browseList,
                     int max)

getMessage

public QueueMessageReference getMessage(String id)

purge

public void purge()
           throws Exception

Throws:

Exception

clearPendingMessages

public void clearPendingMessages()

Specified by:

clearPendingMessages in interface Destination

removeMessage

public boolean removeMessage(String messageId)
                      throws Exception

Removes the message matching the given messageId

Throws:

Exception

removeMatchingMessages

public int removeMatchingMessages(String selector)
                           throws Exception

Removes the messages matching the given selector

Returns:

the number of messages removed

Throws:

Exception

removeMatchingMessages

public int removeMatchingMessages(String selector,
                                  int maximumMessages)
                           throws Exception

Removes the messages matching the given selector up to the maximum number of matched messages

Returns:

the number of messages removed

Throws:

Exception

removeMatchingMessages

public int removeMatchingMessages(MessageReferenceFilter filter,
                                  int maximumMessages)
                           throws Exception

Removes the messages matching the given filter up to the maximum number of matched messages

Returns:

the number of messages removed

Throws:

Exception

copyMessageTo

public boolean copyMessageTo(ConnectionContext context,
                             String messageId,
                             ActiveMQDestination dest)
                      throws Exception

Copies the message matching the given messageId

Throws:

Exception

copyMatchingMessagesTo

public int copyMatchingMessagesTo(ConnectionContext context,
                                  String selector,
                                  ActiveMQDestination dest)
                           throws Exception

Copies the messages matching the given selector

Returns:

the number of messages copied

Throws:

Exception

copyMatchingMessagesTo

public int copyMatchingMessagesTo(ConnectionContext context,
                                  String selector,
                                  ActiveMQDestination dest,
                                  int maximumMessages)
                           throws Exception

Copies the messages matching the given selector up to the maximum number of matched messages

Returns:

the number of messages copied

Throws:

Exception

copyMatchingMessages

public int copyMatchingMessages(ConnectionContext context,
                                MessageReferenceFilter filter,
                                ActiveMQDestination dest,
                                int maximumMessages)
                         throws Exception

Copies the messages matching the given filter up to the maximum number of matched messages

Returns:

the number of messages copied

Throws:

Exception

moveMessageTo

public boolean moveMessageTo(ConnectionContext context,
                             QueueMessageReference m,
                             ActiveMQDestination dest)
                      throws Exception

Move a message

Parameters:

context - connection context

m - QueueMessageReference

dest - ActiveMQDestination

Throws:

Exception

moveMessageTo

public boolean moveMessageTo(ConnectionContext context,
                             String messageId,
                             ActiveMQDestination dest)
                      throws Exception

Moves the message matching the given messageId

Throws:

Exception

moveMatchingMessagesTo

public int moveMatchingMessagesTo(ConnectionContext context,
                                  String selector,
                                  ActiveMQDestination dest)
                           throws Exception

Moves the messages matching the given selector

Returns:

the number of messages removed

Throws:

Exception

moveMatchingMessagesTo

public int moveMatchingMessagesTo(ConnectionContext context,
                                  String selector,
                                  ActiveMQDestination dest,
                                  int maximumMessages)
                           throws Exception

Moves the messages matching the given selector up to the maximum number of matched messages

Throws:

Exception

moveMatchingMessagesTo

public int moveMatchingMessagesTo(ConnectionContext context,
                                  MessageReferenceFilter filter,
                                  ActiveMQDestination dest,
                                  int maximumMessages)
                           throws Exception

Moves the messages matching the given filter up to the maximum number of matched messages

Throws:

Exception

retryMessages

public int retryMessages(ConnectionContext context,
                         int maximumMessages)
                  throws Exception

Throws:

Exception

iterate

public boolean iterate()

Specified by:

iterate in interface Task

Returns:

true if we would like to iterate again

See Also:

Task.iterate()

createMessageIdFilter

protected MessageReferenceFilter createMessageIdFilter(String messageId)

createSelectorFilter

protected MessageReferenceFilter createSelectorFilter(String selector)
                                               throws javax.jms.InvalidSelectorException

Throws:

javax.jms.InvalidSelectorException

removeMessage

protected void removeMessage(ConnectionContext c,
                             QueueMessageReference r)
                      throws IOException

Throws:

IOException

removeMessage

protected void removeMessage(ConnectionContext c,
                             Subscription subs,
                             QueueMessageReference r)
                      throws IOException

Throws:

IOException

removeMessage

protected void removeMessage(ConnectionContext context,
                             Subscription sub,
                             QueueMessageReference reference,
                             MessageAck ack)
                      throws IOException

Throws:

IOException

messageExpired

public void messageExpired(ConnectionContext context,
                           MessageReference reference)

messageExpired

public void messageExpired(ConnectionContext context,
                           Subscription subs,
                           MessageReference reference)

Description copied from interface: Destination

Inform the Destination a message has expired

Specified by:

messageExpired in interface Destination

wakeup

public void wakeup()

Description copied from interface: Destination

optionally called by a Subscriber - to inform the Destination its ready for more messages

Specified by:

wakeup in interface Destination

assignMessageGroup

protected boolean assignMessageGroup(Subscription subscription,
                                     QueueMessageReference node)
                              throws Exception

Throws:

Exception

assignGroup

protected void assignGroup(Subscription subs,
                           MessageGroupMap messageGroupOwners,
                           MessageReference n,
                           String groupId)
                    throws IOException

Throws:

IOException

pageInMessages

protected void pageInMessages(boolean force)
                       throws Exception

Throws:

Exception

processDispatchNotification

public void processDispatchNotification(MessageDispatchNotification messageDispatchNotification)
                                 throws Exception

Description copied from interface: Destination

called on Queues in slave mode to allow dispatch to follow subscription choice of master

Specified by:

processDispatchNotification in interface Destination

Overrides:

processDispatchNotification in class BaseDestination

Throws:

Exception

onUsageChanged

public void onUsageChanged(Usage usage,
                           int oldPercentUsage,
                           int newPercentUsage)

Specified by:

onUsageChanged in interface UsageListener

getLog

protected org.slf4j.Logger getLog()

Specified by:

getLog in class BaseDestination

isOptimizeStorage

protected boolean isOptimizeStorage()