Class DatabaseConfiguration
java.lang.Object
org.apache.commons.configuration2.event.BaseEventSource
org.apache.commons.configuration2.AbstractConfiguration
org.apache.commons.configuration2.DatabaseConfiguration
- All Implemented Interfaces:
Configuration,EventSource,ImmutableConfiguration,SynchronizerSupport
Configuration stored in a database. The properties are retrieved from a table containing at least one column for the
keys, and one column for the values. It's possible to store several configurations in the same table by adding a
column containing the name of the configuration. The name of the table and the columns have to be specified using the
corresponding properties.
The recommended way to create an instance of DatabaseConfiguration is to use a configuration
builder. The builder is configured with a special parameters object defining the database structures used by the
configuration. Such an object can be created using the database() method of the Parameters class. See
the examples below for more details.
Example 1 - One configuration per table
CREATE TABLE myconfig (
`key` VARCHAR NOT NULL PRIMARY KEY,
`value` VARCHAR
);
INSERT INTO myconfig (key, value) VALUES ('foo', 'bar');
BasicConfigurationBuilder<DatabaseConfiguration> builder =
new BasicConfigurationBuilder<DatabaseConfiguration>(DatabaseConfiguration.class);
builder.configure(
Parameters.database()
.setDataSource(dataSource)
.setTable("myconfig")
.setKeyColumn("key")
.setValueColumn("value")
);
Configuration config = builder.getConfiguration();
String value = config.getString("foo");
Example 2 - Multiple configurations per table
CREATE TABLE myconfigs (
`name` VARCHAR NOT NULL,
`key` VARCHAR NOT NULL,
`value` VARCHAR,
CONSTRAINT sys_pk_myconfigs PRIMARY KEY (`name`, `key`)
);
INSERT INTO myconfigs (name, key, value) VALUES ('config1', 'key1', 'value1');
INSERT INTO myconfigs (name, key, value) VALUES ('config2', 'key2', 'value2');
BasicConfigurationBuilder<DatabaseConfiguration> builder =
new BasicConfigurationBuilder<DatabaseConfiguration>(DatabaseConfiguration.class);
builder.configure(
Parameters.database()
.setDataSource(dataSource)
.setTable("myconfigs")
.setKeyColumn("key")
.setValueColumn("value")
.setConfigurationNameColumn("name")
.setConfigurationName("config1")
);
Configuration config1 = new DatabaseConfiguration(dataSource, "myconfigs", "name", "key", "value", "config1");
String value1 = conf.getString("key1");
The configuration can be instructed to perform commits after database updates. This is achieved by setting the
commits parameter of the constructors to true. If commits should not be performed (which is the
default behavior), it should be ensured that the connections returned by the DataSource are in auto-commit
mode.
Note: Like JDBC itself, protection against SQL injection is left to the user.
- Since:
- 1.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddPropertyDirect(String key, Object obj) Adds a property to this configuration.protected voidaddPropertyInternal(String key, Object value) Adds a property to this configuration.protected voidRemoves all entries from this configuration.protected voidRemoves the specified value from this configuration.protected voidclose(Connection conn, Statement stmt, ResultSet rs) Close the specified database objects.protected booleanChecks whether this configuration contains the specified key.protected booleancontainsValueInternal(Object value) Tests whether this configuration contains one or more matches to this value.protected ObjectExtracts the value of a property from the given result set.Gets the name of this configuration instance.Gets the name of the table column with the configuration name.Deprecated.Gets theDataSourcefor obtaining database connections.Gets the name of the column containing the configuration keys.Returns an iterator with the names of all properties contained in this configuration.protected ObjectGets the value of the specified property.getTable()Gets the name of the table containing configuration data.Gets the name of the column containing the configuration values.booleanReturns a flag whether this configuration performs commits after database updates.protected booleanChecks if this configuration is empty.voidsetAutoCommit(boolean autoCommit) Sets the auto commit flag.voidsetConfigurationName(String configurationName) Sets the name of this configuration instance.voidsetConfigurationNameColumn(String configurationNameColumn) Sets the name of the table column with the configuration name.voidsetDataSource(DataSource dataSource) Sets theDataSourcefor obtaining database connections.voidsetKeyColumn(String keyColumn) Sets the name of the column containing the configuration keys.voidSets the name of the table containing configuration data.voidsetValueColumn(String valueColumn) Sets the name of the column containing the configuration values.Methods inherited from class org.apache.commons.configuration2.AbstractConfiguration
addErrorLogListener, addProperty, append, beginRead, beginWrite, clear, clearProperty, cloneInterpolator, contains, containsKey, containsValue, copy, endRead, endWrite, get, get, getArray, getArray, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCollection, getCollection, getConfigurationDecoder, getConversionHandler, getDouble, getDouble, getDouble, getDuration, getDuration, getEncodedString, getEncodedString, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getKeys, getKeys, getKeys, getKeysInternal, getKeysInternal, getList, getList, getList, getList, getListDelimiterHandler, getLogger, getLong, getLong, getLong, getProperties, getProperties, getProperty, getShort, getShort, getShort, getString, getString, getStringArray, getSynchronizer, immutableSubset, initLogger, installInterpolator, interpolate, interpolate, interpolatedConfiguration, isEmpty, isScalarValue, isThrowExceptionOnMissing, lock, setConfigurationDecoder, setConversionHandler, setDefaultLookups, setInterpolator, setListDelimiterHandler, setLogger, setParentInterpolator, setPrefixLookups, setProperty, setPropertyInternal, setSynchronizer, setThrowExceptionOnMissing, size, sizeInternal, subset, unlockMethods inherited from class org.apache.commons.configuration2.event.BaseEventSource
addEventListener, clearErrorListeners, clearEventListeners, clone, copyEventListeners, createErrorEvent, createEvent, fireError, fireEvent, getEventListenerRegistrations, getEventListeners, isDetailEvents, removeEventListener, setDetailEventsMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.commons.configuration2.ImmutableConfiguration
getEnum, getEnum
-
Constructor Details
-
DatabaseConfiguration
public DatabaseConfiguration()Creates a new instance ofDatabaseConfiguration.
-
-
Method Details
-
addPropertyDirect
Adds a property to this configuration. If this causes a database error, an error event will be generated of typeADD_PROPERTYwith the causing exception. The event'spropertyNameis set to the passed in property key, thepropertyValuepoints to the passed in value.- Specified by:
addPropertyDirectin classAbstractConfiguration- Parameters:
key- the property keyobj- the value of the property to add
-
addPropertyInternal
Adds a property to this configuration. This implementation temporarily disables list delimiter parsing, so that even if the value contains the list delimiter, only a single record is written into the managed table. The implementation ofgetProperty()takes care about delimiters. So list delimiters are fully supported byDatabaseConfiguration, but internally treated a bit differently.- Overrides:
addPropertyInternalin classAbstractConfiguration- Parameters:
key- the key of the new propertyvalue- the value to be added
-
clearInternal
Removes all entries from this configuration. If this causes a database error, an error event will be generated of typeCLEARwith the causing exception. Both the event'spropertyNameand thepropertyValuewill be undefined.- Overrides:
clearInternalin classAbstractConfiguration
-
clearPropertyDirect
Removes the specified value from this configuration. If this causes a database error, an error event will be generated of typeCLEAR_PROPERTYwith the causing exception. The event'spropertyNamewill be set to the passed in key, thepropertyValuewill be undefined.- Specified by:
clearPropertyDirectin classAbstractConfiguration- Parameters:
key- the key of the property to be removed
-
close
Close the specified database objects. Avoid closing if null and hide any SQLExceptions that occur.- Parameters:
conn- The database connection to closestmt- The statement to closers- the result set to close
-
containsKeyInternal
Checks whether this configuration contains the specified key. If this causes a database error, an error event will be generated of typeREADwith the causing exception. The event'spropertyNamewill be set to the passed in key, thepropertyValuewill be undefined.- Specified by:
containsKeyInternalin classAbstractConfiguration- Parameters:
key- the key to be checked- Returns:
- a flag whether this key is defined
-
containsValueInternal
Tests whether this configuration contains one or more matches to this value. This operation stops at first match but may be more expensive than the containsKey method.- Specified by:
containsValueInternalin classAbstractConfiguration- Parameters:
value- the value in question- Returns:
trueif and only if some key maps to thevalueargument in this configuration as determined by theequalsmethod;falseotherwise.- Since:
- 2.11.0
-
extractPropertyValue
Extracts the value of a property from the given result set. The passed inResultSetwas created by a SELECT statement on the underlying database table. This implementation reads the value of the column determined by thevalueColumnproperty. Normally the contained value is directly returned. However, if it is of typeCLOB, text is extracted as string.- Parameters:
rs- the currentResultSet- Returns:
- the value of the property column
- Throws:
SQLException- if an error occurs
-
getConfigurationName
Gets the name of this configuration instance.- Returns:
- the name of this configuration
-
getConfigurationNameColumn
Gets the name of the table column with the configuration name.- Returns:
- the name of the configuration name column
-
getDatasource
Deprecated.UsegetDataSource()Gets the usedDataSourceobject.- Returns:
- the data source
- Since:
- 1.4
-
getDataSource
Gets theDataSourcefor obtaining database connections.- Returns:
- the
DataSource
-
getKeyColumn
Gets the name of the column containing the configuration keys.- Returns:
- the name of the key column
-
getKeysInternal
Returns an iterator with the names of all properties contained in this configuration. If this causes a database error, an error event will be generated of typeREADwith the causing exception. Both the event'spropertyNameand thepropertyValuewill be undefined.- Specified by:
getKeysInternalin classAbstractConfiguration- Returns:
- an iterator with the contained keys (an empty iterator in case of an error)
-
getPropertyInternal
Gets the value of the specified property. If this causes a database error, an error event will be generated of typeREADwith the causing exception. The event'spropertyNameis set to the passed in property key, thepropertyValueis undefined.- Specified by:
getPropertyInternalin classAbstractConfiguration- Parameters:
key- the key of the desired property- Returns:
- the value of this property
-
getTable
Gets the name of the table containing configuration data.- Returns:
- the name of the table to be queried
-
getValueColumn
Gets the name of the column containing the configuration values.- Returns:
- the name of the value column
-
isAutoCommit
Returns a flag whether this configuration performs commits after database updates.- Returns:
- a flag whether commits are performed
-
isEmptyInternal
Checks if this configuration is empty. If this causes a database error, an error event will be generated of typeREADwith the causing exception. Both the event'spropertyNameandpropertyValuewill be undefined.- Specified by:
isEmptyInternalin classAbstractConfiguration- Returns:
- a flag whether this configuration is empty.
-
setAutoCommit
Sets the auto commit flag. If set to true, this configuration performs a commit after each database update.- Parameters:
autoCommit- the auto commit flag
-
setConfigurationName
Sets the name of this configuration instance.- Parameters:
configurationName- the name of this configuration
-
setConfigurationNameColumn
Sets the name of the table column with the configuration name.- Parameters:
configurationNameColumn- the name of the column with the configuration name
-
setDataSource
Sets theDataSourcefor obtaining database connections.- Parameters:
dataSource- theDataSource
-
setKeyColumn
Sets the name of the column containing the configuration keys.- Parameters:
keyColumn- the name of the key column
-
setTable
Sets the name of the table containing configuration data.- Parameters:
table- the table name
-
setValueColumn
Sets the name of the column containing the configuration values.- Parameters:
valueColumn- the name of the value column
-
getDataSource()