Package jadex.bridge.service.types.settings

Interface ISettingsService

  • public interface ISettingsService
    This service allows storing and retrieving settings for specific components or services.

    • Method Detail

      • registerPropertiesProvider

        @Deprecated
IFuture<java.lang.Void> registerPropertiesProvider​(java.lang.String id,
                                                   IPropertiesProvider provider)
        Deprecated.
        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

        @Deprecated
IFuture<java.lang.Void> deregisterPropertiesProvider​(java.lang.String id)
        Deprecated.
        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

        @Deprecated
IFuture<java.lang.Void> setProperties​(java.lang.String id,
                                      Properties props)
        Deprecated.
        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

        @Deprecated
IFuture<Properties> getProperties​(java.lang.String id)
        Deprecated.
        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

        @Deprecated
IFuture<java.lang.Void> loadProperties()
        Deprecated.
        Load the default platform properties.
        Returns:
        A future indicating when properties have been loaded.

      • saveProperties

        @Deprecated
IFuture<java.lang.Void> saveProperties()
        Deprecated.
        Save the platform properties to the default location.
        Returns:
        A future indicating when properties have been saved.

      • setSaveOnExit

        @Deprecated
IFuture<java.lang.Void> setSaveOnExit​(boolean saveonexit)
        Deprecated.
        Set the save on exit policy.
        Parameters:
        saveonexit - The saveonexit flag.