org.apache.activemq.store.kahadaptor

Class KahaTopicMessageStore

java.lang.Object

org.apache.activemq.store.AbstractMessageStore

org.apache.activemq.store.kahadaptor.KahaMessageStore

org.apache.activemq.store.kahadaptor.KahaTopicMessageStore

All Implemented Interfaces:

Service, MessageStore, TopicMessageStore

public class KahaTopicMessageStore
extends KahaMessageStore
implements TopicMessageStore

Field Summary

Fields

Modifier and Type	Field and Description
protected ListContainer<TopicSubAck>	ackContainer
protected Map<Object,TopicSubContainer>	subscriberMessages

Fields inherited from class org.apache.activemq.store.kahadaptor.KahaMessageStore

batchEntry, messageContainer

Fields inherited from class org.apache.activemq.store.AbstractMessageStore

destination, FUTURE, prioritizedMessages

Constructor Summary

Constructors

Constructor and Description
KahaTopicMessageStore(Store store, MapContainer<MessageId,Message> messageContainer, ListContainer<TopicSubAck> ackContainer, MapContainer<String,SubscriptionInfo> subsContainer, ActiveMQDestination destination)

Method Summary

Methods

Modifier and Type	Method and Description
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	addSubsciption(SubscriptionInfo info, 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.
protected MapContainer	addSubscriberMessageContainer(Object key)
void	delete()
void	deleteSubscription(String clientId, String subscriptionName)
SubscriptionInfo[]	getAllSubscriptions() Lists all the durable subscriptions 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
protected String	getSubscriptionKey(String clientId, String subscriberName)
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	removeAllMessages(ConnectionContext context) Removes all the messages from the message store.
protected void	removeSubscriberMessageContainer(Object key)
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.kahadaptor.KahaMessageStore

getId, getMessage, getMessageCount, getMessageId, getPreviousMessageIdToDeliver, isSupportForCursors, recover, recoverMessage, recoverNextMessages, removeMessage, removeMessage, resetBatching, setBatch

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

addMessage, asyncAddQueueMessage, asyncAddQueueMessage, asyncAddTopicMessage, asyncAddTopicMessage, dispose, getDestination, isEmpty, isPrioritizedMessages, removeAsyncMessage, setMemoryUsage, setPrioritizedMessages, 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, asyncAddQueueMessage, asyncAddQueueMessage, asyncAddTopicMessage, asyncAddTopicMessage, dispose, getDestination, getMessage, getMessageCount, isEmpty, isPrioritizedMessages, recover, recoverNextMessages, removeAsyncMessage, removeMessage, resetBatching, setBatch, setMemoryUsage, setPrioritizedMessages

Methods inherited from interface org.apache.activemq.Service

start, stop

Field Detail

ackContainer

protected ListContainer<TopicSubAck> ackContainer

subscriberMessages

protected Map<Object,TopicSubContainer> subscriberMessages

Constructor Detail

KahaTopicMessageStore

public KahaTopicMessageStore(Store store,
                     MapContainer<MessageId,Message> messageContainer,
                     ListContainer<TopicSubAck> ackContainer,
                     MapContainer<String,SubscriptionInfo> subsContainer,
                     ActiveMQDestination destination)
                      throws IOException

Throws:

IOException

Method Detail

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

Overrides:

addMessage in class KahaMessageStore

Parameters:

context - context

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

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 info,
                  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

delete

public void delete()

Overrides:

delete in class KahaMessageStore

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

getSubscriptionKey

protected String getSubscriptionKey(String clientId,
                        String subscriberName)

addSubscriberMessageContainer

protected MapContainer addSubscriberMessageContainer(Object key)
                                              throws IOException

Throws:

IOException

removeSubscriberMessageContainer

protected void removeSubscriberMessageContainer(Object key)
                                         throws IOException

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

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 KahaMessageStore

Parameters:

context -

Throws:

IOException

See Also:

MessageStore.removeAllMessages(org.apache.activemq.broker.ConnectionContext)

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