Package com.saperion.common.config.manager

Class DbConfigurationManagerConstructorParameters<CommonAccessException extends java.lang.Exception>

java.lang.Object

com.saperion.common.config.manager.DbConfigurationManagerConstructorParameters<CommonAccessException>

Type Parameters:

CommonAccessException - the common access exception type of the underlying DataSource and so of the DbConfigurationManager to be created.

public final class DbConfigurationManagerConstructorParameters<CommonAccessException extends java.lang.Exception>
extends java.lang.Object

The DbConfigurationManagerConstructorParameters accumulates the parameters for construction of a DbConfigurationManager and their defaults. See the individual setter-methods for the concrete default values.

Author:

agz

See Also:

DbConfigurationManager(DbConfigurationManagerConstructorParameters), DbConfigurationManager, DataSource, NotFoundReactionType, StorageType, Cipher

Constructor Summary

Constructors

Constructor	Description
DbConfigurationManagerConstructorParameters(DataSource<CommonAccessException,java.lang.IllegalStateException> dataSource)	Creates new DbConfigurationManagerConstructorParameters with the specified DataSource and all other values set to defaults.

Method Summary

Modifier and Type	Method	Description
Cipher	getCipher()	Returns the Cipher that should be used to encrypt/decrypt the configuration values.
DataSource<CommonAccessException,java.lang.IllegalStateException>	getDataSource()	Returns the DataSource.
NotFoundReactionType	getDefaultNotFoundReactionType()	Returns the NotFoundReactionType that defines for DbConfigurationManager.get...()-methods the behavior if the requested configuration value was not found.
StorageType	getDefaultStorageType()	Returns the default StorageType that applies for all get...()-methods of DbConfigurationManager that have no StorageType-parameter or for those that have one called with StorageType.DEFAULT.
Pair<java.security.Key,java.security.Key>	getEncryptionKeys()	Returns a Pair of Keys that should be used to encrypt/decrypt the configuration values.
HierarchicalName	getRootName()	Returns the root name.
java.lang.String	getTableName()	Returns the name of the underlying database table to load and store the configuration value to/from.
DbConfigurationManagerConstructorParameters<CommonAccessException>	setDefaultNotFoundReactionType(NotFoundReactionType defaultNotFoundReactionType)	Sets the default NotFoundReactionType that defines for DbConfigurationManager.get...()-methods the behavior if the requested configuration value was not found.
DbConfigurationManagerConstructorParameters<CommonAccessException>	setDefaultStorageType(StorageType defaultStorageType)	Sets the default StorageType that applies for all get...()-methods of DbConfigurationManager that have no StorageType-parameter or for those that have one called with StorageType.DEFAULT.
DbConfigurationManagerConstructorParameters<CommonAccessException>	setEncryptionKeys(Cipher cipher, Pair<java.security.Key,java.security.Key> pairEncryptionKeys)	Sets a Cipher and a Pair of Keys that should be used to encrypt/decrypt the configuration values.
void	setRootName(HierarchicalName rootName)	Sets the root name.
DbConfigurationManagerConstructorParameters<CommonAccessException>	setTableName(java.lang.String tableName)	Sets the name of the underlying database table to load and store the configuration value to/from.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DbConfigurationManagerConstructorParameters

public DbConfigurationManagerConstructorParameters(DataSource<CommonAccessException,java.lang.IllegalStateException> dataSource)

Creates new DbConfigurationManagerConstructorParameters with the specified DataSource and all other values set to defaults. See the individual setter-methods for the default values.

Parameters:

dataSource - DataSource

Method Detail

getDataSource

public DataSource<CommonAccessException,java.lang.IllegalStateException> getDataSource()

Returns the DataSource.

Returns:

the DataSource

getTableName

public java.lang.String getTableName()

Returns the name of the underlying database table to load and store the configuration value to/from.

Returns:

the name of the underlying database table

setTableName

public DbConfigurationManagerConstructorParameters<CommonAccessException> setTableName(java.lang.String tableName)

Sets the name of the underlying database table to load and store the configuration value to/from.

The name must not be null or empty and must match the regular expression for table names.

Defaults to "configuration".

Parameters:

tableName - the name of the underlying database table

Returns:

this DbConfigurationManagerConstructorParameters

getRootName

public HierarchicalName getRootName()

Returns the root name.

All entry-keys will start with this root name. If the key specified as a method parameter already starts with the root name it will be used unchanged, else the parameter will be added to the root name before use.

The root name may be null in which case it has no effects, i.e. all key parameters will be used as provided.

Returns:

the root name

setRootName

public void setRootName(HierarchicalName rootName)

Sets the root name.

All entry-keys will start with this root name. If the key specified as a method parameter already starts with the root name it will be used unchanged, else the parameter will be added to the root name before use.

The root name may be null in which case it has no effects, i.e. all key parameters will be used as provided.

Defaults to null.

Parameters:

rootName - root name

getDefaultStorageType

public StorageType getDefaultStorageType()

Returns the default StorageType that applies for all get...()-methods of DbConfigurationManager that have no StorageType-parameter or for those that have one called with StorageType.DEFAULT.

Returns:

the default StorageType

setDefaultStorageType

public DbConfigurationManagerConstructorParameters<CommonAccessException> setDefaultStorageType(StorageType defaultStorageType)

Sets the default StorageType that applies for all get...()-methods of DbConfigurationManager that have no StorageType-parameter or for those that have one called with StorageType.DEFAULT.

The default StorageType must not be null and must not be StorageType.DEFAULT.

Defaults to StorageType.DB_IF_NOTHING_IN_MEMORY.

Parameters:

defaultStorageType - default StorageType

Returns:

this DbConfigurationManagerConstructorParameters

getDefaultNotFoundReactionType

public NotFoundReactionType getDefaultNotFoundReactionType()

Returns the NotFoundReactionType that defines for DbConfigurationManager.get...()-methods the behavior if the requested configuration value was not found.

Returns:

the NotFoundReactionType

setDefaultNotFoundReactionType

public DbConfigurationManagerConstructorParameters<CommonAccessException> setDefaultNotFoundReactionType(NotFoundReactionType defaultNotFoundReactionType)

Sets the default NotFoundReactionType that defines for DbConfigurationManager.get...()-methods the behavior if the requested configuration value was not found.

The default NotFoundReactionType must not be null.

Defaults to NotFoundReactionType.EXCEPTION.

Parameters:

defaultNotFoundReactionType - default NotFoundReactionType

Returns:

this DbConfigurationManagerConstructorParameters

getCipher

public Cipher getCipher()

Returns the Cipher that should be used to encrypt/decrypt the configuration values.

Returns null if encryption/decryption is not active.

Returns:

the Cipher

getEncryptionKeys

public Pair<java.security.Key,java.security.Key> getEncryptionKeys()

Returns a Pair of Keys that should be used to encrypt/decrypt the configuration values.

If the encryption algorithm is asymmetric the first is the public key (used for encryption) and the second is the private key (used for decryption). If the encryption algorithm is symmetric both keys are the same instance. *

Returns null if encryption/decryption is not active.

Returns:

Pair of Keys

setEncryptionKeys

public DbConfigurationManagerConstructorParameters<CommonAccessException> setEncryptionKeys(Cipher cipher,
                                                                                            Pair<java.security.Key,java.security.Key> pairEncryptionKeys)

Sets a Cipher and a Pair of Keys that should be used to encrypt/decrypt the configuration values.

Either both (Cipher and a Pair) must be valid and suiting to each other or both must be null (to deactivate encryption/decryption).

If the encryption algorithm is asymmetric the first must be the public key (used for encryption) and the second must be the private key (used for decryption). If the encryption algorithm is symmetric both keys must be the same instance.

Defaults to null/null.

Parameters:

cipher - the Cipher to use or null

pairEncryptionKeys - the Pair of Keys to use or null

Returns:

this DbConfigurationManagerConstructorParameters

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object