org.apache.activemq.store.jdbc

Class JDBCTopicMessageStore

java.lang.Object

org.apache.activemq.store.AbstractMessageStore

org.apache.activemq.store.jdbc.JDBCMessageStore

org.apache.activemq.store.jdbc.JDBCTopicMessageStore

All Implemented Interfaces:

Service, MessageStore, TopicMessageStore

public class JDBCTopicMessageStore
extends JDBCMessageStore
implements TopicMessageStore

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_SEQUENCE_ID_CACHE_SIZE

Fields inherited from class org.apache.activemq.store.jdbc.JDBCMessageStore

adapter, audit, pendingAdditions, persistenceAdapter, wireFormat

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

destination, FUTURE, indexListener, messageStoreStatistics, prioritizedMessages

Constructor Summary

Constructors

Constructor and Description
JDBCTopicMessageStore(JDBCPersistenceAdapter persistenceAdapter, JDBCAdapter adapter, WireFormat wireFormat, ActiveMQTopic topic, ActiveMQMessageAudit audit)

Method Summary

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	addSubscription(SubscriptionInfo subscriptionInfo, 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	complete(String clientId, String subscriptionName)
void	deleteSubscription(String clientId, String subscriptionName)
SubscriptionInfo[]	getAllSubscriptions() Lists all the durable subscriptions for a given destination.
long[]	getCachedStoreSequenceId(TransactionContext transactionContext, ActiveMQDestination destination, MessageId messageId)
int	getMessageCount(String clientId, String subscriberName) Get the number of messages ready to deliver from the store to a durable subscriber
long	getMessageSize(String clientId, String subscriberName) Get the total size of the messages ready to deliver from the store to the durable subscriber
MessageStoreSubscriptionStatistics	getMessageStoreSubStatistics() The subscription metrics contained in this store
protected String	getSubscriptionKey(String clientId, String subscriberName)
SubscriptionInfo	lookupSubscription(String clientId, String subscriptionName) Finds the subscriber entry for the given consumer info
protected void	onAdd(Message message, long sequenceId, byte priority)
void	pendingCompletion(String clientId, String subscriptionName, long sequenceId, byte priority)
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	resetBatching(String clientId, String subscriptionName) A hint to the Store to reset any batching state for a durable subscriber

Methods inherited from class org.apache.activemq.store.jdbc.JDBCMessageStore

addMessage, addMessageReference, getMessage, getMessageCount, getMessageReference, recover, recoverNextMessages, removeAllMessages, removeMessage, resetBatching, setBatch, setPrioritizedMessages, toString, updateMessage

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

addMessage, asyncAddQueueMessage, asyncAddQueueMessage, asyncAddTopicMessage, asyncAddTopicMessage, dispose, getDestination, getIndexListener, getMessageSize, getMessageStoreStatistics, isEmpty, isPrioritizedMessages, recoverMessageStoreStatistics, registerIndexListener, removeAsyncMessage, setMemoryUsage, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, setBatch, setMemoryUsage, setPrioritizedMessages, updateMessage

Methods inherited from interface org.apache.activemq.Service

start, stop

Field Detail

PROPERTY_SEQUENCE_ID_CACHE_SIZE

public static final String PROPERTY_SEQUENCE_ID_CACHE_SIZE

See Also:

Constant Field Values

Constructor Detail

JDBCTopicMessageStore

public JDBCTopicMessageStore(JDBCPersistenceAdapter persistenceAdapter,
                             JDBCAdapter adapter,
                             WireFormat wireFormat,
                             ActiveMQTopic topic,
                             ActiveMQMessageAudit audit)
                      throws IOException

Throws:

IOException

Method Detail

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

getCachedStoreSequenceId

public long[] getCachedStoreSequenceId(TransactionContext transactionContext,
                                       ActiveMQDestination destination,
                                       MessageId messageId)
                                throws SQLException,
                                       IOException

Throws:

SQLException

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

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 subscriber

Specified by:

resetBatching in interface TopicMessageStore

pendingCompletion

public void pendingCompletion(String clientId,
                              String subscriptionName,
                              long sequenceId,
                              byte priority)

complete

public void complete(String clientId,
                     String subscriptionName)

onAdd

protected void onAdd(Message message,
                     long sequenceId,
                     byte priority)

Overrides:

onAdd in class JDBCMessageStore

addSubscription

public void addSubscription(SubscriptionInfo subscriptionInfo,
                            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:

addSubscription 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

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

Specified by:

getAllSubscriptions in interface TopicMessageStore

Returns:

an array SubscriptionInfos

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

getMessageSize

public long getMessageSize(String clientId,
                           String subscriberName)
                    throws IOException

Description copied from interface: TopicMessageStore

Get the total size of the messages ready to deliver from the store to the durable subscriber

Specified by:

getMessageSize in interface TopicMessageStore

Returns:

Throws:

IOException

getSubscriptionKey

protected String getSubscriptionKey(String clientId,
                                    String subscriberName)

getMessageStoreSubStatistics

public MessageStoreSubscriptionStatistics getMessageStoreSubStatistics()

Description copied from interface: TopicMessageStore

The subscription metrics contained in this store

Specified by:

getMessageStoreSubStatistics in interface TopicMessageStore

Returns: