Package org.apache.activemq.store

Interface ReferenceStore

All Superinterfaces:

MessageStore, org.apache.activemq.Service

All Known Subinterfaces:

TopicReferenceStore

public interface ReferenceStore
extends MessageStore

Represents a message store which is used by the persistent implementations

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ReferenceStore.ReferenceData

Method Summary

Modifier and Type	Method	Description
boolean	addMessageReference(ConnectionContext context, org.apache.activemq.command.MessageId messageId, ReferenceStore.ReferenceData data)	Adds a message reference to the message store
ReferenceStore.ReferenceData	getMessageReference(org.apache.activemq.command.MessageId identity)	Looks up a message using either the String messageID or the messageNumber.
Lock	getStoreLock()
void	setBatch(org.apache.activemq.command.MessageId startAfter)	allow caching cursors to set the current batch offset when cache is exhausted
boolean	supportsExternalBatchControl()

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.Service

start, stop

Method Detail

addMessageReference

boolean addMessageReference(ConnectionContext context,
                            org.apache.activemq.command.MessageId messageId,
                            ReferenceStore.ReferenceData data)
                     throws IOException

Adds a message reference to the message store

Returns:

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

Throws:

IOException

getMessageReference

ReferenceStore.ReferenceData getMessageReference(org.apache.activemq.command.MessageId identity)
                                          throws IOException

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.

Throws:

IOException

supportsExternalBatchControl

boolean supportsExternalBatchControl()

Returns:

true if it supports external batch control

setBatch

void setBatch(org.apache.activemq.command.MessageId startAfter)

Description copied from interface: MessageStore

allow caching cursors to set the current batch offset when cache is exhausted

Specified by:

setBatch in interface MessageStore

getStoreLock

Lock getStoreLock()