TopicMessageStore

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> activemq >> [ store overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.activemq.store.TopicMessageStore

SOURCE |

Download org.activemq.store.TopicMessageStore

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.activemq.store
Interface TopicMessageStore

All Superinterfaces:: MessageStore, org.activemq.service.Service

All Known Implementing Classes:: ProxyTopicMessageStore

public interface TopicMessageStore
extends MessageStore

A MessageStore for durable topic subscriptions

Version:: $Revision: 1.1.1.1 $

Method Summary

void decrementMessageCountAndMaybeDelete(org.activemq.service.MessageIdentity msgId)
          Decrement the reference count of this message ID and if there are no more references then delete the message from persistent store (or maybe archive it off somewhere)

void deleteSubscription(java.lang.String subscription)


org.activemq.service.MessageIdentity getLastestMessageIdentity()
          Returns the last message identity that was delivered on this container which can then be used as a checkpoint so that when new durable consumers start, we know where to checkpoint their subscriptions.

org.activemq.service.SubscriberEntry getSubscriberEntry(org.activemq.message.ConsumerInfo info)
          Finds the subscriber entry for the given consumer info

void incrementMessageCount(org.activemq.service.MessageIdentity messageId)
          Increments the reference count of the message ID as its been dispatched to another subscriber.

void recoverSubscription(java.lang.String subscriptionId, org.activemq.service.MessageIdentity lastDispatchedMessage, RecoveryListener listener)
          For the new subcription find the last acknowledged message ID and then find any new messages since then and dispatch them to the subscription.

void setLastAcknowledgedMessageIdentity(java.lang.String subscription, org.activemq.service.MessageIdentity messageIdentity)
          Stores the last acknowledged messgeID for the given subscription so that we can recover and commence dispatching messages from the last checkpoint

void setSubscriberEntry(org.activemq.message.ConsumerInfo info, org.activemq.service.SubscriberEntry subscriberEntry)
          Inserts or updates the subscriber info due to a subscription change

Methods inherited from interface org.activemq.store.MessageStore

addMessage, getMessage, recover, removeAllMessages, removeMessage

Methods inherited from interface org.activemq.service.Service

start, stop

Method Detail

incrementMessageCount

public void incrementMessageCount(org.activemq.service.MessageIdentity messageId)
                           throws javax.jms.JMSException

Increments the reference count of the message ID as its been dispatched to another subscriber.

decrementMessageCountAndMaybeDelete

public void decrementMessageCountAndMaybeDelete(org.activemq.service.MessageIdentity msgId)
                                         throws javax.jms.JMSException

Decrement the reference count of this message ID and if there are no more references then delete the message from persistent store (or maybe archive it off somewhere)

setLastAcknowledgedMessageIdentity

public void setLastAcknowledgedMessageIdentity(java.lang.String subscription,
                                               org.activemq.service.MessageIdentity messageIdentity)
                                        throws javax.jms.JMSException

Stores the last acknowledged messgeID for the given subscription so that we can recover and commence dispatching messages from the last checkpoint

deleteSubscription

public void deleteSubscription(java.lang.String subscription)
                        throws javax.jms.JMSException

recoverSubscription

public void recoverSubscription(java.lang.String subscriptionId,
                                org.activemq.service.MessageIdentity lastDispatchedMessage,
                                RecoveryListener listener)
                         throws javax.jms.JMSException

For the new subcription find the last acknowledged message ID and then find any new messages since then and dispatch them to the subscription.

If this is a new subscription then the lastDispatchMessage should be written to the acknowledgement table to write a checkpoint so that when we recover we will start from the correct point.

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.

getLastestMessageIdentity

public org.activemq.service.MessageIdentity getLastestMessageIdentity()
                                                               throws javax.jms.JMSException

Returns the last message identity that was delivered on this container which can then be used as a checkpoint so that when new durable consumers start, we know where to checkpoint their subscriptions.

Note that this method does not need to return a valid messageID, purely the sequence number.

getSubscriberEntry

public org.activemq.service.SubscriberEntry getSubscriberEntry(org.activemq.message.ConsumerInfo info)
                                                        throws javax.jms.JMSException

Finds the subscriber entry for the given consumer info

setSubscriberEntry

public void setSubscriberEntry(org.activemq.message.ConsumerInfo info,
                               org.activemq.service.SubscriberEntry subscriberEntry)
                        throws javax.jms.JMSException

Inserts or updates the subscriber info due to a subscription change