jadex.bridge.service.types.settings

Interface ISettingsService

public interface ISettingsService

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

Method Summary

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

Method Detail

registerPropertiesProvider

jadex.commons.future.IFuture<java.lang.Void> registerPropertiesProvider(java.lang.String id,
                                                                        jadex.commons.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

jadex.commons.future.IFuture<java.lang.Void> deregisterPropertiesProvider(java.lang.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

jadex.commons.future.IFuture<java.lang.Void> setProperties(java.lang.String id,
                                                           jadex.commons.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

jadex.commons.future.IFuture<jadex.commons.Properties> getProperties(java.lang.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

jadex.commons.future.IFuture<java.lang.Void> loadProperties()

Load the default platform properties.

Returns:

A future indicating when properties have been loaded.

saveProperties

jadex.commons.future.IFuture<java.lang.Void> saveProperties()

Save the platform properties to the default location.

Returns:

A future indicating when properties have been saved.

setSaveOnExit

jadex.commons.future.IFuture<java.lang.Void> setSaveOnExit(boolean saveonexit)

Set the save on exit policy.

Parameters:

saveonexit - The saveonexit flag.