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 "somewher" (be it a File or in memory for tests purposes) classes that support this interface are able to create the corresponding resource.

Field Summary

Fields inherited from interface org.lsst.ccs.framework.ConfigurationProxy

NONE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ViewValue	checkForParameterChange(String componentName, String parameterName, Object value) first part of a two phase commit
void	dropModifications() Drops the current changes (delta) and gets back to the previous configuration state; TODO exception if configuration service unavailable
org.lsst.ccs.config.AConfigProfile	getBaseProfile()
String	getConfigurationName() the current running Configuration name
ConfigProfile	getCurrentProfile()
Object	getDefaultParameterValue(String componentName, String parameterName) gets the default value for the given parameter in the current configuration
Optional<Subsystem>	getSubsystem() returns the subsystem for which it operates
String	getTagName() the current tag name (can be null or empty)
LocalConfigurationProxy.WriterProvider	getWriterProvider()
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	registerConfiguration(String configurationName)
void	registerConfiguration(String configurationName, String tagName) creates a new configuration out of the previous configuration + changes.
void	saveModifications(String configurationName) Saves the current changes (delta)
void	setBaseProfile(ConfigProfile profile)
void	setSubsystem(Subsystem subsystem) tells the proxy which is the subsystem it is working for (then will know about the messaging system and the state of the subystem)
void	setWriterProvider(LocalConfigurationProxy.WriterProvider writerProvider)
void	startNewConfigurationContext() engineering mode start notification.

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

getConfigurationName

public String getConfigurationName()

Description copied from interface: ConfigurationProxy

the current running Configuration name

Specified by:

getConfigurationName in interface ConfigurationProxy

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:

startNewConfigurationContext

public void startNewConfigurationContext()

Description copied from interface: ConfigurationProxy

engineering mode start notification. cannot be called if still in engineering mode.

Specified by:

startNewConfigurationContext in interface ConfigurationProxy

checkForParameterChange

public 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

registerConfiguration

public void registerConfiguration(String configurationName)
                           throws IOException

Specified by:

registerConfiguration in interface ConfigurationProxy

Throws:

IOException

registerConfiguration

public void registerConfiguration(String configurationName,
                                  String tagName)
                           throws IOException

Description copied from interface: ConfigurationProxy

creates a new configuration out of the previous configuration + changes. The configuration of the subsystem changes to this one.

Specified by:

registerConfiguration in interface ConfigurationProxy

Throws:

IOException

saveModifications

public void saveModifications(String configurationName)

Description copied from interface: ConfigurationProxy

Saves the current changes (delta)

Specified by:

saveModifications in interface ConfigurationProxy

dropModifications

public void dropModifications()

Description copied from interface: ConfigurationProxy

Drops the current changes (delta) and gets back to the previous configuration state; TODO exception if configuration service unavailable

Specified by:

dropModifications in interface ConfigurationProxy

getDefaultParameterValue

public Object getDefaultParameterValue(String componentName,
                                       String parameterName)

Description copied from interface: ConfigurationProxy

gets the default value for the given parameter in the current configuration

Specified by:

getDefaultParameterValue in interface ConfigurationProxy

Returns:

the resuested Object

setSubsystem

public void setSubsystem(Subsystem subsystem)

Description copied from interface: ConfigurationProxy

tells the proxy which is the subsystem it is working for (then will know about the messaging system and the state of the subystem)

Specified by:

setSubsystem in interface ConfigurationProxy

getSubsystem

public Optional<Subsystem> getSubsystem()

Description copied from interface: ConfigurationProxy

returns the subsystem for which it operates

Specified by:

getSubsystem in interface ConfigurationProxy

Returns:

getBaseProfile

public org.lsst.ccs.config.AConfigProfile getBaseProfile()

getCurrentProfile

public ConfigProfile getCurrentProfile()

setBaseProfile

public void setBaseProfile(ConfigProfile profile)

setWriterProvider

public void setWriterProvider(LocalConfigurationProxy.WriterProvider writerProvider)

getWriterProvider

public LocalConfigurationProxy.WriterProvider getWriterProvider()