Package 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 java.lang.Object implements MessageStore, DurableConfigurationStore, MessageStoreProvider, MessageStore.MessageStoreReader
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.qpid.server.store.MessageStore
MessageStore.MessageDeleteListener, MessageStore.MessageStoreReader
-
-
Constructor Summary
Constructors Constructor Description NullMessageStore()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addEventListener(EventListener eventListener, Event... events)
<T extends StorableMessageMetaData>
MessageHandle<T>addMessage(T metaData)
void
addMessageDeleteListener(MessageStore.MessageDeleteListener listener)
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.long
getBytesEvacuatedFromMemory()
long
getInMemorySize()
StoredMessage<?>
getMessage(long messageId)
MessageStore
getMessageStore()
long
getNextMessageId()
java.lang.String
getStoreLocation()
java.io.File
getStoreLocationAsFile()
void
init(ConfiguredObject<?> parent)
Initializes and opens the configuration store.boolean
isPersistent()
Is this store capable of persisting the dataMessageStore.MessageStoreReader
newMessageStoreReader()
Transaction
newTransaction()
void
onDelete(ConfiguredObject<?> parent)
Deletes the configuration store from its underlying storage.boolean
openConfigurationStore(ConfiguredObjectRecordHandler handler, ConfiguredObjectRecord... initialRecords)
Visit all configured object records with given handler.void
openMessageStore(ConfiguredObject<?> parent)
Initializes and opens the message store.void
reload(ConfiguredObjectRecordHandler handler)
java.util.UUID[]
remove(ConfiguredObjectRecord... objects)
Removes the specified persistent configured objects.void
removeMessageDeleteListener(MessageStore.MessageDeleteListener listener)
void
resetStatistics()
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
visitDistributedTransactions(DistributedTransactionHandler handler)
void
visitMessageInstances(MessageInstanceHandler handler)
void
visitMessageInstances(TransactionLogResource queue, MessageInstanceHandler handler)
void
visitMessages(MessageHandler handler)
-
-
-
Method Detail
-
getMessageStore
public MessageStore getMessageStore()
- Specified by:
getMessageStore
in interfaceMessageStoreProvider
-
init
public void init(ConfiguredObject<?> parent)
Description copied from interface:DurableConfigurationStore
Initializes and opens the configuration store.- Specified by:
init
in interfaceDurableConfigurationStore
-
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 interfaceDurableConfigurationStore
- Parameters:
createIfNecessary
- if false then will fail if the object does not exist.records
- the records to update
-
remove
public java.util.UUID[] remove(ConfiguredObjectRecord... objects)
Description copied from interface:DurableConfigurationStore
Removes the specified persistent configured objects.- Specified by:
remove
in interfaceDurableConfigurationStore
- 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 interfaceDurableConfigurationStore
- 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 interfaceMessageStore
- 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 interfaceDurableConfigurationStore
- Specified by:
upgradeStoreStructure
in interfaceMessageStore
- 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 interfaceMessageStore
-
closeConfigurationStore
public void closeConfigurationStore()
- Specified by:
closeConfigurationStore
in interfaceDurableConfigurationStore
-
addMessage
public <T extends StorableMessageMetaData> MessageHandle<T> addMessage(T metaData)
- Specified by:
addMessage
in interfaceMessageStore
-
isPersistent
public boolean isPersistent()
Description copied from interface:MessageStore
Is this store capable of persisting the data- Specified by:
isPersistent
in interfaceMessageStore
- Returns:
- true if this store is capable of persisting data
-
getInMemorySize
public long getInMemorySize()
- Specified by:
getInMemorySize
in interfaceMessageStore
-
getBytesEvacuatedFromMemory
public long getBytesEvacuatedFromMemory()
- Specified by:
getBytesEvacuatedFromMemory
in interfaceMessageStore
-
resetStatistics
public void resetStatistics()
- Specified by:
resetStatistics
in interfaceMessageStore
-
newTransaction
public Transaction newTransaction()
- Specified by:
newTransaction
in interfaceMessageStore
-
addEventListener
public void addEventListener(EventListener eventListener, Event... events)
- Specified by:
addEventListener
in interfaceMessageStore
-
getStoreLocation
public java.lang.String getStoreLocation()
- Specified by:
getStoreLocation
in interfaceMessageStore
-
getStoreLocationAsFile
public java.io.File getStoreLocationAsFile()
- Specified by:
getStoreLocationAsFile
in interfaceMessageStore
-
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 interfaceDurableConfigurationStore
- Specified by:
onDelete
in interfaceMessageStore
-
openConfigurationStore
public boolean openConfigurationStore(ConfiguredObjectRecordHandler handler, ConfiguredObjectRecord... initialRecords) throws StoreException
Description copied from interface:DurableConfigurationStore
Visit all configured object records with given handler.- Specified by:
openConfigurationStore
in interfaceDurableConfigurationStore
- Parameters:
handler
- a handler to invoke on each configured object record- Throws:
StoreException
-
reload
public void reload(ConfiguredObjectRecordHandler handler) throws StoreException
- Specified by:
reload
in interfaceDurableConfigurationStore
- Throws:
StoreException
-
visitMessages
public void visitMessages(MessageHandler handler) throws StoreException
- Specified by:
visitMessages
in interfaceMessageStore.MessageStoreReader
- Throws:
StoreException
-
visitMessageInstances
public void visitMessageInstances(TransactionLogResource queue, MessageInstanceHandler handler) throws StoreException
- Specified by:
visitMessageInstances
in interfaceMessageStore.MessageStoreReader
- Throws:
StoreException
-
visitMessageInstances
public void visitMessageInstances(MessageInstanceHandler handler) throws StoreException
- Specified by:
visitMessageInstances
in interfaceMessageStore.MessageStoreReader
- Throws:
StoreException
-
visitDistributedTransactions
public void visitDistributedTransactions(DistributedTransactionHandler handler) throws StoreException
- Specified by:
visitDistributedTransactions
in interfaceMessageStore.MessageStoreReader
- Throws:
StoreException
-
getNextMessageId
public long getNextMessageId()
- Specified by:
getNextMessageId
in interfaceMessageStore
-
getMessage
public StoredMessage<?> getMessage(long messageId)
- Specified by:
getMessage
in interfaceMessageStore.MessageStoreReader
-
newMessageStoreReader
public MessageStore.MessageStoreReader newMessageStoreReader()
- Specified by:
newMessageStoreReader
in interfaceMessageStore
-
close
public void close()
- Specified by:
close
in interfaceMessageStore.MessageStoreReader
-
addMessageDeleteListener
public void addMessageDeleteListener(MessageStore.MessageDeleteListener listener)
- Specified by:
addMessageDeleteListener
in interfaceMessageStore
-
removeMessageDeleteListener
public void removeMessageDeleteListener(MessageStore.MessageDeleteListener listener)
- Specified by:
removeMessageDeleteListener
in interfaceMessageStore
-
-