org.apache.qpid.server.store.berkeleydb

Class BDBConfigurationStore

java.lang.Object

org.apache.qpid.server.store.berkeleydb.BDBConfigurationStore

All Implemented Interfaces:

DurableConfigurationStore, MessageStoreProvider

public class BDBConfigurationStore
extends Object
implements MessageStoreProvider, DurableConfigurationStore

Implementation of a DurableConfigurationStore backed by BDB JE that also provides a MessageStore.

Field Summary

Fields

Modifier and Type	Field and Description
static int	VERSION

Constructor Summary

Constructors

Constructor and Description
BDBConfigurationStore(Class<? extends ConfiguredObject> rootClass)
BDBConfigurationStore(EnvironmentFacadeFactory environmentFacadeFactory, Class<? extends ConfiguredObject> rootClass)

Method Summary

Modifier and Type	Method and Description
void	closeConfigurationStore()
void	create(ConfiguredObjectRecord configuredObject) Makes the specified object persistent.
EnvironmentFacade	getEnvironmentFacade()
MessageStore	getMessageStore()
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.
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.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final int VERSION

See Also:

Constant Field Values

Constructor Detail

BDBConfigurationStore

public BDBConfigurationStore(Class<? extends ConfiguredObject> rootClass)

BDBConfigurationStore

public BDBConfigurationStore(EnvironmentFacadeFactory environmentFacadeFactory,
                             Class<? extends ConfiguredObject> rootClass)

Method Detail

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

upgradeStoreStructure

public void upgradeStoreStructure()
                           throws StoreException

Description copied from interface: DurableConfigurationStore

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

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.

visitConfiguredObjectRecords

public void visitConfiguredObjectRecords(ConfiguredObjectRecordHandler handler)

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

getEnvironmentFacade

public EnvironmentFacade getEnvironmentFacade()

closeConfigurationStore

public void closeConfigurationStore()
                             throws StoreException

Specified by:

closeConfigurationStore in interface DurableConfigurationStore

Throws:

StoreException

create

public void create(ConfiguredObjectRecord configuredObject)
            throws StoreException

Description copied from interface: DurableConfigurationStore

Makes the specified object persistent.

Specified by:

create in interface DurableConfigurationStore

Parameters:

configuredObject - The object to persist.

Throws:

StoreException - If the operation fails for any reason.

remove

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

Description copied from interface: DurableConfigurationStore

Removes the specified persistent configured objects.

Specified by:

remove in interface DurableConfigurationStore

Parameters:

objects - The objects to remove.

Throws:

StoreException - If the operation fails for any reason.

update

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

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

Throws:

StoreException - If the operation fails for any reason.

getMessageStore

public MessageStore getMessageStore()

Specified by:

getMessageStore in interface MessageStoreProvider

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