org.lsst.ccs.config

Interface ConfigurationDAO

All Known Implementing Classes:

CCSBusesConfigurationDAO

public interface ConfigurationDAO

DAO interface to configuration information.

Author:

LSST CCS Team

Method Summary

Modifier and Type	Method and Description
Set<String>	findAvailableConfigurationsForCategory(String category)
boolean	isAvailable() Checks whether the configuration service is unavailable or not.
ConfigurationView	loadConfiguration(ConfigurationDescription configDescription) Load the provided ConfigurationDescription.
ConfigurationView	loadGlobalConfiguration(String name, int version) Loads a pre-defined combination of category configurations.
default String	locateConfigurations(org.lsst.ccs.bus.data.ConfigurationInfo configInfo)
ConfigurationDescription	registerConfiguration(org.lsst.ccs.bus.data.ConfigurationInfo configInfo) Request for a registration to the remote configuration server
ConfigurationDescription	saveChangesForCategoriesAs(ConfigurationDescription configDesc, org.lsst.ccs.bus.data.ConfigurationInfo configInfo) Changes made in the specified categories are saved under the newly specified name for this category, changes on parameters that belong to other categories are left unchanged.

Method Detail

loadConfiguration

ConfigurationView loadConfiguration(ConfigurationDescription configDescription)
                             throws ConfigurationServiceException

Load the provided ConfigurationDescription. The configuration context remains active

Parameters:

configDescription - the description of the configuration to load.

Returns:

a ConfigurationView representing the new values to apply to the parameters. Return null if there is no configuration for the provided description.

Throws:

ConfigurationServiceException - TO-DO: with the current implementation the method signature could be changed to: loadConfiguration(String category, String tag, int version);

registerConfiguration

ConfigurationDescription registerConfiguration(org.lsst.ccs.bus.data.ConfigurationInfo configInfo)
                                        throws ConfigurationServiceException

Request for a registration to the remote configuration server

Parameters:

configInfo - a ConfigurationInfo object that describes the current subsystem's configuration state

Returns:

for each category, the name and version of the resulted configuration

Throws:

ConfigurationServiceException

saveChangesForCategoriesAs

ConfigurationDescription saveChangesForCategoriesAs(ConfigurationDescription configDesc,
                                                    org.lsst.ccs.bus.data.ConfigurationInfo configInfo)
                                             throws ConfigurationServiceException

Changes made in the specified categories are saved under the newly specified name for this category, changes on parameters that belong to other categories are left unchanged.

Parameters:

configDesc - the categories to save and their new tag

configInfo - the current configuration info

Returns:

for each category, the name and version of the resulted configuration

Throws:

ConfigurationServiceException - if the configuration service is not available.

loadGlobalConfiguration

ConfigurationView loadGlobalConfiguration(String name,
                                          int version)

Loads a pre-defined combination of category configurations.

Parameters:

name -

version - the version of the global configuration tag. If negative, returns the latest version

Returns:

findAvailableConfigurationsForCategory

Set<String> findAvailableConfigurationsForCategory(String category)

isAvailable

boolean isAvailable()

Checks whether the configuration service is unavailable or not.

Returns:

true if the configuration service is available, false otherwise.

locateConfigurations

default String locateConfigurations(org.lsst.ccs.bus.data.ConfigurationInfo configInfo)