org.apache.activemq.broker.region
Interface Subscription

All Superinterfaces:

SubscriptionRecovery

All Known Implementing Classes:

AbstractSubscription, DurableTopicSubscription, PrefetchSubscription, QueueBrowserSubscription, QueueSubscription, TopicSubscription

public interface Subscription
extends SubscriptionRecovery

Method Summary

void	acknowledge(ConnectionContext context, MessageAck ack) Used when client acknowledge receipt of dispatched message.
void	add(ConnectionContext context, Destination destination) The subscription will be receiving messages from the destination.
void	add(MessageReference node) Used to add messages that match the subscription.
int	countBeforeFull()
void	destroy() Called when the subscription is destroyed.
void	gc() The subscription should release as may references as it can to help the garbage collector reclaim memory.
ConsumerInfo	getConsumerInfo() The ConsumerInfo object that created the subscription.
ConnectionContext	getContext()
int	getCursorMemoryHighWaterMark()
long	getDequeueCounter()
long	getDispatchedCounter()
int	getDispatchedQueueSize()
long	getEnqueueCounter()
int	getInFlightSize()
int	getInFlightUsage()
javax.management.ObjectName	getObjectName()
int	getPendingQueueSize()
int	getPrefetchSize()
java.lang.String	getSelector()
boolean	isBrowser()
boolean	isFull()
boolean	isHighWaterMark()
boolean	isLowWaterMark()
boolean	isRecoveryRequired() Informs the Broker if the subscription needs to intervention to recover it's state e.g.
boolean	isSlave()
boolean	isSlowConsumer()
boolean	matches(ActiveMQDestination destination) Is the subscription interested in messages in the destination?
boolean	matches(MessageReference node, MessageEvaluationContext context) Is the subscription interested in the message?
void	processMessageDispatchNotification(MessageDispatchNotification mdn) Used by a Slave Broker to update dispatch infomation
Response	pullMessage(ConnectionContext context, MessagePull pull) Allows a consumer to pull a message on demand
java.util.List<MessageReference>	remove(ConnectionContext context, Destination destination) The subscription will be no longer be receiving messages from the destination.
void	setCursorMemoryHighWaterMark(int cursorMemoryHighWaterMark)
void	setObjectName(javax.management.ObjectName objectName) Set when the subscription is registered in JMX
void	setSelector(java.lang.String selector) Attempts to change the current active selector on the subscription.
void	unmatched(MessageReference node)
void	updateConsumerPrefetch(int newPrefetch) inform the MessageConsumer on the client to change it's prefetch

Methods inherited from interface org.apache.activemq.broker.region.SubscriptionRecovery

addRecoveredMessage, getActiveMQDestination

Method Detail

add

void add(MessageReference node)
         throws java.lang.Exception

Used to add messages that match the subscription.

Parameters:

node -

Throws:

java.lang.Exception

java.lang.InterruptedException

java.io.IOException

acknowledge

void acknowledge(ConnectionContext context,
                 MessageAck ack)
                 throws java.lang.Exception

Used when client acknowledge receipt of dispatched message.

Parameters:

node -

Throws:

java.io.IOException

java.lang.Exception

pullMessage

Response pullMessage(ConnectionContext context,
                     MessagePull pull)
                     throws java.lang.Exception

Allows a consumer to pull a message on demand

Throws:

java.lang.Exception

matches

boolean matches(MessageReference node,
                MessageEvaluationContext context)
                throws java.io.IOException

Is the subscription interested in the message?

Parameters:

node -

context -

Returns:

Throws:

java.io.IOException

matches

boolean matches(ActiveMQDestination destination)

Is the subscription interested in messages in the destination?

Parameters:

context -

Returns:

add

void add(ConnectionContext context,
         Destination destination)
         throws java.lang.Exception

The subscription will be receiving messages from the destination.

Parameters:

context -

destination -

Throws:

java.lang.Exception

remove

java.util.List<MessageReference> remove(ConnectionContext context,
                                        Destination destination)
                                        throws java.lang.Exception

The subscription will be no longer be receiving messages from the destination.

Parameters:

context -

destination -

Returns:

a list of un-acked messages that were added to the subscription.

Throws:

java.lang.Exception

getConsumerInfo

ConsumerInfo getConsumerInfo()

The ConsumerInfo object that created the subscription.

Parameters:

destination -

gc

void gc()

The subscription should release as may references as it can to help the garbage collector reclaim memory.

processMessageDispatchNotification

void processMessageDispatchNotification(MessageDispatchNotification mdn)
                                        throws java.lang.Exception

Used by a Slave Broker to update dispatch infomation

Parameters:

mdn -

Throws:

java.lang.Exception

isSlave

boolean isSlave()

Returns:

true if the broker is currently in slave mode

getPendingQueueSize

int getPendingQueueSize()

Returns:

number of messages pending delivery

getDispatchedQueueSize

int getDispatchedQueueSize()

Returns:

number of messages dispatched to the client

getDispatchedCounter

long getDispatchedCounter()

Returns:

number of messages dispatched to the client

getEnqueueCounter

long getEnqueueCounter()

Returns:

number of messages that matched the subscription

getDequeueCounter

long getDequeueCounter()

Returns:

number of messages queued by the client

getSelector

java.lang.String getSelector()

Returns:

the JMS selector on the current subscription

setSelector

void setSelector(java.lang.String selector)
                 throws javax.jms.InvalidSelectorException,
                        java.lang.UnsupportedOperationException

Attempts to change the current active selector on the subscription. This operation is not supported for persistent topics.

Throws:

javax.jms.InvalidSelectorException

java.lang.UnsupportedOperationException

getObjectName

javax.management.ObjectName getObjectName()

Returns:

the JMX object name that this subscription was registered as if applicable

setObjectName

void setObjectName(javax.management.ObjectName objectName)

Set when the subscription is registered in JMX

isLowWaterMark

boolean isLowWaterMark()

Returns:

true when 60% or more room is left for dispatching messages

isHighWaterMark

boolean isHighWaterMark()

Returns:

true when 10% or less room is left for dispatching messages

isFull

boolean isFull()

Returns:

true if there is no space to dispatch messages

updateConsumerPrefetch

void updateConsumerPrefetch(int newPrefetch)

inform the MessageConsumer on the client to change it's prefetch

Parameters:

newPrefetch -

destroy

void destroy()

Called when the subscription is destroyed.

getPrefetchSize

int getPrefetchSize()

Returns:

the prefetch size that is configured for the subscription

getInFlightSize

int getInFlightSize()

Returns:

the number of messages awaiting acknowledgement

getInFlightUsage

int getInFlightUsage()

Returns:

the in flight messages as a percentage of the prefetch size

isRecoveryRequired

boolean isRecoveryRequired()

Informs the Broker if the subscription needs to intervention to recover it's state e.g. DurableTopicSubscriber may do

Returns:

true if recovery required

See Also:

org.apache.activemq.region.cursors.PendingMessageCursor

isBrowser

boolean isBrowser()

Returns:

true if a browser

countBeforeFull

int countBeforeFull()

Returns:

the number of messages this subscription can accept before its full

getContext

ConnectionContext getContext()

getCursorMemoryHighWaterMark

int getCursorMemoryHighWaterMark()

setCursorMemoryHighWaterMark

void setCursorMemoryHighWaterMark(int cursorMemoryHighWaterMark)

isSlowConsumer

boolean isSlowConsumer()

unmatched

void unmatched(MessageReference node)
               throws java.io.IOException

Throws:

java.io.IOException