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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LocalConfigurationProxy.WriterProvider When locally registering properties the LocalConfigurationProxy may need to write properties in a File or in memory for tests purposes.

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
org.lsst.ccs.bus.data.ConfigurationInfo	buildConfigurationInfo(org.lsst.ccs.bus.states.ConfigurationState configState, Set<Map.Entry<String,String>> recentChangesNames) Builds a ConfigurationInfo object reflecting the configuration state and ready to be sent on the buses.
org.lsst.ccs.utilities.structs.ViewValue	checkForParameterChange(String componentName, String parameterName, Object value) first part of a two phase commit
Set<String>	getCategorySet()
Map<String,org.lsst.ccs.utilities.structs.ViewValue>	getCurrentValuesForComponent(String componentName) Returns the current value of all parameters of a given configurable component
Map.Entry<org.lsst.ccs.bus.states.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)
LocalConfigurationProxy.WriterProvider	getWriterProvider()
boolean	isDirty()
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	setWriterProvider(LocalConfigurationProxy.WriterProvider writerProvider)

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

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<org.lsst.ccs.bus.states.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 org.lsst.ccs.bus.data.ConfigurationInfo buildConfigurationInfo(org.lsst.ccs.bus.states.ConfigurationState configState,
                                                                      Set<Map.Entry<String,String>> recentChangesNames)

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

Specified by:

buildConfigurationInfo in interface ConfigurationProxy

Parameters:

configState -

Returns:

the ConfigurationInfo object

checkForParameterChange

public org.lsst.ccs.utilities.structs.ViewValue checkForParameterChange(String componentName,
                                                                        String parameterName,
                                                                        Object value)

Description copied from interface: ConfigurationProxy

first part of a two phase commit

Specified by:

checkForParameterChange in interface ConfigurationProxy

Returns:

pair with value an object created after correct checking of the value (to be used to set local values) and the first field (view) a String representation of the object

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

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,org.lsst.ccs.utilities.structs.ViewValue> getCurrentValuesForComponent(String componentName)

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

Returns:

a map from parameter name to its current value.

setWriterProvider

public void setWriterProvider(LocalConfigurationProxy.WriterProvider writerProvider)

getWriterProvider

public LocalConfigurationProxy.WriterProvider getWriterProvider()

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)