dk.heick.properties.io

Class AbstractJDBCPropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.AbstractJDBCPropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

Direct Known Subclasses:

DatasourceJDBCPropertyIO, UrlJDBCPropertyIO

public abstract class AbstractJDBCPropertyIO
extends AbstractPropertyIO

Abstract class which implements all the JDBC handling, all it needs is the implementation of getConnection.
Important: All communication with the database do end with close() of the connection.
Important: Default value field length is set to a 1000 characters, this can be set manually.
Important: When setting a value, it will only do UPDATES, it is assumed that a row with the corresponding name exists.

Since:

1.0

Author:

Frederik Heick

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_VALUE_FIELD_LENGTH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJDBCPropertyIO(String tableName, String nameField, String valueField, boolean readonly, boolean cached) Constructs a AbstractJDBCPropertyIO

Method Summary

Modifier and Type	Method and Description
String	backup() Returns a string containing all the properties [name=value] in the PropertyIO seperated by a line feed [
String	backupWithUpdate() A method that generate SQL which updates all known properties with its values.
protected void	close(ResultSet resultSet, Statement statement, PreparedStatement preparedStatement, Connection connection) Will class the close method on all the parameters if the are not null.
abstract Connection	getConnection() Gets the connection to the database.
int	getMaxValueFieldLength() Gets the max number of characters a value may contain.
String	getNameField() The name of column in table which holds the property name.
Properties	getProperties() Gets all the name,value pair in a Properties class instance.
String	getTableName() The table to access.
String	getValue(String propertyName) Gets the string value of the name.
String	getValueField() The name of column in table which holds the property value as string.
void	reload() Reloads the name,value pairs for the PropertyIO, or forces the values to reload when read next time.
void	setMaxValueFieldLength(int maxValueFieldLength) Sets the max number of characters a value (as a string) may contain, otherwise a PropertyException thrown upon setting the value.
void	setValue(String propertyName, String value) Sets the name,value as String in the IO.
void	validate() Validates the PropertyIO.

Methods inherited from class dk.heick.properties.io.AbstractPropertyIO

getCacheTime, getLastLoaded, getLastSaved, getLogger, getTypedProperties, getTypedValue, isCached, isReadonly, logPerformanceGetProperties, logPerformanceSetValue, setCacheTime, storeTypedValue, updateLastLoaded, updateLastSaved, validateWritable

Methods inherited from class java.lang.Object

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

Methods inherited from interface dk.heick.properties.PropertyIO

getName, getSource

Field Detail

DEFAULT_MAX_VALUE_FIELD_LENGTH

public static final int DEFAULT_MAX_VALUE_FIELD_LENGTH

See Also:

Constant Field Values

Constructor Detail

AbstractJDBCPropertyIO

protected AbstractJDBCPropertyIO(String tableName,
                                 String nameField,
                                 String valueField,
                                 boolean readonly,
                                 boolean cached)

Constructs a AbstractJDBCPropertyIO

Parameters:

tableName - the name of the table to read and write from.

nameField - the name of the table field which hold the properties unique name. Must be of String field type.

valueField - the name of the table field which hold the properties value. Must be of String field type.

readonly - is the AbstractJDBCPropertyIO be read only.

cached - shall the values be cached in the PropertyIO's.

Method Detail

getConnection

public abstract Connection getConnection()
                                  throws SQLException

Gets the connection to the database.

Returns:

a connection

Throws:

SQLException - if not possible to get a connection.

See Also:

Connection

getTableName

public String getTableName()

The table to access.

Returns:

the table name.

getNameField

public String getNameField()

The name of column in table which holds the property name.

Returns:

the name of the column which holds the property name.

See Also:

getTableName()

getValueField

public String getValueField()

The name of column in table which holds the property value as string.

Returns:

the name of the column which holds the property value.

See Also:

getTableName()

getMaxValueFieldLength

public int getMaxValueFieldLength()

Gets the max number of characters a value may contain.

Returns:

the max length of a value as a string.

setMaxValueFieldLength

public void setMaxValueFieldLength(int maxValueFieldLength)

Sets the max number of characters a value (as a string) may contain, otherwise a PropertyException thrown upon setting the value.

Parameters:

maxValueFieldLength - the max length of a value as a string, if value is less than 1, no check is performed.

getValue

public String getValue(String propertyName)

Description copied from interface: PropertyIO

Gets the string value of the name.
Remember to use the cached value, if it shall be used.
IMPORTANT : When reading a value from a PropertyIO, the value is pre parsed before validation. Remember to call this method in your implementation.
You can use ${name} in the value, will be passed by the StringUtils.replaceInlinedProperties(String) method, to replace ${name} where name can either be a System.getProperty(String) or System.getenv(String).

Specified by:

getValue in interface PropertyIO

Overrides:

getValue in class AbstractPropertyIO

Parameters:

propertyName - the name of the property.

Returns:

the value of the property name, if none exists null is returned.

See Also:

StringUtils.replaceInlinedProperties(String), PropertyFrameworkGlobals

setValue

public void setValue(String propertyName,
                     String value)
              throws PropertyIOException

Description copied from interface: PropertyIO

Sets the name,value as String in the IO. Many IO implementations reloads when a value is set to refresh cache.
This is recommended, but the framework will update cache items with new values.

Parameters:

propertyName - the name of the property

value - the string value of the property.

Throws:

PropertyIOException - if the IO is readonly or failed to write the value.

validate

public void validate()
              throws PropertyIOException

Description copied from interface: PropertyIO

Validates the PropertyIO.

Throws:

PropertyIOException

reload

public void reload()

Description copied from interface: PropertyIO

Reloads the name,value pairs for the PropertyIO, or forces the values to reload when read next time. Remember to both reset properties and typed value cache if used.

Specified by:

reload in interface PropertyIO

Overrides:

reload in class AbstractPropertyIO

getProperties

public Properties getProperties()

Description copied from interface: PropertyIO

Gets all the name,value pair in a Properties class instance.

Returns:

the Properties available for the IO.

See Also:

Properties

close

protected final void close(ResultSet resultSet,
                           Statement statement,
                           PreparedStatement preparedStatement,
                           Connection connection)

Will class the close method on all the parameters if the are not null. Exceptions on close is logged as a warning.

Parameters:

resultSet - a resultSet.

statement - a statement.

preparedStatement - a preparementStatement.

connection - a connection.

backup

public String backup()

Description copied from interface: PropertyIO

Returns a string containing all the properties [name=value] in the PropertyIO seperated by a line feed [

\n

].

Specified by:

backup in interface PropertyIO

Overrides:

backup in class AbstractPropertyIO

Returns:

a back string with all the properties.

backupWithUpdate

public String backupWithUpdate()

A method that generate SQL which updates all known properties with its values.

Returns:

a update sql for each property name and its value.