org.lsst.ccs.config

Interface ConfigurationDAO

All Known Implementing Classes:

CCSBusesConfigurationDAO, DualConfigurationDAO, LocalConfigurationDAO

public interface ConfigurationDAO

DAO interface to configuration information.

Author:

LSST CCS Team

Method Summary

Modifier and Type	Method and Description
Set<String>	findAvailableConfigurationsForCategory(String agentName, String category)
boolean	isAvailable() Checks whether the configuration service is unavailable or not.
ConfigurationView	loadConfiguration(String agentName, ConfigurationDescription configDescription) For each pair 'category:configuration' in taggedCategories, the category is loaded with its specified configuration, categories that are not mentioned are left untouched.
ConfigurationView	loadGlobalConfiguration(String agentName, String name, int version) Loads a pre-defined combination of category configurations.
ConfigurationDescription	registerConfiguration(String agentName, org.lsst.ccs.bus.data.ConfigurationInfo configInfo) Request for a registration to the remote configuration server
ConfigurationDescription	saveChangesForCategoriesAs(String agentName, 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(String agentName,
                                    ConfigurationDescription configDescription)
                             throws ConfigurationServiceException

For each pair 'category:configuration' in taggedCategories, the category is loaded with its specified configuration, categories that are not mentioned are left untouched. The configuration context remains active

Parameters:

agentName - the sender name

configDescription - the description of the configuration to load.

Returns:

a ConfigurationView representing the new values to apply to the parameters.

Throws:

ConfigurationServiceException

registerConfiguration

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

Request for a registration to the remote configuration server

Parameters:

agentName - the sender name

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(String agentName,
                                                    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:

agentName - the sender name

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 agentName,
                                          String name,
                                          int version)

Loads a pre-defined combination of category configurations.

Parameters:

agentName - the sender name

name -

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

Returns:

findAvailableConfigurationsForCategory

Set<String> findAvailableConfigurationsForCategory(String agentName,
                                                   String category)

isAvailable

boolean isAvailable()

Checks whether the configuration service is unavailable or not.

Returns:

true if the configuration service is available, false otherwise.