jadex.bridge.service.types.settings

Interface ISettingsService

public interface ISettingsService

This service allows storing and retrieving settings for specific components or services.

Method Summary

Methods

Modifier and Type	Method and Description
IFuture<Void>	deregisterPropertiesProvider(String id) Deregister a property provider.
IFuture<Properties>	getProperties(String id) Get the properties for a given id.
IFuture<Properties>	loadProperties() Load the default platform properties.
IFuture<Void>	registerPropertiesProvider(String id, IPropertiesProvider provider) Register a property provider.
IFuture<Void>	saveProperties() Save the platform properties to the default location.
IFuture<Void>	setProperties(String id, Properties props) Set the properties for a given id.
IFuture<Void>	setSaveOnExit(boolean saveonexit) Set the save on exit policy.

Method Detail

registerPropertiesProvider

IFuture<Void> registerPropertiesProvider(String id,
                                       IPropertiesProvider provider)

Register a property provider. Settings of registered property providers will be automatically saved and restored, when properties are loaded.

Parameters:

id - A unique id to identify the properties (e.g. component or service name).

provider - The properties provider.

Returns:

A future indicating when registration is finished.

deregisterPropertiesProvider

IFuture<Void> deregisterPropertiesProvider(String id)

Deregister a property provider. Settings of a deregistered property provider will be saved before the property provider is removed.

Parameters:

id - A unique id to identify the properties (e.g. component or service name).

Returns:

A future indicating when registration is finished.

setProperties

IFuture<Void> setProperties(String id,
                          Properties props)

Set the properties for a given id. Overwrites existing settings (if any).

Parameters:

id - A unique id to identify the properties (e.g. component or service name).

properties - The properties to set.

Returns:

A future indicating when properties have been set.

getProperties

IFuture<Properties> getProperties(String id)

Get the properties for a given id.

Parameters:

id - A unique id to identify the properties (e.g. component or service name).

Returns:

A future containing the properties (if any).

loadProperties

IFuture<Properties> loadProperties()

Load the default platform properties.

Returns:

A future indicating when properties have been loaded.

saveProperties

IFuture<Void> saveProperties()

Save the platform properties to the default location.

Returns:

A future indicating when properties have been saved.

setSaveOnExit

IFuture<Void> setSaveOnExit(boolean saveonexit)

Set the save on exit policy.

Parameters:

saveonexit - The saveonexit flag.