org.lsst.ccs.config

Class LocalConfigurationProxy

java.lang.Object

org.lsst.ccs.config.LocalConfigurationProxy

All Implemented Interfaces:

ConfigurationProxy

public class LocalConfigurationProxy
extends Object
implements ConfigurationProxy

Configuration proxy that registers configurations locally as properties files.

Author:

bamade

Constructor Summary

Constructors

Constructor and Description
LocalConfigurationProxy(SubsystemDescription subsystemDesc) Builds a configuration proxy for the subsystem described by subsystemDesc.

Method Summary

Modifier and Type	Method and Description
ConfigurationInfo	buildConfigurationInfo(ConfigurationState configState, Set<ParameterPath> recentChangesPaths) Builds a ConfigurationInfo object reflecting the configuration state and ready to be sent on the buses.
Set<String>	findAvailableConfigurationsForCategory(String category)
Set<String>	getCategorySet()
Map<String,String>	getCurrentValuesForComponent(String componentName, Set<String> categories) Returns the current value of all parameters of a given configurable component
Map.Entry<ConfigurationState,Set<ParameterConfiguration>>	getInitialParameterConfigurations(Map<String,String> taggedCategories) Loads the startup configuration represented by taggedCategories, initializes the config profiles and returns a set of values to assign to parameters before startup
ConfigProfile	getProfileForCat(String categoryName)
Map<String,String>	getTaggedCategoriesForCats(Set<String> categories)
String	getTagName() the current tag name (can be null or empty)
protected static WriterProvider	getWriterProvider()
boolean	isDirty()
Boolean	isParameterConfigurable(String componentName, String parameterName) Checks if a parameter named parameterName is part of the configuration data.
Map<String,Properties>	loadCategories(Map<String,String> taggedCategories) For each pair 'category:configuration' in taggedCategories, the category is loaded with its specified configuration, categories that are not mentioned are left untouched.
void	notifyParameterChange(String componentName, String parameterName, String value) second part of a two phase commit.
void	notifyUncheckedParameterChange(String componentName, String parameterName, Object value) notifies directly of a change without preliminary check to the configuration service.
void	saveChangesForCategoriesAs(Map<String,String> taggedCategories) Tagged categories are saved under a new tag name.
void	saveModifications(Map<String,String> taggedCategories) Modification occurring in one of the tagged categories are saved.
void	setDefaultValueForParameter(String componentName, String parameterName, Object val)
protected static void	setWriterProvider(WriterProvider wp)
void	writeMissingDefaultConfigs()

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalConfigurationProxy

public LocalConfigurationProxy(SubsystemDescription subsystemDesc)

Builds a configuration proxy for the subsystem described by subsystemDesc.

Parameters:

subsystemDesc -

Method Detail

getWriterProvider

protected static WriterProvider getWriterProvider()

getCategorySet

public Set<String> getCategorySet()

Specified by:

getCategorySet in interface ConfigurationProxy

Returns:

the set of categories the subsystem has its parameters split into

getInitialParameterConfigurations

public Map.Entry<ConfigurationState,Set<ParameterConfiguration>> getInitialParameterConfigurations(Map<String,String> taggedCategories)

Loads the startup configuration represented by taggedCategories, initializes the config profiles and returns a set of values to assign to parameters before startup

Specified by:

getInitialParameterConfigurations in interface ConfigurationProxy

Parameters:

taggedCategories -

Returns:

getTagName

public String getTagName()

Description copied from interface: ConfigurationProxy

the current tag name (can be null or empty)

Specified by:

getTagName in interface ConfigurationProxy

Returns:

the tag of the subsystem this configuration proxy is running for

buildConfigurationInfo

public ConfigurationInfo buildConfigurationInfo(ConfigurationState configState,
                                                Set<ParameterPath> recentChangesPaths)

Builds a ConfigurationInfo object reflecting the configuration state and ready to be sent on the buses.

Specified by:

buildConfigurationInfo in interface ConfigurationProxy

Parameters:

configState -

recentChangesPaths -

Returns:

the ConfigurationInfo object

isParameterConfigurable

public Boolean isParameterConfigurable(String componentName,
                                       String parameterName)

Description copied from interface: ConfigurationProxy

Checks if a parameter named parameterName is part of the configuration data.

Specified by:

isParameterConfigurable in interface ConfigurationProxy

Parameters:

componentName - the name of the component

parameterName - the name of the parameter

Returns:

true if the parameter is part of the configuration data, false otherwise.

notifyParameterChange

public void notifyParameterChange(String componentName,
                                  String parameterName,
                                  String value)

Description copied from interface: ConfigurationProxy

second part of a two phase commit. this new value is registered as a new version of configuration data.

Specified by:

notifyParameterChange in interface ConfigurationProxy

notifyUncheckedParameterChange

public void notifyUncheckedParameterChange(String componentName,
                                           String parameterName,
                                           Object value)

Description copied from interface: ConfigurationProxy

notifies directly of a change without preliminary check to the configuration service. Use at you own risk!

Specified by:

notifyUncheckedParameterChange in interface ConfigurationProxy

saveChangesForCategoriesAs

public void saveChangesForCategoriesAs(Map<String,String> taggedCategories)
                                throws ConfigurationServiceException

Tagged categories are saved under a new tag name. Other parameters are left unchanged, the configuration context remains active.

Specified by:

saveChangesForCategoriesAs in interface ConfigurationProxy

Parameters:

taggedCategories -

Throws:

ConfigurationServiceException - if the configuration service is not available.

getTaggedCategoriesForCats

public Map<String,String> getTaggedCategoriesForCats(Set<String> categories)

Specified by:

getTaggedCategoriesForCats in interface ConfigurationProxy

saveModifications

public void saveModifications(Map<String,String> taggedCategories)

Modification occurring in one of the tagged categories are saved. Other changes are left untouched.

Specified by:

saveModifications in interface ConfigurationProxy

Parameters:

taggedCategories -

getCurrentValuesForComponent

public Map<String,String> getCurrentValuesForComponent(String componentName,
                                                       Set<String> categories)

Returns the current value of all parameters of a given configurable component

Specified by:

getCurrentValuesForComponent in interface ConfigurationProxy

Parameters:

componentName - the name of the configurable component

categories -

Returns:

a map from parameter name to its current value.

setWriterProvider

protected static void setWriterProvider(WriterProvider wp)

isDirty

public boolean isDirty()

Specified by:

isDirty in interface ConfigurationProxy

loadCategories

public Map<String,Properties> loadCategories(Map<String,String> taggedCategories)
                                      throws ConfigurationServiceException

Description copied from interface: ConfigurationProxy

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:

loadCategories in interface ConfigurationProxy

Parameters:

taggedCategories - a list of tagged categories

Returns:

a map of component name to properties

Throws:

ConfigurationServiceException

getProfileForCat

public ConfigProfile getProfileForCat(String categoryName)

setDefaultValueForParameter

public void setDefaultValueForParameter(String componentName,
                                        String parameterName,
                                        Object val)

Specified by:

setDefaultValueForParameter in interface ConfigurationProxy

writeMissingDefaultConfigs

public void writeMissingDefaultConfigs()

Specified by:

writeMissingDefaultConfigs in interface ConfigurationProxy

findAvailableConfigurationsForCategory

public Set<String> findAvailableConfigurationsForCategory(String category)

Specified by:

findAvailableConfigurationsForCategory in interface ConfigurationProxy