org.apache.qpid.server.store

Class JsonFileConfigStore

java.lang.Object

org.apache.qpid.server.store.JsonFileConfigStore

All Implemented Interfaces:

DurableConfigurationStore

public class JsonFileConfigStore
extends Object
implements DurableConfigurationStore

Constructor Summary

Constructors

Constructor and Description
JsonFileConfigStore(Class<? extends ConfiguredObject> rootClass)

Method Summary

Modifier and Type	Method and Description
void	closeConfigurationStore()
void	create(ConfiguredObjectRecord record) Makes the specified object persistent.
protected void	load(boolean overwrite, ConfiguredObjectRecord[] initialRecords)
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

Constructor Detail

JsonFileConfigStore

public JsonFileConfigStore(Class<? extends ConfiguredObject> rootClass)

Method Detail

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.

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

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

load

protected void load(boolean overwrite,
                    ConfiguredObjectRecord[] initialRecords)

create

public void create(ConfiguredObjectRecord record)
            throws StoreException

Description copied from interface: DurableConfigurationStore

Makes the specified object persistent.

Specified by:

create in interface DurableConfigurationStore

Parameters:

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

closeConfigurationStore

public void closeConfigurationStore()

Specified by:

closeConfigurationStore in interface DurableConfigurationStore

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