org.apache.activemq.store.journal
Class JournalTopicMessageStore

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

public class JournalTopicMessageStore
extends JournalMessageStore
implements TopicMessageStore

A MessageStore that uses a Journal to store it's messages.

Version:
$Revision: 1.13 $

Field Summary
 
Fields inherited from class org.apache.activemq.store.journal.JournalMessageStore
destination, inFlightTxLocations, lastLocation, peristenceAdapter, transactionStore, transactionTemplate
 
Constructor Summary
JournalTopicMessageStore(JournalPersistenceAdapter adapter, TopicMessageStore checkpointStore, ActiveMQTopic destinationName)
           
 
Method Summary
 void acknowledge(ConnectionContext context, String clientId, String subscriptionName, MessageId messageId)
          Stores the last acknowledged messgeID for the given subscription so that we can recover and commence dispatching messages from the last checkpoint
protected  void acknowledge(MessageId messageId, org.apache.activeio.journal.RecordLocation location, SubscriptionKey key)
           
 void addMessage(ConnectionContext context, Message message)
          Not synchronized since the Journal has better throughput if you increase the number of concurrent writes that it is doing.
 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.

 org.apache.activeio.journal.RecordLocation checkpoint()
           
 void deleteSubscription(String clientId, String subscriptionName)
           
 SubscriptionInfo[] getAllSubscriptions()
          Lists all the durable subscriptions for a given destination.
 TopicMessageStore getLongTermTopicMessageStore()
           
 int getMessageCount(String clientId, String subscriberName)
          Get the number of messages ready to deliver from the store to a durable subscriber
 SubscriptionInfo lookupSubscription(String clientId, String subscriptionName)
          Finds the subscriber entry for the given consumer info
 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 replayAcknowledge(ConnectionContext context, String clientId, String subscritionName, MessageId messageId)
           
 void resetBatching(String clientId, String subscriptionName)
          A hint to the Store to reset any batching state for a durable subsriber
 
Methods inherited from class org.apache.activemq.store.journal.JournalMessageStore
addMessageReference, checkpoint, getDestination, getLongTermMessageStore, getMessage, getMessageCount, getMessageReference, recover, recoverNextMessages, removeAllMessages, removeMessage, replayAddMessage, replayRemoveMessage, resetBatching, setMemoryUsage, start, stop
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.activemq.store.MessageStore
getDestination, getMessage, getMessageCount, recover, recoverNextMessages, removeAllMessages, removeMessage, resetBatching, setMemoryUsage
 
Methods inherited from interface org.apache.activemq.Service
start, stop
 

Constructor Detail

JournalTopicMessageStore

public JournalTopicMessageStore(JournalPersistenceAdapter adapter,
                                TopicMessageStore checkpointStore,
                                ActiveMQTopic destinationName)
Method Detail

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

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

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

addMessage

public void addMessage(ConnectionContext context,
                       Message message)
                throws IOException
Description copied from class: JournalMessageStore
Not synchronized since the Journal has better throughput if you increase the number of concurrent writes that it is doing.

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

acknowledge

public void acknowledge(ConnectionContext context,
                        String clientId,
                        String subscriptionName,
                        MessageId messageId)
                 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

replayAcknowledge

public void replayAcknowledge(ConnectionContext context,
                              String clientId,
                              String subscritionName,
                              MessageId messageId)

acknowledge

protected void acknowledge(MessageId messageId,
                           org.apache.activeio.journal.RecordLocation location,
                           SubscriptionKey key)
Parameters:
messageId -
location -
key -

checkpoint

public org.apache.activeio.journal.RecordLocation checkpoint()
                                                      throws IOException
Overrides:
checkpoint in class JournalMessageStore
Returns:
Throws:
IOException

getLongTermTopicMessageStore

public TopicMessageStore getLongTermTopicMessageStore()
Returns:
Returns the longTermStore.

deleteSubscription

public void deleteSubscription(String clientId,
                               String subscriptionName)
                        throws IOException
Specified by:
deleteSubscription in interface TopicMessageStore
Throws:
IOException

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

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

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 subsriber

Specified by:
resetBatching in interface TopicMessageStore


Copyright © 2008. All Rights Reserved.