Package org.apache.activemq.store
Interface TopicReferenceStore
-
- All Superinterfaces:
MessageStore
,ReferenceStore
,Service
,TopicMessageStore
public interface TopicReferenceStore extends ReferenceStore, TopicMessageStore
A MessageStore for durable topic subscriptions
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.activemq.store.ReferenceStore
ReferenceStore.ReferenceData
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
acknowledgeReference(ConnectionContext context, String clientId, 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
addSubsciption(SubscriptionInfo subscriptionInfo, boolean retroactive)
Inserts the subscriber info due to a subscription changevoid
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 subscriberSubscriptionInfo
lookupSubscription(String clientId, String subscriptionName)
Finds the subscriber entry for the given consumer infovoid
recoverNextMessages(String clientId, String subscriptionName, int maxReturned, MessageRecoveryListener listener)
For an active subscription - retrieve messages from the store for the subscriber after the lastMessageId messageIdvoid
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)
A hint to the Store to reset any batching state for a durable subsriber-
Methods inherited from interface org.apache.activemq.store.MessageStore
addMessage, addMessage, asyncAddQueueMessage, asyncAddQueueMessage, asyncAddTopicMessage, asyncAddTopicMessage, dispose, getDestination, getMessage, getMessageCount, getMessageSize, getMessageStoreStatistics, isEmpty, isPrioritizedMessages, recover, recoverNextMessages, registerIndexListener, removeAllMessages, removeAsyncMessage, removeMessage, resetBatching, setMemoryUsage, setPrioritizedMessages, updateMessage
-
Methods inherited from interface org.apache.activemq.store.ReferenceStore
addMessageReference, getMessageReference, getStoreLock, setBatch, supportsExternalBatchControl
-
Methods inherited from interface org.apache.activemq.store.TopicMessageStore
acknowledge, addSubscription, getMessageSize, getMessageStoreSubStatistics
-
-
-
-
Method Detail
-
acknowledgeReference
boolean acknowledgeReference(ConnectionContext context, String clientId, String subscriptionName, MessageId messageId) throws IOException
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- Parameters:
context
-clientId
-subscriptionName
-messageId
-- Returns:
- true if there are no more references to the message - or the message is null
- Throws:
IOException
-
deleteSubscription
void deleteSubscription(String clientId, String subscriptionName) throws IOException
- Specified by:
deleteSubscription
in interfaceTopicMessageStore
- Parameters:
clientId
-subscriptionName
-- Throws:
IOException
JMSException
-
recoverSubscription
void recoverSubscription(String clientId, String subscriptionName, MessageRecoveryListener listener) throws Exception
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 interfaceTopicMessageStore
- Parameters:
clientId
-subscriptionName
-listener
-- Throws:
Exception
-
recoverNextMessages
void recoverNextMessages(String clientId, String subscriptionName, int maxReturned, MessageRecoveryListener listener) throws Exception
For an active subscription - retrieve messages from the store for the subscriber after the lastMessageId messageId- Specified by:
recoverNextMessages
in interfaceTopicMessageStore
- Parameters:
clientId
-subscriptionName
-maxReturned
-listener
-- Throws:
Exception
-
resetBatching
void resetBatching(String clientId, String subscriptionName)
A hint to the Store to reset any batching state for a durable subsriber- Specified by:
resetBatching
in interfaceTopicMessageStore
- Parameters:
clientId
-subscriptionName
-
-
getMessageCount
int getMessageCount(String clientId, String subscriberName) throws IOException
Get the number of messages ready to deliver from the store to a durable subscriber- Specified by:
getMessageCount
in interfaceTopicMessageStore
- Parameters:
clientId
-subscriberName
-- Returns:
- the outstanding message count
- Throws:
IOException
-
lookupSubscription
SubscriptionInfo lookupSubscription(String clientId, String subscriptionName) throws IOException
Finds the subscriber entry for the given consumer info- Specified by:
lookupSubscription
in interfaceTopicMessageStore
- Parameters:
clientId
-subscriptionName
-- Returns:
- the SubscriptionInfo
- Throws:
IOException
-
getAllSubscriptions
SubscriptionInfo[] getAllSubscriptions() throws IOException
Lists all the durable subscriptions for a given destination.- Specified by:
getAllSubscriptions
in interfaceTopicMessageStore
- Returns:
- an array SubscriptionInfos
- Throws:
IOException
-
addSubsciption
void addSubsciption(SubscriptionInfo subscriptionInfo, boolean retroactive) throws IOException
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.- Parameters:
subscriptionInfo
-retroactive
-- Throws:
IOException
-
-