org.apache.qpid.server.store

Class NullMessageStore

java.lang.Object

org.apache.qpid.server.store.NullMessageStore

All Implemented Interfaces:

DurableConfigurationStore, MessageStore, MessageStore.MessageStoreReader, MessageStoreProvider

public abstract class NullMessageStore
extends Object
implements MessageStore, DurableConfigurationStore, MessageStoreProvider, MessageStore.MessageStoreReader

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.qpid.server.store.MessageStore

MessageStore.MessageStoreReader

Constructor Summary

Constructors

Constructor and Description
NullMessageStore()

Method Summary

Modifier and Type	Method and Description
void	addEventListener(EventListener eventListener, Event... events)
<T extends StorableMessageMetaData> MessageHandle<T>	addMessage(T metaData)
void	close()
void	closeConfigurationStore()
void	closeMessageStore() Called to close and cleanup any resources used by the message store.
void	create(ConfiguredObjectRecord record) Makes the specified object persistent.
StoredMessage<?>	getMessage(long messageId)
MessageStore	getMessageStore()
long	getNextMessageId()
String	getStoreLocation()
File	getStoreLocationAsFile()
boolean	isPersistent() Is this store capable of persisting the data
MessageStore.MessageStoreReader	newMessageStoreReader()
Transaction	newTransaction()
void	onDelete(ConfiguredObject<?> parent) Deletes the configuration store from its underlying storage.
void	openConfigurationStore(ConfiguredObject<?> parent, boolean overwrite, ConfiguredObjectRecord... initialRecords) Initializes and opens the configuration store.
void	openMessageStore(ConfiguredObject<?> parent) Initializes and opens the message store.
UUID[]	remove(ConfiguredObjectRecord... objects) Removes the specified persistent configured objects.
void	update(boolean createIfNecessary, ConfiguredObjectRecord... records) Updates the specified objects in the persistent store, IF it is already present.
void	upgradeStoreStructure() Requests that the store performs any upgrade work on the store's structure.
void	visitConfiguredObjectRecords(ConfiguredObjectRecordHandler handler) Visit all configured object records with given handler.
void	visitDistributedTransactions(DistributedTransactionHandler handler)
void	visitMessageInstances(MessageInstanceHandler handler)
void	visitMessageInstances(TransactionLogResource queue, MessageInstanceHandler handler)
void	visitMessages(MessageHandler handler)

Methods inherited from class java.lang.Object

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

Constructor Detail

NullMessageStore

public NullMessageStore()

Method Detail

getMessageStore

public MessageStore getMessageStore()

Specified by:

getMessageStore in interface MessageStoreProvider

openConfigurationStore

public void openConfigurationStore(ConfiguredObject<?> parent,
                                   boolean overwrite,
                                   ConfiguredObjectRecord... initialRecords)

Description copied from interface: DurableConfigurationStore

Initializes and opens the configuration store.

Specified by:

openConfigurationStore in interface DurableConfigurationStore

update

public void update(boolean createIfNecessary,
                   ConfiguredObjectRecord... records)

Description copied from interface: DurableConfigurationStore

Updates the specified objects in the persistent store, IF it is already present. If the object is not present in the store, it will only be added if createIfNecessary is set to true, otherwise an exception will be thrown.

Specified by:

update in interface DurableConfigurationStore

Parameters:

createIfNecessary - if false then will fail if the object does not exist.

records - the records to update

remove

public UUID[] remove(ConfiguredObjectRecord... objects)

Description copied from interface: DurableConfigurationStore

Removes the specified persistent configured objects.

Specified by:

remove in interface DurableConfigurationStore

Parameters:

objects - The objects to remove.

create

public void create(ConfiguredObjectRecord record)

Description copied from interface: DurableConfigurationStore

Makes the specified object persistent.

Specified by:

create in interface DurableConfigurationStore

Parameters:

record - The object to persist.

openMessageStore

public void openMessageStore(ConfiguredObject<?> parent)

Description copied from interface: MessageStore

Initializes and opens the message store.

Specified by:

openMessageStore in interface MessageStore

Parameters:

parent - parent object

upgradeStoreStructure

public void upgradeStoreStructure()
                           throws StoreException

Description copied from interface: MessageStore

Requests that the store performs any upgrade work on the store's structure. If there is no upgrade work to be done, this method should return without doing anything.

Specified by:

upgradeStoreStructure in interface DurableConfigurationStore

Specified by:

upgradeStoreStructure in interface MessageStore

Throws:

StoreException - signals that a problem was encountered trying to upgrade the store. Implementations, on encountering a problem, should endeavour to leave the store in its original state.

closeMessageStore

public void closeMessageStore()

Description copied from interface: MessageStore

Called to close and cleanup any resources used by the message store.

Specified by:

closeMessageStore in interface MessageStore

closeConfigurationStore

public void closeConfigurationStore()

Specified by:

closeConfigurationStore in interface DurableConfigurationStore

addMessage

public <T extends StorableMessageMetaData> MessageHandle<T> addMessage(T metaData)

Specified by:

addMessage in interface MessageStore

isPersistent

public boolean isPersistent()

Description copied from interface: MessageStore

Is this store capable of persisting the data

Specified by:

isPersistent in interface MessageStore

Returns:

true if this store is capable of persisting data

newTransaction

public Transaction newTransaction()

Specified by:

newTransaction in interface MessageStore

addEventListener

public void addEventListener(EventListener eventListener,
                             Event... events)

Specified by:

addEventListener in interface MessageStore

getStoreLocation

public String getStoreLocation()

Specified by:

getStoreLocation in interface MessageStore

getStoreLocationAsFile

public File getStoreLocationAsFile()

Specified by:

getStoreLocationAsFile in interface MessageStore

onDelete

public void onDelete(ConfiguredObject<?> parent)

Description copied from interface: DurableConfigurationStore

Deletes the configuration store from its underlying storage. If the store has not be opened, then this call will be ignored. The store should be closed before making this call.

Specified by:

onDelete in interface DurableConfigurationStore

Specified by:

onDelete in interface MessageStore

visitConfiguredObjectRecords

public void visitConfiguredObjectRecords(ConfiguredObjectRecordHandler handler)
                                  throws StoreException

Description copied from interface: DurableConfigurationStore

Visit all configured object records with given handler.

Specified by:

visitConfiguredObjectRecords in interface DurableConfigurationStore

Parameters:

handler - a handler to invoke on each configured object record

Throws:

StoreException

visitMessages

public void visitMessages(MessageHandler handler)
                   throws StoreException

Specified by:

visitMessages in interface MessageStore.MessageStoreReader

Throws:

StoreException

visitMessageInstances

public void visitMessageInstances(TransactionLogResource queue,
                                  MessageInstanceHandler handler)
                           throws StoreException

Specified by:

visitMessageInstances in interface MessageStore.MessageStoreReader

Throws:

StoreException

visitMessageInstances

public void visitMessageInstances(MessageInstanceHandler handler)
                           throws StoreException

Specified by:

visitMessageInstances in interface MessageStore.MessageStoreReader

Throws:

StoreException

visitDistributedTransactions

public void visitDistributedTransactions(DistributedTransactionHandler handler)
                                  throws StoreException

Specified by:

visitDistributedTransactions in interface MessageStore.MessageStoreReader

Throws:

StoreException

getNextMessageId

public long getNextMessageId()

Specified by:

getNextMessageId in interface MessageStore

getMessage

public StoredMessage<?> getMessage(long messageId)

Specified by:

getMessage in interface MessageStore.MessageStoreReader

newMessageStoreReader

public MessageStore.MessageStoreReader newMessageStoreReader()

Specified by:

newMessageStoreReader in interface MessageStore

close

public void close()

Specified by:

close in interface MessageStore.MessageStoreReader