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

register locally changes in parameters (that is creates a new Properties "resource" for the configuration)

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CAT
static String	DEFAULT_CONFIG_NAME

Constructor Summary

Constructors

Constructor and Description
LocalConfigurationProxy(ConfigProfile configProfile)
LocalConfigurationProxy(SubsystemDescription subsystemDesc) Builds a configuration proxy out of a subsystem description.

Method Summary

Modifier and Type	Method and Description
org.lsst.ccs.bus.data.ConfigurationInfo	buildConfigurationInfo() Builds a ConfigurationInfo object reflecting the configuration state and ready to be sent on the buses.
void	change(Configurable configurable, String parameterName, Object value)
org.lsst.ccs.utilities.structs.ViewValue	checkForParameterChange(String componentName, String parameterName, Object value)
void	dropUnsavedChangesForCategories(Collection<String> categories)
Set<String>	getCategorySet()
Object	getDefaultParameterValue(String componentName, String parameterName)
TreeNode	getInitialDescriptiveNode(Map<String,String> taggedCategories) Builds a TreeNode representing the hierarchical structure of the worker subsystem.
DescriptiveNode	getModifiedConfigurationData() prepares a new executable configuration data with these modified parameters.
ConfigProfile	getProfileForCat(String categoryName)
String	getTagName()
LocalConfigurationProxy.WriterProvider	getWriterProvider()
void	loadCategories(Map<String,String> taggedCategories)
void	notifyParameterChange(String componentName, String parameterName, String value)
void	notifyUncheckedParameterChange(String componentName, String parameterName, Object value)
void	saveChangesForCategories(Set<String> categories)
void	saveChangesForCategoriesAs(Map<String,String> taggedCategories) Tagged categories are saved under a new tag name.
void	setLookup(ComponentLookupService lookup)
void	setWriterProvider(LocalConfigurationProxy.WriterProvider writerProvider)
void	switchConfiguration(ConfigProfile oldProfile, ConfigProfile newProfile) Configuration switch from one profile to another.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIG_NAME

public static final String DEFAULT_CONFIG_NAME

See Also:

Constant Field Values

DEFAULT_CAT

public static final String DEFAULT_CAT

See Also:

Constant Field Values

Constructor Detail

LocalConfigurationProxy

public LocalConfigurationProxy(SubsystemDescription subsystemDesc)

Builds a configuration proxy out of a subsystem description.

Parameters:

subsystemDesc -

LocalConfigurationProxy

public LocalConfigurationProxy(ConfigProfile configProfile)

Method Detail

getCategorySet

public Set<String> getCategorySet()

Specified by:

getCategorySet in interface ConfigurationProxy

getInitialDescriptiveNode

public TreeNode getInitialDescriptiveNode(Map<String,String> taggedCategories)

Builds a TreeNode representing the hierarchical structure of the worker subsystem. This method is used to build a TreeNode modified with a configuration we want a subsystem to be started with.

Specified by:

getInitialDescriptiveNode in interface ConfigurationProxy

Parameters:

taggedCategories -

Returns:

setLookup

public void setLookup(ComponentLookupService lookup)

Specified by:

setLookup in interface ConfigurationProxy

getTagName

public String getTagName()

Specified by:

getTagName in interface ConfigurationProxy

buildConfigurationInfo

public org.lsst.ccs.bus.data.ConfigurationInfo buildConfigurationInfo()

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

Specified by:

buildConfigurationInfo in interface ConfigurationProxy

Returns:

checkForParameterChange

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

Specified by:

checkForParameterChange in interface ConfigurationProxy

notifyParameterChange

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

Specified by:

notifyParameterChange in interface ConfigurationProxy

notifyUncheckedParameterChange

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

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:

IOException

ConfigurationServiceException

saveChangesForCategories

public void saveChangesForCategories(Set<String> categories)
                              throws ConfigurationServiceException

Specified by:

saveChangesForCategories in interface ConfigurationProxy

Throws:

ConfigurationServiceException

getDefaultParameterValue

public Object getDefaultParameterValue(String componentName,
                                       String parameterName)

Specified by:

getDefaultParameterValue in interface ConfigurationProxy

setWriterProvider

public void setWriterProvider(LocalConfigurationProxy.WriterProvider writerProvider)

getWriterProvider

public LocalConfigurationProxy.WriterProvider getWriterProvider()

loadCategories

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

Specified by:

loadCategories in interface ConfigurationProxy

Throws:

ConfigurationServiceException

Exception

dropUnsavedChangesForCategories

public void dropUnsavedChangesForCategories(Collection<String> categories)
                                     throws Exception

Specified by:

dropUnsavedChangesForCategories in interface ConfigurationProxy

Throws:

Exception

switchConfiguration

public void switchConfiguration(ConfigProfile oldProfile,
                                ConfigProfile newProfile)
                         throws Exception

Configuration switch from one profile to another. The tree of modules is traveled : - a parameter that is assigned a new value in newProfile is changed to this value. - a parameter that is not assigned a new value in newProfile is changed to its default value if it was modified in oldProfile. TODO : does not make sense if the profiles refer to different subsystemDescriptions or categories

Parameters:

oldProfile - profile still active in database

newProfile - profile to be registered afterwards

Throws:

Exception - could be that a parameter change is refused by code or that rollback failed afterwards

getProfileForCat

public ConfigProfile getProfileForCat(String categoryName)

getModifiedConfigurationData

public DescriptiveNode getModifiedConfigurationData()

prepares a new executable configuration data with these modified parameters. used by PreparedConfiguration objects.

Returns:

change

public void change(Configurable configurable,
                   String parameterName,
                   Object value)
            throws Exception

Specified by:

change in interface ConfigurationProxy

Parameters:

configurable -

parameterName -

value -

Throws:

Exception