org.lsst.ccs.config

Class LocalConfigurationDAO

java.lang.Object

org.lsst.ccs.config.LocalConfigurationDAO

All Implemented Interfaces:

ConfigurationDAO

public class LocalConfigurationDAO
extends Object
implements ConfigurationDAO

Configuration proxy that registers configurations locally as properties files.

Author:

bamade

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<ConfigurationParameterInfo>	configurationParameterComparator

Constructor Summary

Constructors

Constructor and Description
LocalConfigurationDAO(String agentName, String descriptionName) Builds a configuration proxy for the subsystem described by subsystemDesc.

Method Summary

Modifier and Type	Method and Description
Set<String>	findAvailableConfigurationsForCategory(String agentName, String category)
Properties	getConfigurationProperties(String tag, String category) Get configuration properties from the file system for a given tag and category.
boolean	isAvailable() Checks whether the configuration service is unavailable or not.
ConfigurationView	loadConfiguration(String agentName, ConfigurationDescription configDesc) 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 globalName, int version) Loads a pre-defined combination of category configurations.
String	locateConfigurations(ConfigurationInfo configInfo)
ConfigurationDescription	registerConfiguration(String agentName, ConfigurationInfo configInfo) Request for a registration to the remote configuration server
ConfigurationDescription	saveChangesForCategoriesAs(String agentName, ConfigurationDescription configDesc, 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.
static String	toPropertyString(ConfigurationParameterInfo parmInfo, boolean commentOutValue) creates a String to be included in a .properties file

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configurationParameterComparator

public static final Comparator<ConfigurationParameterInfo> configurationParameterComparator

Constructor Detail

LocalConfigurationDAO

public LocalConfigurationDAO(String agentName,
                             String descriptionName)

Builds a configuration proxy for the subsystem described by subsystemDesc.

Parameters:

agentName - the agent name on the buses.

descriptionName - the name of the description the agent was built with.

Method Detail

toPropertyString

public static String toPropertyString(ConfigurationParameterInfo parmInfo,
                                      boolean commentOutValue)

creates a String to be included in a .properties file

Parameters:

parmInfo -

commentOutValue - if true the description is commented out

Returns:

a String representation of the parameter description with the given value

loadConfiguration

public ConfigurationView loadConfiguration(String agentName,
                                           ConfigurationDescription configDesc)
                                    throws ConfigurationServiceException

Description copied from interface: ConfigurationDAO

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

Specified by:

loadConfiguration in interface ConfigurationDAO

Parameters:

agentName - the sender name

configDesc - the description of the configuration to load.

Returns:

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

Throws:

ConfigurationServiceException

getConfigurationProperties

public Properties getConfigurationProperties(String tag,
                                             String category)
                                      throws ConfigurationServiceException

Get configuration properties from the file system for a given tag and category. Properties will be loaded for both the agentName and the description name (groovy file name). The resulting properties will be merged with the agent name one above the ones for the description name.

Parameters:

tag -

category -

Returns:

Throws:

ConfigurationServiceException

loadGlobalConfiguration

public ConfigurationView loadGlobalConfiguration(String agentName,
                                                 String globalName,
                                                 int version)

Description copied from interface: ConfigurationDAO

Loads a pre-defined combination of category configurations.

Specified by:

loadGlobalConfiguration in interface ConfigurationDAO

Parameters:

agentName - the sender name

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

Returns:

findAvailableConfigurationsForCategory

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

Specified by:

findAvailableConfigurationsForCategory in interface ConfigurationDAO

isAvailable

public boolean isAvailable()

Description copied from interface: ConfigurationDAO

Checks whether the configuration service is unavailable or not.

Specified by:

isAvailable in interface ConfigurationDAO

Returns:

true if the configuration service is available, false otherwise.

registerConfiguration

public ConfigurationDescription registerConfiguration(String agentName,
                                                      ConfigurationInfo configInfo)
                                               throws ConfigurationServiceException

Description copied from interface: ConfigurationDAO

Request for a registration to the remote configuration server

Specified by:

registerConfiguration in interface ConfigurationDAO

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

public ConfigurationDescription saveChangesForCategoriesAs(String agentName,
                                                           ConfigurationDescription configDesc,
                                                           ConfigurationInfo configInfo)
                                                    throws ConfigurationServiceException

Description copied from interface: ConfigurationDAO

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.

Specified by:

saveChangesForCategoriesAs in interface ConfigurationDAO

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.

locateConfigurations

public String locateConfigurations(ConfigurationInfo configInfo)