de.gerdiproject.harvest.config

Class Configuration

java.lang.Object

de.gerdiproject.harvest.rest.AbstractRestObject<Configuration,Configuration>

de.gerdiproject.harvest.config.Configuration

All Implemented Interfaces:

IEventListener, ICachedObject

public class Configuration
extends AbstractRestObject<Configuration,Configuration>
implements ICachedObject

This class manages all application AbstractParameters. It can be (de-) serialized to JSON format, saving all parameters that were registered.

Author:

Robin Weiss

Field Summary

Fields inherited from class de.gerdiproject.harvest.rest.AbstractRestObject

moduleName

Constructor Summary

Constructors

Constructor and Description
Configuration(String moduleName, AbstractParameter<?>... parameters) Constructor that requires a list of parameters.

Method Summary

Modifier and Type	Method and Description
void	addEventListeners() Adds event listeners.
String	changeParameters(Map<String,String> values) Changes multiple parameters, returning a status message about the change.
Configuration	getAsJson(javax.ws.rs.core.MultivaluedMap<String,String> query) Returns a JSON representation of this object.
Collection<AbstractParameter<?>>	getParameters() Retrieves a collection of all parameters.
String	getParameterStringValue(String compositeKey) Returns the human readable value of the parameter with a specified key.
<T> T	getParameterValue(String compositeKey) Returns the value of the parameter with a specified key.
protected String	getPrettyPlainText() Returns a pretty print representation of this object.
void	loadFromDisk() Attempts to load a configuration file from disk, overwriting the values of existing parameters, but not adding them if they did not exist before.
static <T extends AbstractParameter<?>> T	registerParameter(T parameter) Convenience function for registering a parameter at the configuration.
void	removeEventListeners() Removes all event listeners of this class.
void	saveToDisk() Saves the configuration as a Json file.
void	setCacheFilePath(String path) Sets the file path to which the configuration can be saved.
void	setParameter(String compositeKey, String value) Changes a configuration parameter, returning a status message about the change.
static void	unregisterParameter(AbstractParameter<?> parameter) Convenience function for unregistering a parameter from the configuration.

Methods inherited from class de.gerdiproject.harvest.rest.AbstractRestObject

getAsPlainText, onContextDestroyed

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration(String moduleName,
                     AbstractParameter<?>... parameters)

Constructor that requires a list of parameters.

Parameters:

moduleName - the name of the service

parameters - a list parameters

Method Detail

registerParameter

public static <T extends AbstractParameter<?>> T registerParameter(T parameter)
                                                            throws IllegalStateException

Convenience function for registering a parameter at the configuration.

Type Parameters:

T - the class of the parameter that is to be registered

Parameters:

parameter - the parameter to be registered

Returns:

the registered parameter as it appears in the configuration

Throws:

IllegalStateException - thrown if no Configuration exists

unregisterParameter

public static void unregisterParameter(AbstractParameter<?> parameter)

Convenience function for unregistering a parameter from the configuration.

Parameters:

parameter - the parameter to be unregistered

addEventListeners

public void addEventListeners()

Description copied from interface: IEventListener

Adds event listeners.

Specified by:

addEventListeners in interface IEventListener

Overrides:

addEventListeners in class AbstractRestObject<Configuration,Configuration>

removeEventListeners

public void removeEventListeners()

Description copied from interface: IEventListener

Removes all event listeners of this class.

Specified by:

removeEventListeners in interface IEventListener

Overrides:

removeEventListeners in class AbstractRestObject<Configuration,Configuration>

setCacheFilePath

public void setCacheFilePath(String path)

Sets the file path to which the configuration can be saved.

Parameters:

path - a path to a file

saveToDisk

public void saveToDisk()

Saves the configuration as a Json file.

Specified by:

saveToDisk in interface ICachedObject

loadFromDisk

public void loadFromDisk()

Attempts to load a configuration file from disk, overwriting the values of existing parameters, but not adding them if they did not exist before. This is done in order to get rid of deprecated parameter keys.

Specified by:

loadFromDisk in interface ICachedObject

getParameterValue

public <T> T getParameterValue(String compositeKey)

Returns the value of the parameter with a specified key.

Type Parameters:

T - the value type of the parameter

Parameters:

compositeKey - the parameter category and name, separated by a dot

Returns:

the value of the parameter with the specified key

getParameterStringValue

public String getParameterStringValue(String compositeKey)

Returns the human readable value of the parameter with a specified key.

Parameters:

compositeKey - the parameter category and name, separated by a dot

Returns:

the human readable value of the parameter with a specified key

setParameter

public void setParameter(String compositeKey,
                         String value)
                  throws IllegalArgumentException

Changes a configuration parameter, returning a status message about the change.

Parameters:

compositeKey - the parameter category and name, separated by a dot

value - the new value of the parameter

Throws:

IllegalArgumentException - if the compositeKey is empty or does not exist

changeParameters

public String changeParameters(Map<String,String> values)
                        throws IllegalArgumentException

Changes multiple parameters, returning a status message about the change. Also saves the configuration afterwards.

Parameters:

values - a map of key-value parameter pairs

Returns:

a message describing if the operations were successful, or if not, why they failed

Throws:

IllegalArgumentException - if the values are empty or non of them are valid

getParameters

public Collection<AbstractParameter<?>> getParameters()

Retrieves a collection of all parameters.

Returns:

a collection of all parameters

getPrettyPlainText

protected String getPrettyPlainText()

Description copied from class: AbstractRestObject

Returns a pretty print representation of this object.

Specified by:

getPrettyPlainText in class AbstractRestObject<Configuration,Configuration>

Returns:

a pretty print representation of this object

getAsJson

public Configuration getAsJson(javax.ws.rs.core.MultivaluedMap<String,String> query)

Description copied from class: AbstractRestObject

Returns a JSON representation of this object.

Specified by:

getAsJson in class AbstractRestObject<Configuration,Configuration>

Parameters:

query - optional query parameters from the HTTP request

Returns:

a JSON representation of this object