org.apache.activemq.store.jdbc
Class JDBCTopicMessageStore

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

public class JDBCTopicMessageStore
extends JDBCMessageStore
implements TopicMessageStore

Version:
$Revision: 1.6 $

Field Summary
 
Fields inherited from class org.apache.activemq.store.jdbc.JDBCMessageStore
adapter, destination, persistenceAdapter, wireFormat
 
Constructor Summary
JDBCTopicMessageStore(JDBCPersistenceAdapter persistenceAdapter, JDBCAdapter adapter, WireFormat wireFormat, ActiveMQTopic topic)
           
 
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
 void addSubsciption(String clientId, String subscriptionName, String selector, 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.

 void deleteSubscription(String clientId, String subscriptionName)
           
 SubscriptionInfo[] getAllSubscriptions()
          Lists all the durable subscirptions for a given destination.
 int getMessageCount(String clientId, String subscriberName)
          Get the number of messages ready to deliver from the store to a durable subscriber
 MessageId getNextMessageIdToDeliver(String clientId, String subscriptionName, MessageId id)
          Get the next messageId to deliver to a subscriber after the MessageId provided
 MessageId getPreviousMessageIdToDeliver(String clientId, String subscriptionName, MessageId id)
          Get the previous messageId to deliver to a subscriber before the MessageId provided
 SubscriptionInfo lookupSubscription(String clientId, String subscriptionName)
          Finds the subscriber entry for the given consumer info
 void recoverNextMessages(String clientId, String subscriptionName, MessageId lastMessageId, 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 resetBatching(String clientId, String subscriptionName, MessageId id)
          A hint to the Store to reset any batching state for a durable subsriber
 
Methods inherited from class org.apache.activemq.store.jdbc.JDBCMessageStore
addMessage, addMessageReference, getDestination, getMessage, getMessageReference, recover, removeAllMessages, removeMessage, setUsageManager, 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
addMessage, addMessageReference, getDestination, getMessage, getMessageReference, recover, removeAllMessages, removeMessage, setUsageManager
 
Methods inherited from interface org.apache.activemq.Service
start, stop
 

Constructor Detail

JDBCTopicMessageStore

public JDBCTopicMessageStore(JDBCPersistenceAdapter persistenceAdapter,
                             JDBCAdapter adapter,
                             WireFormat wireFormat,
                             ActiveMQTopic topic)
Method Detail

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

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,
                                MessageId lastMessageId,
                                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,
                          MessageId id)
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

addSubsciption

public void addSubsciption(String clientId,
                           String subscriptionName,
                           String selector,
                           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
See Also:
org.apache.activemq.store.TopicMessageStore#storeSubsciption(org.apache.activemq.service.SubscriptionInfo, boolean)

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
See Also:
TopicMessageStore.lookupSubscription(String, String)

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 subscirptions for a given destination.

Specified by:
getAllSubscriptions in interface TopicMessageStore
Returns:
an array SubscriptionInfos
Throws:
IOException

getNextMessageIdToDeliver

public MessageId getNextMessageIdToDeliver(String clientId,
                                           String subscriptionName,
                                           MessageId id)
                                    throws Exception
Description copied from interface: TopicMessageStore
Get the next messageId to deliver to a subscriber after the MessageId provided

Specified by:
getNextMessageIdToDeliver in interface TopicMessageStore
Returns:
the next messageId or null
Throws:
IOException
Exception

getPreviousMessageIdToDeliver

public MessageId getPreviousMessageIdToDeliver(String clientId,
                                               String subscriptionName,
                                               MessageId id)
                                        throws Exception
Description copied from interface: TopicMessageStore
Get the previous messageId to deliver to a subscriber before the MessageId provided

Specified by:
getPreviousMessageIdToDeliver in interface TopicMessageStore
Returns:
the next messageId or null
Throws:
IOException
Exception

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


Copyright © 2011 Apache Software Foundation. All Rights Reserved.