Package org.europa.together.application

Class ConfigurationHbmDAO

java.lang.Object

org.europa.together.application.GenericHbmDAO<ConfigurationDO,String>

org.europa.together.application.ConfigurationHbmDAO

All Implemented Interfaces:

Serializable, ConfigurationDAO, GenericDAO<ConfigurationDO,String>

@Repository
@Transactional
public class ConfigurationHbmDAO
extends GenericHbmDAO<ConfigurationDO,String>
implements ConfigurationDAO

Implementation of the ConfigurationDAO.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.europa.together.application.GenericHbmDAO

mainEntityManagerFactory

Fields inherited from interface org.europa.together.business.ConfigurationDAO

FEATURE_ID

Fields inherited from interface org.europa.together.business.GenericDAO

FEATURE_ID

Constructor Summary

Constructors

Constructor	Description
ConfigurationHbmDAO()	Constructor.

Method Summary

Modifier and Type	Method	Description
List<ConfigurationDO>	getAllConfigurationSetEntries(String module, String version, String configSet)	Return a List with all configuration objects of a ConfigurationSet.A ConfigurationSet is a collection of all configuration entries of one version for a service like email inside a module.
List<ConfigurationDO>	getAllDeprecatedEntries()	Return a List of all deprecated ConfigurationDO.
List<ConfigurationDO>	getAllModuleEntries(String module)	Get all configuration entries for a module.
ConfigurationDO	getConfigurationByKey(String key, String module, String version)	Get the whole configuration object by a given key, module and the version of the module.
List<ConfigurationDO>	getHistoryOfAEntry(String module, String key, String configSet)	In the case that for a module exist more versions than one.
String	getValueByKey(String key, String module, String version)	Return the value of a key from a module.
void	restoreKeyToDefault(ConfigurationDO entry)	Restore a single entry to his default value.
void	updateConfigurationEntries(List<ConfigurationDO> configuration)	Update a List of existing configuration entries.

Methods inherited from class org.europa.together.application.GenericHbmDAO

countAllElements, create, delete, deserializeJsonAsList, deserializeJsonAsObject, deserializeJsonAsObject, find, getPrimaryKeyOfObject, listAllElements, serializeAsJson, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.europa.together.business.GenericDAO

countAllElements, create, delete, deserializeJsonAsList, deserializeJsonAsObject, deserializeJsonAsObject, find, getPrimaryKeyOfObject, listAllElements, serializeAsJson, update

Constructor Details

ConfigurationHbmDAO

public ConfigurationHbmDAO()

Constructor.

Method Details

updateConfigurationEntries

public void updateConfigurationEntries(List<ConfigurationDO> configuration)
                                throws DAOException

Description copied from interface: ConfigurationDAO

Update a List of existing configuration entries.

Specified by:

updateConfigurationEntries in interface ConfigurationDAO

Parameters:

configuration - as List<Configuration>

Throws:

DAOException - in case of error

getConfigurationByKey

@Transactional(readOnly=true)
public ConfigurationDO getConfigurationByKey(String key,
 String module,
 String version)

Description copied from interface: ConfigurationDAO

Get the whole configuration object by a given key, module and the version of the module.

Specified by:

getConfigurationByKey in interface ConfigurationDAO

Parameters:

key - as String

module - as String

version - as String

Returns:

configuration as Object

getAllConfigurationSetEntries

@Transactional(readOnly=true)
public List<ConfigurationDO> getAllConfigurationSetEntries(String module,
 String version,
 String configSet)

Description copied from interface: ConfigurationDAO

Return a List with all configuration objects of a ConfigurationSet.A ConfigurationSet is a collection of all configuration entries of one version for a service like email inside a module.

Specified by:

getAllConfigurationSetEntries in interface ConfigurationDAO

Parameters:

module - as String

version - as String

configSet - as Sting

Returns:

ConfigurationSet as List<Configuration>

getAllModuleEntries

@Transactional(readOnly=true)
public List<ConfigurationDO> getAllModuleEntries(String module)

Description copied from interface: ConfigurationDAO

Get all configuration entries for a module.

Specified by:

getAllModuleEntries in interface ConfigurationDAO

Parameters:

module - as String

Returns:

ConfigurationSet as List<Configuration>

getAllDeprecatedEntries

@Transactional(readOnly=true)
public List<ConfigurationDO> getAllDeprecatedEntries()

Description copied from interface: ConfigurationDAO

Return a List of all deprecated ConfigurationDO.

Specified by:

getAllDeprecatedEntries in interface ConfigurationDAO

Returns:

deprecated as List<Configuration>

getHistoryOfAEntry

@Transactional(readOnly=true)
public List<ConfigurationDO> getHistoryOfAEntry(String module,
 String key,
 String configSet)

Description copied from interface: ConfigurationDAO

In the case that for a module exist more versions than one. For example after some upgrades, this method supports a history function of the previous configuration.

Specified by:

getHistoryOfAEntry in interface ConfigurationDAO

Parameters:

module - as String

key - as String

configSet - as String

Returns:

history as List<Configuration>

getValueByKey

@Transactional(readOnly=true)
public String getValueByKey(String key,
 String module,
 String version)

Description copied from interface: ConfigurationDAO

Return the value of a key from a module. The hashing of the key will be done in this function, so the usage is more easy. The identifier for a configuration entry is a combination of the key itself, the module-name and the module-version were the DAO stored who use the module. e. g.: E-Mail Configuration is implemented in core, since version 1.0 In the case a entry exist but the value is empty, then the default value will used.

Specified by:

getValueByKey in interface ConfigurationDAO

Parameters:

key - as String

module - as String

version - as String

Returns:

value as String

restoreKeyToDefault

public void restoreKeyToDefault(ConfigurationDO entry)
                         throws DAOException

Description copied from interface: ConfigurationDAO

Restore a single entry to his default value.

Specified by:

restoreKeyToDefault in interface ConfigurationDAO

Parameters:

entry - as Configuration

Throws:

DAOException - in case of error