org.lsst.ccs.config

Interface ConfigurationProxy

All Known Implementing Classes:

LocalConfigurationProxy

public interface ConfigurationProxy

Subsystem access to configuration information.

BEWARE: there are two potential sources for description and configuration (database or/and local file) and two potential sink when registering changes (database or/and local file). There may be potential concurrency issues (mostly when dealing with the remote database) and so commands that fire the modifications should be sure to get a proper lock from the lock manager.

Author:

bamade

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) To be invoked before startup.
Map<String,String>	getTaggedCategoriesForCats(Set<String> categories)
String	getTagName() the current tag name (can be null or empty)
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 stringValue) 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 in taggedCategories are saved under a new tag name.
void	saveModifications(Map<String,String> categoryProfile)

Method Detail

buildConfigurationInfo

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.

Parameters:

configState -

recentChangesNames -

Returns:

the ConfigurationInfo object

getCategorySet

Set<String> getCategorySet()

Returns:

the set of categories the subsystem has its parameters split into

getTagName

String getTagName()

the current tag name (can be null or empty)

Returns:

the tag of the subsystem this configuration proxy is running for

getInitialParameterConfigurations

Map.Entry<org.lsst.ccs.bus.states.ConfigurationState,Set<ParameterConfiguration>> getInitialParameterConfigurations(Map<String,String> taggedCategories)

To be invoked before startup. Returns the set of ParameterConfiguration to apply to the subsystem description before startup and the configuration state the associated ConfigurableSubsystem will start with. This state is CONFIGURED if access to the configuration service is successful, UNCONFIGURED if not. In that case, the subsystem is started with parameters set to the default value specified in the subsystem description.

Parameters:

taggedCategories - the name of the initial configuration.

Returns:

the initial configuration state and a set of ParameterConfiguration.

checkForParameterChange

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

first part of a two phase commit

Parameters:

componentName -

parameterName -

value -

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

Throws:

IllegalArgumentException - if component or parameter does not exist

IllegalStateException - if called in normal mode (but implementation can decide to fire engineering mode)

notifyParameterChange

void notifyParameterChange(String componentName,
                           String parameterName,
                           String stringValue)

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

Parameters:

componentName -

parameterName -

stringValue -

notifyUncheckedParameterChange

void notifyUncheckedParameterChange(String componentName,
                                    String parameterName,
                                    Object Value)

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

Parameters:

componentName -

parameterName -

Value -

saveChangesForCategoriesAs

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

Tagged categories in taggedCategories are saved under a new tag name. If saveOtherCategories is true, parameters belonging to other categories are saved in their current tagged configuration. If set to false, they are left unchanged

Parameters:

taggedCategories -

Throws:

ConfigurationServiceException

getCurrentValuesForComponent

Map<String,org.lsst.ccs.utilities.structs.ViewValue> getCurrentValuesForComponent(String componentName)

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

Parameters:

componentName - the name of the configurable component

Returns:

a map from parameter name to its current value.

loadCategories

Map<String,Properties> loadCategories(Map<String,String> taggedCategories)
                               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:

taggedCategories - a list of tagged categories

Returns:

a map of component name to properties

Throws:

ConfigurationServiceException

saveModifications

void saveModifications(Map<String,String> categoryProfile)

isDirty

boolean isDirty()

getTaggedCategoriesForCats

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