Package de.businesscode.bcdui.toolbox

Class Configuration

java.lang.Object

de.businesscode.bcdui.toolbox.Configuration

All Implemented Interfaces:

ConfigurationProvider

public class Configuration
extends Object
implements ConfigurationProvider

This class extends the JNDIProvider and offers a common API to retrieve configuration parameter from JNDI context as specified by servlet spec, furthermore this class cascades the configuration via DbProperties allowing to manage dynamic properties from database. all API refer to "server" scope in sense of DbProperties scope, except of getClientParameters() which provides "client" scope configuration from database.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Configuration.OPT_CLASSES

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_DB_RELOAD_SEC
static final String	CONFIG_FILE_PATH_KEY
static final String	DEFAULT_DB_CONTEXT_ID
static final String	DISABLE_CACHE
static final String	VFS_CATALOG_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Configuration()

Method Summary

Modifier and Type	Method	Description
<T> void	addConfigurationParameter(String id, T value)	see BareConfiguration.addConfigurationParameter(String, Object)
void	closeAllConnections(boolean rollback)	see BareConfiguration.closeAllConnections(boolean)
static <T> T	getClassInstance(Configuration.OPT_CLASSES name, Class<?>[] types, Object... params)	like getClassoption(OPT_CLASSES) but looks for public constructor accepting given types and instantiates the class, with given params in case a class is not found this method returns null, in case a class is found but a constructor is missing, this method throws an exception.
static <T> T	getClassInstance(Class<?> clazz, Class<?>[] types, Object... params)	Looks for a public constructor accepting given types and instantiates the class, with given params. in case a class a constructor is missing, this method throws an exception.
static Class<?>	getClassoption(Configuration.OPT_CLASSES name)	Returns for a given token Configuration.OPT_CLASSES the 'best' class, or null if none 'Best' means the one with the highest priority according to optionalClassesPrio found in classpath Can be switched to CDI, once available on all platforms
HashMap<String,Object>	getClientParameters()	retrieve client properties
Object	getConfigurationParameter(String id)	retrieve a (mandatory) parameter or throw exception, also see ConfigurationProvider.getConfigurationParameterOrNull(String)
<T> T	getConfigurationParameter(String id, T defaultValue)	getter for configuration parameter including downcast
Object	getConfigurationParameterOrNull(String id)	retrieve parameter
static Configuration	getInstance()
Connection	getManagedConnection(String dbSourceName)	see BareConfiguration.getManagedConnection(String)
Connection	getManagedConnection(String dbSourceName, boolean closedByRequestLifeCycleFilter)	see BareConfiguration.getManagedConnection(String)
Connection	getUnmanagedConnection(String dbSourceName)	see BareConfiguration.getUnmanagedConnection(String)
DataSource	getUnmanagedDataSource(String dbSourceName)	convenience getter for getUnmanagedDataSource(String)
static boolean	isCacheDisabled()	see BareConfiguration.isCacheDisabled()

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_FILE_PATH_KEY

public static final String CONFIG_FILE_PATH_KEY

See Also:

• Constant Field Values

DISABLE_CACHE

public static final String DISABLE_CACHE

See Also:

• Constant Field Values

VFS_CATALOG_KEY

public static final String VFS_CATALOG_KEY

See Also:

• Constant Field Values

CONFIG_DB_RELOAD_SEC

public static final String CONFIG_DB_RELOAD_SEC

See Also:

• Constant Field Values

DEFAULT_DB_CONTEXT_ID

public static final String DEFAULT_DB_CONTEXT_ID

See Also:

• Constant Field Values

Constructor Details

Configuration

protected Configuration()

Method Details

getInstance

public static Configuration getInstance()

getConfigurationParameter

public Object getConfigurationParameter(String id)

Description copied from interface: ConfigurationProvider

retrieve a (mandatory) parameter or throw exception, also see ConfigurationProvider.getConfigurationParameterOrNull(String)

Specified by:

getConfigurationParameter in interface ConfigurationProvider

Returns:

configuration parameter instance

getConfigurationParameter

public <T> T getConfigurationParameter(String id,
 T defaultValue)

Description copied from interface: ConfigurationProvider

getter for configuration parameter including downcast

Specified by:

getConfigurationParameter in interface ConfigurationProvider

Returns:

configuration parameter instance or defaultValue

getConfigurationParameterOrNull

public Object getConfigurationParameterOrNull(String id)

Description copied from interface: ConfigurationProvider

retrieve parameter

Specified by:

getConfigurationParameterOrNull in interface ConfigurationProvider

Returns:

configuration parameter instance or NULL

getClientParameters

public HashMap<String,Object> getClientParameters()

retrieve client properties

Returns:

client properties OR null in case no are specified or DbProperties is not available

isCacheDisabled

public static boolean isCacheDisabled()

see BareConfiguration.isCacheDisabled()

Returns:

getManagedConnection

public Connection getManagedConnection(String dbSourceName)
                                throws Exception

see BareConfiguration.getManagedConnection(String)

Parameters:

dbSourceName -

Returns:

Throws:

Exception

getManagedConnection

public Connection getManagedConnection(String dbSourceName,
 boolean closedByRequestLifeCycleFilter)
                                throws Exception

see BareConfiguration.getManagedConnection(String)

Parameters:

dbSourceName -

Returns:

Throws:

Exception

getUnmanagedConnection

public Connection getUnmanagedConnection(String dbSourceName)
                                  throws Exception

see BareConfiguration.getUnmanagedConnection(String)

Parameters:

dbSourceName -

Returns:

Throws:

Exception

addConfigurationParameter

public <T> void addConfigurationParameter(String id,
 T value)

see BareConfiguration.addConfigurationParameter(String, Object)

Parameters:

id -

value -

closeAllConnections

public void closeAllConnections(boolean rollback)
                         throws SQLException

see BareConfiguration.closeAllConnections(boolean)

Parameters:

rollback -

Throws:

SQLException

getUnmanagedDataSource

public DataSource getUnmanagedDataSource(String dbSourceName)
                                  throws Exception

convenience getter for getUnmanagedDataSource(String)

Parameters:

dbSourceName -

Returns:

see getUnmanagedDataSource(String)

Throws:

Exception

getClassoption

public static Class<?> getClassoption(Configuration.OPT_CLASSES name)

Returns for a given token Configuration.OPT_CLASSES the 'best' class, or null if none 'Best' means the one with the highest priority according to optionalClassesPrio found in classpath Can be switched to CDI, once available on all platforms

Parameters:

name -

Returns:

getClassInstance

public static <T> T getClassInstance(Configuration.OPT_CLASSES name,
 Class<?>[] types,
 Object... params)
                              throws RuntimeException

like getClassoption(OPT_CLASSES) but looks for public constructor accepting given types and instantiates the class, with given params in case a class is not found this method returns null, in case a class is found but a constructor is missing, this method throws an exception.

Parameters:

name - of class binding

types - to be accepted by constructor

params - the params in exact order as types

Returns:

the instance of matched class or null in case no such class could be found

Throws:

RuntimeException - in case the class is missing a constructor accepting given parameters or if the instantiation fails

getClassInstance

public static <T> T getClassInstance(Class<?> clazz,
 Class<?>[] types,
 Object... params)
                              throws RuntimeException

Looks for a public constructor accepting given types and instantiates the class, with given params. in case a class a constructor is missing, this method throws an exception.

Parameters:

clazz - to instantiate

types - to be accepted by constructor

params - the params in exact order as types

Returns:

the instance of matched class

Throws:

RuntimeException - in case the class is missing a constructor accepting given parameters or if the instantiation fails