org.apache.activemq.store.kahadaptor

Class KahaTopicReferenceStore

java.lang.Object

org.apache.activemq.store.AbstractMessageStore

org.apache.activemq.store.kahadaptor.KahaReferenceStore

org.apache.activemq.store.kahadaptor.KahaTopicReferenceStore

All Implemented Interfaces:

Service, MessageStore, ReferenceStore, TopicMessageStore, TopicReferenceStore

public class KahaTopicReferenceStore
extends KahaReferenceStore
implements TopicReferenceStore

Nested Class Summary

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

ReferenceStore.ReferenceData

Field Summary

Fields

Modifier and Type	Field and Description
protected ListContainer<TopicSubAck>	ackContainer
protected java.util.Map<java.lang.String,TopicSubContainer>	subscriberMessages

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

adapter, dispatchAudit, lock, messageContainer

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

destination, FUTURE, prioritizedMessages

Constructor Summary

Constructors

Constructor and Description
KahaTopicReferenceStore(Store store, KahaReferenceStoreAdapter adapter, MapContainer<MessageId,ReferenceRecord> messageContainer, ListContainer<TopicSubAck> ackContainer, MapContainer<java.lang.String,SubscriptionInfo> subsContainer, ActiveMQDestination destination)

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledge(ConnectionContext context, java.lang.String clientId, java.lang.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
boolean	acknowledgeReference(ConnectionContext context, java.lang.String clientId, java.lang.String subscriptionName, MessageId messageId) Removes the last acknowledged messgeID for the given subscription so that we can recover and commence dispatching messages from the last checkpoint N.B.
void	addMessage(ConnectionContext context, Message message) Adds a message to the message store
boolean	addMessageReference(ConnectionContext context, MessageId messageId, ReferenceStore.ReferenceData data) Adds a message reference to the message store
void	addReferenceFileIdsInUse()
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(java.lang.String clientId, java.lang.String subscriptionName)
void	deleteSubscription(java.lang.String clientId, java.lang.String subscriptionName)
void	dispose(ConnectionContext context)
SubscriptionInfo[]	getAllSubscriptions() Lists all the durable subscirptions for a given destination.
Message	getMessage(MessageId identity) Looks up a message using either the String messageID or the messageNumber.
int	getMessageCount(java.lang.String clientId, java.lang.String subscriberName) Get the number of messages ready to deliver from the store to a durable subscriber
protected MessageId	getMessageId(java.lang.Object object)
ReferenceStore.ReferenceData	getMessageReference(MessageId identity) Looks up a message using either the String messageID or the messageNumber.
protected java.lang.String	getSubscriptionKey(java.lang.String clientId, java.lang.String subscriberName)
SubscriptionInfo	lookupSubscription(java.lang.String clientId, java.lang.String subscriptionName) Finds the subscriber entry for the given consumer info
void	recoverNextMessages(java.lang.String clientId, java.lang.String subscriptionName, int maxReturned, MessageRecoveryListener listener) For an active subscription - retrieve messages from the store for the subscriber after the lastMessageId messageId
void	recoverSubscription(java.lang.String clientId, java.lang.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(java.lang.String clientId, java.lang.String subscriptionName)
void	resetBatching(java.lang.String clientId, java.lang.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.KahaReferenceStore

delete, getMessageCount, getStoreLock, isDuplicate, isSupportForCursors, recover, recoverNextMessages, recoverReference, removeMessage, resetBatching, setBatch, supportsExternalBatchControl

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

addMessage, asyncAddQueueMessage, asyncAddQueueMessage, asyncAddTopicMessage, asyncAddTopicMessage, 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.ReferenceStore

getStoreLock, setBatch, supportsExternalBatchControl

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

addMessage, asyncAddQueueMessage, asyncAddQueueMessage, asyncAddTopicMessage, asyncAddTopicMessage, getDestination, getMessageCount, isEmpty, isPrioritizedMessages, recover, recoverNextMessages, removeAsyncMessage, removeMessage, resetBatching, setMemoryUsage, setPrioritizedMessages

Methods inherited from interface org.apache.activemq.Service

start, stop

Field Detail

ackContainer

protected ListContainer<TopicSubAck> ackContainer

subscriberMessages

protected java.util.Map<java.lang.String,TopicSubContainer> subscriberMessages

Constructor Detail

KahaTopicReferenceStore

public KahaTopicReferenceStore(Store store,
                       KahaReferenceStoreAdapter adapter,
                       MapContainer<MessageId,ReferenceRecord> messageContainer,
                       ListContainer<TopicSubAck> ackContainer,
                       MapContainer<java.lang.String,SubscriptionInfo> subsContainer,
                       ActiveMQDestination destination)
                        throws java.io.IOException

Throws:

java.io.IOException

Method Detail

dispose

public void dispose(ConnectionContext context)

Specified by:

dispose in interface MessageStore

Overrides:

dispose in class KahaReferenceStore

getMessageId

protected MessageId getMessageId(java.lang.Object object)

Overrides:

getMessageId in class KahaReferenceStore

addMessage

public void addMessage(ConnectionContext context,
              Message message)
                throws java.io.IOException

Description copied from interface: MessageStore

Adds a message to the message store

Specified by:

addMessage in interface MessageStore

Overrides:

addMessage in class KahaReferenceStore

Parameters:

context - context

Throws:

java.io.IOException

getMessage

public Message getMessage(MessageId identity)
                   throws java.io.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 KahaReferenceStore

Parameters:

identity - which contains either the messageID or the messageNumber

Returns:

the message or null if it does not exist

Throws:

java.io.IOException

addMessageReference

public boolean addMessageReference(ConnectionContext context,
                          MessageId messageId,
                          ReferenceStore.ReferenceData data)

Description copied from interface: ReferenceStore

Adds a message reference to the message store

Specified by:

addMessageReference in interface ReferenceStore

Overrides:

addMessageReference in class KahaReferenceStore

Returns:

true if reference was added, false if it is a duplicate and not added

getMessageReference

public ReferenceStore.ReferenceData getMessageReference(MessageId identity)
                                                 throws java.io.IOException

Description copied from interface: ReferenceStore

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:

getMessageReference in interface ReferenceStore

Overrides:

getMessageReference in class KahaReferenceStore

Throws:

java.io.IOException

addReferenceFileIdsInUse

public void addReferenceFileIdsInUse()

addSubscriberMessageContainer

protected MapContainer addSubscriberMessageContainer(java.lang.String clientId,
                                         java.lang.String subscriptionName)
                                              throws java.io.IOException

Throws:

java.io.IOException

acknowledgeReference

public boolean acknowledgeReference(ConnectionContext context,
                           java.lang.String clientId,
                           java.lang.String subscriptionName,
                           MessageId messageId)
                             throws java.io.IOException

Description copied from interface: TopicReferenceStore

Removes the last acknowledged messgeID for the given subscription so that we can recover and commence dispatching messages from the last checkpoint N.B. - all messages previous to this one for a given subscriber should also be acknowledged

Specified by:

acknowledgeReference in interface TopicReferenceStore

Returns:

true if there are no more references to the message - or the message is null

Throws:

java.io.IOException

acknowledge

public void acknowledge(ConnectionContext context,
               java.lang.String clientId,
               java.lang.String subscriptionName,
               MessageId messageId,
               MessageAck ack)
                 throws java.io.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:

java.io.IOException

addSubsciption

public void addSubsciption(SubscriptionInfo info,
                  boolean retroactive)
                    throws java.io.IOException

Description copied from interface: TopicReferenceStore

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

Specified by:

addSubsciption in interface TopicReferenceStore

Throws:

java.io.IOException

deleteSubscription

public void deleteSubscription(java.lang.String clientId,
                      java.lang.String subscriptionName)
                        throws java.io.IOException

Specified by:

deleteSubscription in interface TopicMessageStore

Specified by:

deleteSubscription in interface TopicReferenceStore

Throws:

java.io.IOException

getAllSubscriptions

public SubscriptionInfo[] getAllSubscriptions()
                                       throws java.io.IOException

Description copied from interface: TopicReferenceStore

Lists all the durable subscirptions for a given destination.

Specified by:

getAllSubscriptions in interface TopicMessageStore

Specified by:

getAllSubscriptions in interface TopicReferenceStore

Returns:

an array SubscriptionInfos

Throws:

java.io.IOException

getMessageCount

public int getMessageCount(java.lang.String clientId,
                  java.lang.String subscriberName)
                    throws java.io.IOException

Description copied from interface: TopicReferenceStore

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

Specified by:

getMessageCount in interface TopicMessageStore

Specified by:

getMessageCount in interface TopicReferenceStore

Returns:

the outstanding message count

Throws:

java.io.IOException

lookupSubscription

public SubscriptionInfo lookupSubscription(java.lang.String clientId,
                                  java.lang.String subscriptionName)
                                    throws java.io.IOException

Description copied from interface: TopicReferenceStore

Finds the subscriber entry for the given consumer info

Specified by:

lookupSubscription in interface TopicMessageStore

Specified by:

lookupSubscription in interface TopicReferenceStore

Returns:

the SubscriptionInfo

Throws:

java.io.IOException

recoverNextMessages

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

Description copied from interface: TopicReferenceStore

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

Specified by:

recoverNextMessages in interface TopicMessageStore

Specified by:

recoverNextMessages in interface TopicReferenceStore

Throws:

java.lang.Exception

recoverSubscription

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

Description copied from interface: TopicReferenceStore

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

Specified by:

recoverSubscription in interface TopicReferenceStore

Throws:

java.lang.Exception

resetBatching

public void resetBatching(java.lang.String clientId,
                 java.lang.String subscriptionName)

Description copied from interface: TopicReferenceStore

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

Specified by:

resetBatching in interface TopicMessageStore

Specified by:

resetBatching in interface TopicReferenceStore

removeAllMessages

public void removeAllMessages(ConnectionContext context)
                       throws java.io.IOException

Description copied from interface: MessageStore

Removes all the messages from the message store.

Specified by:

removeAllMessages in interface MessageStore

Overrides:

removeAllMessages in class KahaReferenceStore

Throws:

java.io.IOException

removeSubscriberMessageContainer

protected void removeSubscriberMessageContainer(java.lang.String clientId,
                                    java.lang.String subscriptionName)
                                         throws java.io.IOException

Throws:

java.io.IOException

getSubscriptionKey

protected java.lang.String getSubscriptionKey(java.lang.String clientId,
                                  java.lang.String subscriberName)