org.apache.qpid.server.store

Class AbstractJDBCConfigurationStore

java.lang.Object

org.apache.qpid.server.store.AbstractJDBCConfigurationStore

All Implemented Interfaces:

DurableConfigurationStore, MessageStoreProvider

Direct Known Subclasses:

DerbyConfigurationStore, GenericJDBCConfigurationStore

public abstract class AbstractJDBCConfigurationStore
extends Object
implements MessageStoreProvider, DurableConfigurationStore

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	CONFIGURATION_STORE_TABLE_NAMES

Constructor Summary

Constructors

Constructor and Description
AbstractJDBCConfigurationStore()

Method Summary

Modifier and Type	Method and Description
protected abstract void	checkConfigurationStoreOpen()
void	create(ConfiguredObjectRecord object) Makes the specified object persistent.
protected void	createOrOpenConfigurationStoreDatabase(boolean clear)
protected abstract String	getBlobAsString(ResultSet rs, int col)
protected abstract Connection	getConnection()
protected abstract org.slf4j.Logger	getLogger()
protected abstract String	getSqlBigIntType()
protected abstract String	getSqlBlobType()
protected abstract String	getSqlVarBinaryType(int size)
protected boolean	hasNoConfigurationEntries()
protected Connection	newAutoCommitConnection() Convenience method to create a new Connection configured for TRANSACTION_READ_COMMITED isolation and with auto-commit transactions enabled.
protected Connection	newConnection() Convenience method to create a new Connection configured for TRANSACTION_READ_COMMITED isolation and with auto-commit transactions disabled.
void	onDelete(ConfiguredObject<?> parent) Deletes the configuration store from its underlying storage.
UUID[]	remove(ConfiguredObjectRecord... objects) Removes the specified persistent configured objects.
protected boolean	tableExists(String tableName, Connection conn)
void	update(boolean createIfNecessary, ConfiguredObjectRecord... records) Updates the specified objects in the persistent store, IF it is already present.
protected void	upgradeIfNecessary(ConfiguredObject<?> parent)
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

Methods inherited from interface org.apache.qpid.server.store.MessageStoreProvider

getMessageStore

Methods inherited from interface org.apache.qpid.server.store.DurableConfigurationStore

closeConfigurationStore, openConfigurationStore, upgradeStoreStructure

Field Detail

CONFIGURATION_STORE_TABLE_NAMES

public static final Set<String> CONFIGURATION_STORE_TABLE_NAMES

Constructor Detail

AbstractJDBCConfigurationStore

public AbstractJDBCConfigurationStore()

Method Detail

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

checkConfigurationStoreOpen

protected abstract void checkConfigurationStoreOpen()

upgradeIfNecessary

protected void upgradeIfNecessary(ConfiguredObject<?> parent)
                           throws StoreException

Throws:

StoreException

getLogger

protected abstract org.slf4j.Logger getLogger()

getSqlBlobType

protected abstract String getSqlBlobType()

getSqlVarBinaryType

protected abstract String getSqlVarBinaryType(int size)

getSqlBigIntType

protected abstract String getSqlBigIntType()

createOrOpenConfigurationStoreDatabase

protected void createOrOpenConfigurationStoreDatabase(boolean clear)
                                               throws StoreException

Throws:

StoreException

tableExists

protected boolean tableExists(String tableName,
                              Connection conn)
                       throws SQLException

Throws:

SQLException

create

public void create(ConfiguredObjectRecord object)
            throws StoreException

Description copied from interface: DurableConfigurationStore

Makes the specified object persistent.

Specified by:

create in interface DurableConfigurationStore

Parameters:

object - The object to persist.

Throws:

StoreException - If the operation fails for any reason.

newAutoCommitConnection

protected Connection newAutoCommitConnection()
                                      throws SQLException

Convenience method to create a new Connection configured for TRANSACTION_READ_COMMITED isolation and with auto-commit transactions enabled.

Throws:

SQLException

newConnection

protected Connection newConnection()
                            throws SQLException

Convenience method to create a new Connection configured for TRANSACTION_READ_COMMITED isolation and with auto-commit transactions disabled.

Throws:

SQLException

hasNoConfigurationEntries

protected boolean hasNoConfigurationEntries()

getConnection

protected abstract Connection getConnection()
                                     throws SQLException

Throws:

SQLException

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.

getBlobAsString

protected abstract String getBlobAsString(ResultSet rs,
                                          int col)
                                   throws SQLException

Throws:

SQLException

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