org.apache.activemq.store
Class ProxyTopicMessageStore

java.lang.Object
  extended by org.apache.activemq.store.ProxyTopicMessageStore
All Implemented Interfaces:
Service, MessageStore, TopicMessageStore

public class ProxyTopicMessageStore
extends Object
implements TopicMessageStore

A simple proxy that delegates to another MessageStore.


Constructor Summary
ProxyTopicMessageStore(TopicMessageStore delegate)
           
 
Method Summary
 void acknowledge(ConnectionContext context, String clientId, String subscriptionName, MessageId messageId, 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, Message message)
          Adds a message to the message store
 void addMessage(ConnectionContext context, Message message, boolean canOptimizeHint)
          Adds a message to the message store
 void addSubsciption(SubscriptionInfo subscriptionInfo, boolean retroactive)
          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.

 Future<Object> asyncAddQueueMessage(ConnectionContext context, Message message)
          Adds a message to the message store
 Future<Object> asyncAddQueueMessage(ConnectionContext context, Message message, boolean canOptimizeHint)
          Adds a message to the message store
 Future<Object> asyncAddTopicMessage(ConnectionContext context, Message message)
          Adds a message to the message store
 Future<Object> asyncAddTopicMessage(ConnectionContext context, Message message, boolean canOptimizeHint)
          Adds a message to the message store
 void deleteSubscription(String clientId, String subscriptionName)
           
 void dispose(ConnectionContext context)
           
 SubscriptionInfo[] getAllSubscriptions()
          Lists all the durable subscriptions for a given destination.
 MessageStore getDelegate()
           
 ActiveMQDestination getDestination()
          The destination that the message store is holding messages for.
 Message getMessage(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
 boolean isEmpty()
          flag to indicate if the store is empty
 boolean isPrioritizedMessages()
           
 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.
 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 removeAllMessages(ConnectionContext context)
          Removes all the messages from the message store.
 void removeAsyncMessage(ConnectionContext context, MessageAck ack)
           
 void removeMessage(ConnectionContext context, 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(MessageId messageId)
          allow caching cursors to set the current batch offset when cache is exhausted
 void setMemoryUsage(MemoryUsage memoryUsage)
           
 void setPrioritizedMessages(boolean prioritizedMessages)
          A hint to the store to try recover messages according to priority
 void start()
           
 void stop()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProxyTopicMessageStore

public ProxyTopicMessageStore(TopicMessageStore delegate)
Method Detail

getDelegate

public MessageStore getDelegate()

addMessage

public void addMessage(ConnectionContext context,
                       Message message)
                throws IOException
Description copied from interface: MessageStore
Adds a message to the message store

Specified by:
addMessage in interface MessageStore
Parameters:
context - context
Throws:
IOException

addMessage

public void addMessage(ConnectionContext context,
                       Message message,
                       boolean canOptimizeHint)
                throws IOException
Description copied from interface: MessageStore
Adds a message to the message store

Specified by:
addMessage in interface MessageStore
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 Message getMessage(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
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
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
Throws:
IOException

removeMessage

public void removeMessage(ConnectionContext context,
                          MessageAck ack)
                   throws IOException
Description copied from interface: MessageStore
Removes a message from the message store.

Specified by:
removeMessage in interface MessageStore
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 Service
Throws:
Exception

stop

public void stop()
          throws Exception
Specified by:
stop in interface Service
Throws:
Exception

lookupSubscription

public 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,
                        MessageId messageId,
                        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

addSubsciption

public void addSubsciption(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:
addSubsciption 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 ActiveMQDestination getDestination()
Description copied from interface: MessageStore
The destination that the message store is holding messages for.

Specified by:
getDestination in interface MessageStore
Returns:
the destination

getAllSubscriptions

public 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(MemoryUsage memoryUsage)
Specified by:
setMemoryUsage in interface MessageStore
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
Returns:
the number of messages ready to deliver
Throws:
IOException

recoverNextMessages

public void recoverNextMessages(int maxReturned,
                                MessageRecoveryListener listener)
                         throws Exception
Specified by:
recoverNextMessages in interface MessageStore
Throws:
Exception

dispose

public void dispose(ConnectionContext context)
Specified by:
dispose in interface MessageStore

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

setBatch

public void setBatch(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
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
Returns:
true if the message count is 0
Throws:
Exception

asyncAddTopicMessage

public Future<Object> asyncAddTopicMessage(ConnectionContext context,
                                           Message message)
                                    throws IOException
Description copied from interface: MessageStore
Adds a message to the message store

Specified by:
asyncAddTopicMessage in interface MessageStore
Parameters:
context - context
Returns:
a Future to track when this is complete
Throws:
IOException

asyncAddTopicMessage

public Future<Object> asyncAddTopicMessage(ConnectionContext context,
                                           Message message,
                                           boolean canOptimizeHint)
                                    throws IOException
Description copied from interface: MessageStore
Adds a message to the message store

Specified by:
asyncAddTopicMessage in interface MessageStore
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

asyncAddQueueMessage

public Future<Object> asyncAddQueueMessage(ConnectionContext context,
                                           Message message)
                                    throws IOException
Description copied from interface: MessageStore
Adds a message to the message store

Specified by:
asyncAddQueueMessage in interface MessageStore
Parameters:
context - context
Returns:
a Future to track when this is complete
Throws:
IOException

asyncAddQueueMessage

public Future<Object> asyncAddQueueMessage(ConnectionContext context,
                                           Message message,
                                           boolean canOptimizeHint)
                                    throws IOException
Description copied from interface: MessageStore
Adds a message to the message store

Specified by:
asyncAddQueueMessage in interface MessageStore
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,
                               MessageAck ack)
                        throws IOException
Specified by:
removeAsyncMessage in interface MessageStore
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

isPrioritizedMessages

public boolean isPrioritizedMessages()
Specified by:
isPrioritizedMessages in interface MessageStore
Returns:
true if store is trying to recover messages according to priority


Copyright © 2005-2013 The Apache Software Foundation. All Rights Reserved.