org.apache.qpid.server.store
Interface MessageStore

All Superinterfaces:
DurableConfigurationStore, TransactionLog
All Known Implementing Classes:
AbstractMessageStore, DerbyMessageStore, MemoryMessageStore

public interface MessageStore
extends DurableConfigurationStore, TransactionLog

MessageStore defines the interface to a storage area, which can be used to preserve the state of messages.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.qpid.server.store.DurableConfigurationStore
DurableConfigurationStore.Source
 
Nested classes/interfaces inherited from interface org.apache.qpid.server.store.TransactionLog
TransactionLog.StoreFuture, TransactionLog.Transaction
 
Field Summary
static TransactionLog.StoreFuture IMMEDIATE_FUTURE
           
 
Method Summary
<T extends StorableMessageMetaData>
StoredMessage<T>
addMessage(T metaData)
           
 void close()
          Called to close and cleanup any resources used by the message store.
 void configureMessageStore(String name, MessageStoreRecoveryHandler recoveryHandler, Configuration config, LogSubject logSubject)
          Called after instantiation in order to configure the message store.
 boolean isPersistent()
          Is this store capable of persisting the data
 
Methods inherited from interface org.apache.qpid.server.store.DurableConfigurationStore
bindQueue, configureConfigStore, createExchange, createQueue, createQueue, removeExchange, removeQueue, unbindQueue, updateQueue
 
Methods inherited from interface org.apache.qpid.server.store.TransactionLog
configureTransactionLog, newTransaction
 

Field Detail

IMMEDIATE_FUTURE

static final TransactionLog.StoreFuture IMMEDIATE_FUTURE
Method Detail

configureMessageStore

void configureMessageStore(String name,
                           MessageStoreRecoveryHandler recoveryHandler,
                           Configuration config,
                           LogSubject logSubject)
                           throws Exception
Called after instantiation in order to configure the message store. A particular implementation can define whatever parameters it wants.

Parameters:
name - The name to be used by this storem
recoveryHandler - Handler to be called as the store recovers on start up
config - The apache commons configuration object.
Throws:
Exception - If any error occurs that means the store is unable to configure itself.

close

void close()
           throws Exception
Called to close and cleanup any resources used by the message store.

Throws:
Exception - If the close fails.

addMessage

<T extends StorableMessageMetaData> StoredMessage<T> addMessage(T metaData)

isPersistent

boolean isPersistent()
Is this store capable of persisting the data

Returns:
true if this store is capable of persisting data


Licensed to the Apache Software Foundation