com.eibus.management

Interface ISettingsPersistenceHandler

All Known Implementing Classes:

LDAPBusConfigSettingsPersistenceHandler

public interface ISettingsPersistenceHandler

Classes that handle the storage and retrieval of settings, should implement this interface.

Author:

Bert Roos

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	getSettingValue(ISettingDefinition<T> settingDefinition) Retrieves the value related to a given setting definition.
void	load() Load all settings that're managed by this persistence handler.
void	save(ISettingsCollection settingsCollection) Requests to save all settings defined in the given settings collection.
void	setManagedComponent(IManagedComponent managedComponent) Sets the managed component for which this settings persistence handler instance is providing persistency services.

Method Detail

setManagedComponent

void setManagedComponent(IManagedComponent managedComponent)

Sets the managed component for which this settings persistence handler instance is providing persistency services. This method is invoked as an initialization step when a new settings collection is created on a managed component, using this persistence handler. component.

Parameters:

managedComponent - The management component.

save

void save(ISettingsCollection settingsCollection)
          throws SettingsPersistenceException

Requests to save all settings defined in the given settings collection.

Parameters:

settingsCollection - the settings collection to be saved.

Throws:

SettingsPersistenceException - thrown when saving of this collection fails.

load

void load()
          throws SettingsPersistenceException

Load all settings that're managed by this persistence handler. This method can be used as an initialization step.

Throws:

SettingsPersistenceException - thrown when loading of this collection fails.

getSettingValue

<T> T getSettingValue(ISettingDefinition<T> settingDefinition)

Retrieves the value related to a given setting definition.

Parameters:

settingDefinition - the definition of the setting whose value is to be retrieved.

Returns:

the setting value