Package org.n52.faroe

Class SettingsServiceImpl

java.lang.Object

org.n52.faroe.SettingsServiceImpl

All Implemented Interfaces:

SettingsService

public class SettingsServiceImpl
extends Object
implements SettingsService

Class to handle the settings and configuration of the service. Allows other classes to change, delete, and declare settings and to create, modify and delete administrator users. Classes can subscribe to specific settings using the Configurable and Setting annotations. To be recognized by the SettingsManager configure(java.lang.Object) has to be called for every object that wants to receive settings. All other classes have to call configure(java.lang.Object) manually.

Since:

1.0.0

See Also:

SettingDefinition, SettingValue, Configurable

Constructor Summary

Constructors

Constructor	Description
SettingsServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	addSetting(SettingDefinition<?> definition)
void	addSettings(Collection<SettingDefinition<?>> definitions)
void	changeSetting(SettingValue<?> newValue)	Changes a setting.
void	configure(Object object)	Configure o with the required settings.
void	configureOnce(Object object)	Configure o with the required settings.
void	deleteAll()	Deletes all settings and users.
void	deleteSetting(SettingDefinition<?> setting)	Deletes the setting defined by setting.
SettingDefinition<?>	getDefinitionByKey(String key)	Get the definition that is defined with the specified key.
Set<String>	getKeys()
<T> SettingValue<T>	getSetting(String key)	Gets the value of the setting defined by key.
<T> SettingValue<T>	getSetting(SettingDefinition<T> key)	Gets the value of the setting defined by key.
Set<SettingDefinition<?>>	getSettingDefinitions()	Gets all SettingDefinitions known by this class.
SettingValueFactory	getSettingFactory()
Map<SettingDefinition<?>,SettingValue<?>>	getSettings()	Gets all values for all definitions.
void	reconfigure()	Gets all values for all definitions and udpates (changes or configures) all configured objets.
void	setServiceEventBus(EventBus serviceEventBus)
void	setSettingDefinitions(Optional<Collection<SettingDefinition<?>>> def)
void	setSettingsManagerDao(SettingsDao settingsManagerDao)
void	setSettingValueFactory(SettingValueFactory settingValueFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingsServiceImpl

public SettingsServiceImpl()

Method Detail

setServiceEventBus

@Inject
public void setServiceEventBus(EventBus serviceEventBus)

setSettingValueFactory

@Inject
public void setSettingValueFactory(SettingValueFactory settingValueFactory)

setSettingsManagerDao

@Inject
public void setSettingsManagerDao(SettingsDao settingsManagerDao)

setSettingDefinitions

@Inject
public void setSettingDefinitions(Optional<Collection<SettingDefinition<?>>> def)

addSetting

public void addSetting(SettingDefinition<?> definition)

Specified by:

addSetting in interface SettingsService

addSettings

public void addSettings(Collection<SettingDefinition<?>> definitions)

Specified by:

addSettings in interface SettingsService

getSettingDefinitions

public Set<SettingDefinition<?>> getSettingDefinitions()

Gets all SettingDefinitions known by this class.

Specified by:

getSettingDefinitions in interface SettingsService

Returns:

the definitions

configureOnce

public void configureOnce(Object object)
                   throws ConfigurationError

Description copied from interface: SettingsService

Configure o with the required settings. Future changes to settings will not be propagated to the object.

Specified by:

configureOnce in interface SettingsService

Parameters:

object - the object to configure

Throws:

ConfigurationError - if there is a problem configuring the object

See Also:

SettingsService.configure(java.lang.Object)

configure

public void configure(Object object)
               throws ConfigurationError

Configure o with the required settings. All changes to a setting required by the object will be applied.

Specified by:

configure in interface SettingsService

Parameters:

object - the object to configure

Throws:

ConfigurationError - if there is a problem configuring the object

See Also:

Configurable, Setting

getDefinitionByKey

public SettingDefinition<?> getDefinitionByKey(String key)

Get the definition that is defined with the specified key.

Specified by:

getDefinitionByKey in interface SettingsService

Parameters:

key - the key

Returns:

the definition or null if there is no definition for the key

getSetting

public <T> SettingValue<T> getSetting(SettingDefinition<T> key)

Gets the value of the setting defined by key.

Specified by:

getSetting in interface SettingsService

Type Parameters:

T - the type of the setting and value

Parameters:

key - the definition of the setting

Returns:

the value of the setting

getSetting

public <T> SettingValue<T> getSetting(String key)

Gets the value of the setting defined by key.

Specified by:

getSetting in interface SettingsService

Type Parameters:

T - the type of the setting and value

Parameters:

key - the id of the setting

Returns:

the value of the setting

getSettings

public Map<SettingDefinition<?>,SettingValue<?>> getSettings()

Gets all values for all definitions. If there is no value for a definition null is added to the map.

Specified by:

getSettings in interface SettingsService

Returns:

all values by definition

deleteSetting

public void deleteSetting(SettingDefinition<?> setting)
                   throws ConfigurationError

Deletes the setting defined by setting.

Specified by:

deleteSetting in interface SettingsService

Parameters:

setting - the definition

Throws:

ConfigurationError - if there is a problem deleting the setting

getKeys

public Set<String> getKeys()

Specified by:

getKeys in interface SettingsService

Returns:

the keys for all definitions

changeSetting

public void changeSetting(SettingValue<?> newValue)
                   throws ConfigurationError

Changes a setting. The change is propagated to all Objects that are configured. If the change fails for one of these objects, the setting is reverted to the old value of the setting for all objects.

Specified by:

changeSetting in interface SettingsService

Parameters:

newValue - the new value of the setting

Throws:

ConfigurationError - if there is a problem changing the setting.

getSettingFactory

public SettingValueFactory getSettingFactory()

Specified by:

getSettingFactory in interface SettingsService

Returns:

the SettingValueFactory to produce values

deleteAll

public void deleteAll()

Deletes all settings and users.

Specified by:

deleteAll in interface SettingsService

reconfigure

public void reconfigure()

Description copied from interface: SettingsService

Gets all values for all definitions and udpates (changes or configures) all configured objets.

Specified by:

reconfigure in interface SettingsService