org.lsst.ccs.framework

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

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigurationProxy	NONE

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
String	getConfigurationName() the current running Configuration name
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)
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	registerConfiguration(String configurationName)
void	registerConfiguration(String configurationName, String tagName) Deprecated.
void	saveModifications(String configurationName) Saves the current changes (delta)
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	startNewConfigurationContext() engineering mode start notification.

Field Detail

NONE

static final ConfigurationProxy NONE

Method Detail

getConfigurationName

String getConfigurationName()

the current running Configuration name

Returns:

getTagName

String getTagName()

the current tag name (can be null or empty)

Returns:

startNewConfigurationContext

void startNewConfigurationContext()

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

Throws:

IllegalStateException - if not called in normal mode

checkForParameterChange

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 -

registerConfiguration

@Deprecated
void registerConfiguration(String configurationName,
                                       String tagName)
                                throws IOException

Deprecated.

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

Parameters:

configurationName -

tagName -

Throws:

IOException

registerConfiguration

void registerConfiguration(String configurationName)
                    throws IOException

Throws:

IOException

dropModifications

void dropModifications()

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

saveModifications

void saveModifications(String configurationName)

Saves the current changes (delta)

Parameters:

configurationName -

getDefaultParameterValue

Object getDefaultParameterValue(String componentName,
                                String parameterName)

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

Parameters:

componentName -

parameterName -

Returns:

the resuested Object

Throws:

IllegalArgumentException - if no such parameter or component

setSubsystem

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)

Parameters:

subsystem -

getSubsystem

Optional<Subsystem> getSubsystem()

returns the subsystem for which it operates

Returns: