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.

Constructor Summary

Constructors

Constructor and Description
LocalConfigurationProxy(ConfigProfile configProfile)
LocalConfigurationProxy(SubsystemDescription subsystemDesc)

Method Summary

Modifier and Type	Method and Description
void	applyConfiguration(String... taggedCategories)
org.lsst.ccs.utilities.structs.ViewValue	checkForParameterChange(String componentName, String parameterName, Object value)
void	dropUnsavedChanges()
void	dropUnsavedChangesForCategories(Collection<String> categories)
String	getConfigurationName()
Object	getDefaultParameterValue(String componentName, String parameterName)
org.lsst.gruth.jutils.DescriptiveNode	getModifiedConfigurationData() prepares a new executable configuration data with these modified parameters.
ConfigProfile	getProfileForCat(String categoryName)
String	getTagName()
LocalConfigurationProxy.WriterProvider	getWriterProvider()
org.lsst.gruth.jutils.DescriptiveNode	initializeConfigProfile(String... taggedCategories)
void	loadConfiguration(String... taggedCategories)
void	notifyParameterChange(String componentName, String parameterName, String value)
void	notifyUncheckedParameterChange(String componentName, String parameterName, Object value)
void	registerCategories(String... taggedCategories) Tagged categories are saved under a new tag name.
void	registerConfiguration(String... taggedCategories) Tagged categories in taggedCategories are saved under their tagged name, other categories are saved in their current tagged configuration.
void	setLookup(ComponentLookupService lookup)
void	setWriterProvider(LocalConfigurationProxy.WriterProvider writerProvider)
void	startNewConfigurationContext() Deprecated.
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

Constructor Detail

LocalConfigurationProxy

public LocalConfigurationProxy(SubsystemDescription subsystemDesc)

LocalConfigurationProxy

public LocalConfigurationProxy(ConfigProfile configProfile)

Method Detail

initializeConfigProfile

public org.lsst.gruth.jutils.DescriptiveNode initializeConfigProfile(String... taggedCategories)

setLookup

public void setLookup(ComponentLookupService lookup)

Specified by:

setLookup in interface ConfigurationProxy

getConfigurationName

public String getConfigurationName()

Specified by:

getConfigurationName in interface ConfigurationProxy

getTagName

public String getTagName()

Specified by:

getTagName in interface ConfigurationProxy

startNewConfigurationContext

@Deprecated
public void startNewConfigurationContext()

Deprecated.

Specified by:

startNewConfigurationContext in interface ConfigurationProxy

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

registerConfiguration

public void registerConfiguration(String... taggedCategories)
                           throws IOException

Tagged categories in taggedCategories are saved under their tagged name, other categories are saved in their current tagged configuration.

Specified by:

registerConfiguration in interface ConfigurationProxy

Parameters:

taggedCategories -

Throws:

IOException

registerCategories

public void registerCategories(String... taggedCategories)
                        throws IOException

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

Specified by:

registerCategories in interface ConfigurationProxy

Parameters:

taggedCategories -

Throws:

IOException

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()

loadConfiguration

public void loadConfiguration(String... taggedCategories)
                       throws Exception

Specified by:

loadConfiguration in interface ConfigurationProxy

Throws:

Exception

applyConfiguration

public void applyConfiguration(String... taggedCategories)
                        throws Exception

Specified by:

applyConfiguration in interface ConfigurationProxy

Throws:

Exception

dropUnsavedChanges

public void dropUnsavedChanges()
                        throws Exception

Specified by:

dropUnsavedChanges in interface ConfigurationProxy

Throws:

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 org.lsst.gruth.jutils.DescriptiveNode getModifiedConfigurationData()

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

Returns: