Package org.apache.activemq.store

Class ProxyTopicMessageStore

java.lang.Object

org.apache.activemq.store.ProxyMessageStore

org.apache.activemq.store.ProxyTopicMessageStore

All Implemented Interfaces:

org.apache.activemq.Service, MessageStore, TopicMessageStore

public class ProxyTopicMessageStore
extends ProxyMessageStore
implements TopicMessageStore

A simple proxy that delegates to another MessageStore.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.activemq.store.MessageStore

MessageStore.StoreType

Constructor Summary

Constructors

Constructor	Description
ProxyTopicMessageStore(TopicMessageStore delegate)

Method Summary

Modifier and Type	Method	Description
void	acknowledge(ConnectionContext context, String clientId, String subscriptionName, org.apache.activemq.command.MessageId messageId, org.apache.activemq.command.MessageAck ack)	Stores the last acknowledged messgeID for the given subscription so that we can recover and commence dispatching messages from the last checkpoint
void	addMessage(ConnectionContext context, org.apache.activemq.command.Message message)	Adds a message to the message store
void	addMessage(ConnectionContext context, org.apache.activemq.command.Message message, boolean canOptimizeHint)	Adds a message to the message store
void	addSubscription(org.apache.activemq.command.SubscriptionInfo subscriptionInfo, boolean retroactive)	Inserts the subscriber info due to a subscription change
ListenableFuture<Object>	asyncAddQueueMessage(ConnectionContext context, org.apache.activemq.command.Message message)	Adds a message to the message store
ListenableFuture<Object>	asyncAddQueueMessage(ConnectionContext context, org.apache.activemq.command.Message message, boolean canOptimizeHint)	Adds a message to the message store
ListenableFuture<Object>	asyncAddTopicMessage(ConnectionContext context, org.apache.activemq.command.Message message)	Adds a message to the message store
ListenableFuture<Object>	asyncAddTopicMessage(ConnectionContext context, org.apache.activemq.command.Message message, boolean canOptimizeHint)	Adds a message to the message store
void	deleteSubscription(String clientId, String subscriptionName)
void	dispose(ConnectionContext context)
org.apache.activemq.command.SubscriptionInfo[]	getAllSubscriptions()	Lists all the durable subscriptions for a given destination.
MessageStore	getDelegate()
org.apache.activemq.command.ActiveMQDestination	getDestination()	The destination that the message store is holding messages for.
org.apache.activemq.command.Message	getMessage(org.apache.activemq.command.MessageId identity)	Looks up a message using either the String messageID or the messageNumber.
int	getMessageCount()
int	getMessageCount(String clientId, String subscriberName)	Get the number of messages ready to deliver from the store to a durable subscriber
long	getMessageSize()
long	getMessageSize(String clientId, String subscriberName)	Get the total size of the messages ready to deliver from the store to the durable subscriber
MessageStoreStatistics	getMessageStoreStatistics()
MessageStoreSubscriptionStatistics	getMessageStoreSubStatistics()	The subscription metrics contained in this store
boolean	isEmpty()	flag to indicate if the store is empty
boolean	isPrioritizedMessages()
org.apache.activemq.command.SubscriptionInfo	lookupSubscription(String clientId, String subscriptionName)	Finds the subscriber entry for the given consumer info
void	recover(MessageRecoveryListener listener)	Recover any messages to be delivered.
Map<SubscriptionKey,List<org.apache.activemq.command.Message>>	recoverExpired(Set<SubscriptionKey> subs, int max, MessageRecoveryListener listener)	Iterates over the pending messages in a topic and recovers any expired messages found for each of the subscriptions up to the maximum number of messages to search.
void	recoverNextMessages(int maxReturned, MessageRecoveryListener listener)
void	recoverNextMessages(String clientId, String subscriptionName, int maxReturned, MessageRecoveryListener listener)	For an active subscription - retrieve messages from the store for the subscriber after the lastMessageId messageId
void	recoverSubscription(String clientId, String subscriptionName, MessageRecoveryListener listener)	For the new subscription find the last acknowledged message ID and then find any new messages since then and dispatch them to the subscription.
void	registerIndexListener(IndexListener indexListener)
void	removeAllMessages(ConnectionContext context)	Removes all the messages from the message store.
void	removeAsyncMessage(ConnectionContext context, org.apache.activemq.command.MessageAck ack)
void	removeMessage(ConnectionContext context, org.apache.activemq.command.MessageAck ack)	Removes a message from the message store.
void	resetBatching()	A hint to the Store to reset any batching state for the Destination
void	resetBatching(String clientId, String subscriptionName)	A hint to the Store to reset any batching state for a durable subscriber
void	setBatch(org.apache.activemq.command.MessageId messageId)	allow caching cursors to set the current batch offset when cache is exhausted
void	setMemoryUsage(org.apache.activemq.usage.MemoryUsage memoryUsage)
void	setPrioritizedMessages(boolean prioritizedMessages)	A hint to the store to try recover messages according to priority
void	start()
void	stop()
void	updateMessage(org.apache.activemq.command.Message message)

Methods inherited from class org.apache.activemq.store.ProxyMessageStore

getType, recoverMessages, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.store.MessageStore

getType, recoverMessages

Constructor Details

ProxyTopicMessageStore

public ProxyTopicMessageStore(TopicMessageStore delegate)

Method Details

getDelegate

public MessageStore getDelegate()

Overrides:

getDelegate in class ProxyMessageStore

addMessage

public void addMessage(ConnectionContext context,
 org.apache.activemq.command.Message message)
                throws IOException

Description copied from interface: MessageStore

Adds a message to the message store

Specified by:

addMessage in interface MessageStore

Overrides:

addMessage in class ProxyMessageStore

Parameters:

context - context

Throws:

IOException

addMessage

public void addMessage(ConnectionContext context,
 org.apache.activemq.command.Message message,
 boolean canOptimizeHint)
                throws IOException

Description copied from interface: MessageStore

Adds a message to the message store

Specified by:

addMessage in interface MessageStore

Overrides:

addMessage in class ProxyMessageStore

Parameters:

context - context

canOptimizeHint - - give a hint to the store that the message may be consumed before it hits the disk

Throws:

IOException

getMessage

public org.apache.activemq.command.Message getMessage(org.apache.activemq.command.MessageId identity)
                                               throws IOException

Description copied from interface: MessageStore

Looks up a message using either the String messageID or the messageNumber. Implementations are encouraged to fill in the missing key if its easy to do so.

Specified by:

getMessage in interface MessageStore

Overrides:

getMessage in class ProxyMessageStore

Parameters:

identity - which contains either the messageID or the messageNumber

Returns:

the message or null if it does not exist

Throws:

IOException

recover

public void recover(MessageRecoveryListener listener)
             throws Exception

Description copied from interface: MessageStore

Recover any messages to be delivered.

Specified by:

recover in interface MessageStore

Overrides:

recover in class ProxyMessageStore

Throws:

Exception

removeAllMessages

public void removeAllMessages(ConnectionContext context)
                       throws IOException

Description copied from interface: MessageStore

Removes all the messages from the message store.

Specified by:

removeAllMessages in interface MessageStore

Overrides:

removeAllMessages in class ProxyMessageStore

Throws:

IOException

removeMessage

public void removeMessage(ConnectionContext context,
 org.apache.activemq.command.MessageAck ack)
                   throws IOException

Description copied from interface: MessageStore

Removes a message from the message store.

Specified by:

removeMessage in interface MessageStore

Overrides:

removeMessage in class ProxyMessageStore

ack - the ack request that cause the message to be removed. It conatins the identity which contains the messageID of the message that needs to be removed.

Throws:

IOException

start

public void start()
           throws Exception

Specified by:

start in interface org.apache.activemq.Service

Overrides:

start in class ProxyMessageStore

Throws:

Exception

stop

public void stop()
          throws Exception

Specified by:

stop in interface org.apache.activemq.Service

Overrides:

stop in class ProxyMessageStore

Throws:

Exception

lookupSubscription

public org.apache.activemq.command.SubscriptionInfo lookupSubscription(String clientId,
 String subscriptionName)
                                                                throws IOException

Description copied from interface: TopicMessageStore

Finds the subscriber entry for the given consumer info

Specified by:

lookupSubscription in interface TopicMessageStore

Returns:

the SubscriptionInfo

Throws:

IOException

acknowledge

public void acknowledge(ConnectionContext context,
 String clientId,
 String subscriptionName,
 org.apache.activemq.command.MessageId messageId,
 org.apache.activemq.command.MessageAck ack)
                 throws IOException

Description copied from interface: TopicMessageStore

Stores the last acknowledged messgeID for the given subscription so that we can recover and commence dispatching messages from the last checkpoint

Specified by:

acknowledge in interface TopicMessageStore

Throws:

IOException

addSubscription

public void addSubscription(org.apache.activemq.command.SubscriptionInfo subscriptionInfo,
 boolean retroactive)
                     throws IOException

Description copied from interface: TopicMessageStore

Inserts the subscriber info due to a subscription change

If this is a new subscription and the retroactive is false, then the last message sent to the topic should be set as the last message acknowledged by they new subscription. Otherwise, if retroactive is true, then create the subscription without it having an acknowledged message so that on recovery, all message recorded for the topic get replayed.

Specified by:

addSubscription in interface TopicMessageStore

Throws:

IOException

deleteSubscription

public void deleteSubscription(String clientId,
 String subscriptionName)
                        throws IOException

Specified by:

deleteSubscription in interface TopicMessageStore

Throws:

IOException

recoverSubscription

public void recoverSubscription(String clientId,
 String subscriptionName,
 MessageRecoveryListener listener)
                         throws Exception

Description copied from interface: TopicMessageStore

For the new subscription find the last acknowledged message ID and then find any new messages since then and dispatch them to the subscription.

e.g. if we dispatched some messages to a new durable topic subscriber, then went down before acknowledging any messages, we need to know the correct point from which to recover from.

Specified by:

recoverSubscription in interface TopicMessageStore

Throws:

Exception

recoverNextMessages

public void recoverNextMessages(String clientId,
 String subscriptionName,
 int maxReturned,
 MessageRecoveryListener listener)
                         throws Exception

Description copied from interface: TopicMessageStore

For an active subscription - retrieve messages from the store for the subscriber after the lastMessageId messageId

Specified by:

recoverNextMessages in interface TopicMessageStore

Throws:

Exception

resetBatching

public void resetBatching(String clientId,
 String subscriptionName)

Description copied from interface: TopicMessageStore

A hint to the Store to reset any batching state for a durable subscriber

Specified by:

resetBatching in interface TopicMessageStore

getDestination

public org.apache.activemq.command.ActiveMQDestination getDestination()

Description copied from interface: MessageStore

The destination that the message store is holding messages for.

Specified by:

getDestination in interface MessageStore

Overrides:

getDestination in class ProxyMessageStore

Returns:

the destination

getAllSubscriptions

public org.apache.activemq.command.SubscriptionInfo[] getAllSubscriptions()
                                                                   throws IOException

Description copied from interface: TopicMessageStore

Lists all the durable subscriptions for a given destination.

Specified by:

getAllSubscriptions in interface TopicMessageStore

Returns:

an array SubscriptionInfos

Throws:

IOException

setMemoryUsage

public void setMemoryUsage(org.apache.activemq.usage.MemoryUsage memoryUsage)

Specified by:

setMemoryUsage in interface MessageStore

Overrides:

setMemoryUsage in class ProxyMessageStore

Parameters:

memoryUsage - The SystemUsage that is controlling the destination's memory usage.

getMessageCount

public int getMessageCount(String clientId,
 String subscriberName)
                    throws IOException

Description copied from interface: TopicMessageStore

Get the number of messages ready to deliver from the store to a durable subscriber

Specified by:

getMessageCount in interface TopicMessageStore

Returns:

the outstanding message count

Throws:

IOException

getMessageCount

public int getMessageCount()
                    throws IOException

Specified by:

getMessageCount in interface MessageStore

Overrides:

getMessageCount in class ProxyMessageStore

Returns:

the number of messages ready to deliver

Throws:

IOException

getMessageSize

public long getMessageSize()
                    throws IOException

Specified by:

getMessageSize in interface MessageStore

Overrides:

getMessageSize in class ProxyMessageStore

Returns:

the size of the messages ready to deliver

Throws:

IOException

recoverNextMessages

public void recoverNextMessages(int maxReturned,
 MessageRecoveryListener listener)
                         throws Exception

Specified by:

recoverNextMessages in interface MessageStore

Overrides:

recoverNextMessages in class ProxyMessageStore

Throws:

Exception

dispose

public void dispose(ConnectionContext context)

Specified by:

dispose in interface MessageStore

Overrides:

dispose in class ProxyMessageStore

resetBatching

public void resetBatching()

Description copied from interface: MessageStore

A hint to the Store to reset any batching state for the Destination

Specified by:

resetBatching in interface MessageStore

Overrides:

resetBatching in class ProxyMessageStore

setBatch

public void setBatch(org.apache.activemq.command.MessageId messageId)
              throws Exception

Description copied from interface: MessageStore

allow caching cursors to set the current batch offset when cache is exhausted

Specified by:

setBatch in interface MessageStore

Overrides:

setBatch in class ProxyMessageStore

Throws:

Exception

isEmpty

public boolean isEmpty()
                throws Exception

Description copied from interface: MessageStore

flag to indicate if the store is empty

Specified by:

isEmpty in interface MessageStore

Overrides:

isEmpty in class ProxyMessageStore

Returns:

true if the message count is 0

Throws:

Exception

asyncAddTopicMessage

public ListenableFuture<Object> asyncAddTopicMessage(ConnectionContext context,
 org.apache.activemq.command.Message message)
                                              throws IOException

Description copied from interface: MessageStore

Adds a message to the message store

Specified by:

asyncAddTopicMessage in interface MessageStore

Overrides:

asyncAddTopicMessage in class ProxyMessageStore

Parameters:

context - context

Returns:

a ListenableFuture to track when this is complete

Throws:

IOException

asyncAddTopicMessage

public ListenableFuture<Object> asyncAddTopicMessage(ConnectionContext context,
 org.apache.activemq.command.Message message,
 boolean canOptimizeHint)
                                              throws IOException

Description copied from interface: MessageStore

Adds a message to the message store

Specified by:

asyncAddTopicMessage in interface MessageStore

Overrides:

asyncAddTopicMessage in class ProxyMessageStore

Parameters:

context - context

canOptimizeHint - - give a hint to the store that the message may be consumed before it hits the disk

Returns:

a ListenableFuture to track when this is complete

Throws:

IOException

asyncAddQueueMessage

public ListenableFuture<Object> asyncAddQueueMessage(ConnectionContext context,
 org.apache.activemq.command.Message message)
                                              throws IOException

Description copied from interface: MessageStore

Adds a message to the message store

Specified by:

asyncAddQueueMessage in interface MessageStore

Overrides:

asyncAddQueueMessage in class ProxyMessageStore

Parameters:

context - context

Returns:

a Future to track when this is complete

Throws:

IOException

asyncAddQueueMessage

public ListenableFuture<Object> asyncAddQueueMessage(ConnectionContext context,
 org.apache.activemq.command.Message message,
 boolean canOptimizeHint)
                                              throws IOException

Description copied from interface: MessageStore

Adds a message to the message store

Specified by:

asyncAddQueueMessage in interface MessageStore

Overrides:

asyncAddQueueMessage in class ProxyMessageStore

Parameters:

context - context

canOptimizeHint - - give a hint to the store that the message may be consumed before it hits the disk

Returns:

a Future to track when this is complete

Throws:

IOException

removeAsyncMessage

public void removeAsyncMessage(ConnectionContext context,
 org.apache.activemq.command.MessageAck ack)
                        throws IOException

Specified by:

removeAsyncMessage in interface MessageStore

Overrides:

removeAsyncMessage in class ProxyMessageStore

Throws:

IOException

setPrioritizedMessages

public void setPrioritizedMessages(boolean prioritizedMessages)

Description copied from interface: MessageStore

A hint to the store to try recover messages according to priority

Specified by:

setPrioritizedMessages in interface MessageStore

Overrides:

setPrioritizedMessages in class ProxyMessageStore

isPrioritizedMessages

public boolean isPrioritizedMessages()

Specified by:

isPrioritizedMessages in interface MessageStore

Overrides:

isPrioritizedMessages in class ProxyMessageStore

Returns:

true if store is trying to recover messages according to priority

updateMessage

public void updateMessage(org.apache.activemq.command.Message message)
                   throws IOException

Specified by:

updateMessage in interface MessageStore

Overrides:

updateMessage in class ProxyMessageStore

Throws:

IOException

registerIndexListener

public void registerIndexListener(IndexListener indexListener)

Specified by:

registerIndexListener in interface MessageStore

Overrides:

registerIndexListener in class ProxyMessageStore

getMessageStoreStatistics

public MessageStoreStatistics getMessageStoreStatistics()

Specified by:

getMessageStoreStatistics in interface MessageStore

Overrides:

getMessageStoreStatistics in class ProxyMessageStore

Returns:

The statistics bean for this message store

getMessageSize

public long getMessageSize(String clientId,
 String subscriberName)
                    throws IOException

Description copied from interface: TopicMessageStore

Get the total size of the messages ready to deliver from the store to the durable subscriber

Specified by:

getMessageSize in interface TopicMessageStore

Returns:

Throws:

IOException

getMessageStoreSubStatistics

public MessageStoreSubscriptionStatistics getMessageStoreSubStatistics()

Description copied from interface: TopicMessageStore

The subscription metrics contained in this store

Specified by:

getMessageStoreSubStatistics in interface TopicMessageStore

Returns:

recoverExpired

public Map<SubscriptionKey,List<org.apache.activemq.command.Message>> recoverExpired(Set<SubscriptionKey> subs,
 int max,
 MessageRecoveryListener listener)
                                                                              throws Exception

Description copied from interface: TopicMessageStore

Iterates over the pending messages in a topic and recovers any expired messages found for each of the subscriptions up to the maximum number of messages to search. Only subscriptions that have at least 1 expired message will be returned in the map.
The expiry listener is only used to verify if there is space. Messages that are expired and will be added to 1 or more subscription in the returned map will be passed to the callback. The callback will only be called once per each unique message.

Specified by:

recoverExpired in interface TopicMessageStore

Parameters:

subs - The subscription keys to check for expired messages

max - The maximum number of messages to check

Returns:

Expired messages for each subscription

Throws:

Exception