org.lsst.ccs.startup

Class ConfigurationEnvironment

java.lang.Object

org.lsst.ccs.startup.ConfigurationEnvironment

All Implemented Interfaces:

Configurable.Environment

public class ConfigurationEnvironment
extends Object
implements Configurable.Environment

instances of this class are created by the subsystem startup. They operate delegations on behalf of the Configurable Object. The Configurable Object can thus access its ConfigurationProxy and its ComponentLookupService

Constructor Summary

Constructors

Constructor and Description
ConfigurationEnvironment(String name, org.lsst.ccs.config.ConfigurationProxy configurationProxy, ComponentLookupService lookupService, org.lsst.ccs.config.ConfigurableSubsystem s) Creates an Environment for a Configurable object.

Method Summary

Modifier and Type	Method and Description
void	change(String parameterName, Object value) performs a parameter change during an engineering session
void	dropAllChanges() All unsaved changes are dropped, each parameter goes back to the value specified by the current configuration for this category.
void	dropBulkChange()
void	dropChangesForCategories(String... categories) Changes occurring for one of the mentioned categories in categories are dropped, other categories are left untouched.
org.lsst.ccs.utilities.structs.ViewValue	getCheckedValueFromConfiguration(String parameterName, Object value) Deprecated. use isParameterConfigurable(String parameterName) instead, the return value is irrelevant.
<T> LinkedHashMap<String,T>	getChildren(Class<T> classFilter) get the children of the Configurable object that are assignable to an instance of the class argument.
Object	getComponentByName(String name) request a Component from a Description by its name.
org.lsst.ccs.utilities.structs.TreeBranch<String>	getComponentTree()
String	getNameOfComponent()
Map.Entry<String,Object>	getParent() returns the parent of the current component
Map<String,String>	getSubmittedChanges()
Optional<Subsystem>	getSubsystem()
Boolean	isParameterConfigurable(String parameterName)
void	notifyChange(String parameterName, String value) to be used by "facade" commands that may set a value the calling must have made a preliminary check with the configuration service.
void	notifyChangeWithoutPreliminaryChecks(String parameterName, Object value) to be used by "facade" commands that may set a value then notify the configuration without going through the preliminary check of the configuration service.
Map	printConfigurableParameters(String[] categories)
void	saveAllChanges() Saves all changes in their current configuration.
void	saveChangesForCategories(String... categories) Changes made in the specified categories are saved under the current configuration for this category, changes on parameters that belong to other categories are left unchanged.
void	saveChangesForCategoriesAs(String... taggedCategories) Changes made in the specified categories are saved under the newly specified name for this category, changes on parameters that belong to other categories are left unchanged.
void	sendSignal(Signal signal)
void	submitChange(String parameterName, Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationEnvironment

public ConfigurationEnvironment(String name,
                                org.lsst.ccs.config.ConfigurationProxy configurationProxy,
                                ComponentLookupService lookupService,
                                org.lsst.ccs.config.ConfigurableSubsystem s)

Creates an Environment for a Configurable object. It builds a CommandDictionary for the object and populates a map of ConfigChanger methods.

The configuration proxy provides an access to the configuration database but interactions are of delicate nature :

• the base is checked as wether the new parameter value is considered possible
• then the parameter is changed locally
• the base is notified about the change

Parameters:

name -

configurationProxy -

lookupService -

s -

Method Detail

change

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

performs a parameter change during an engineering session

Specified by:

change in interface Configurable.Environment

Parameters:

parameterName - name of parameter for the current object.

value - any object that is fit for the configuration system (see documentation)

Throws:

IllegalArgumentException - if parameter has a name unknown to the configuration

Exception - that can be thrown by the ConfigurationProxy (no connection, illegal format, constraints failure) or by the user's code (preconditions)

submitChange

public void submitChange(String parameterName,
                         Object value)

Specified by:

submitChange in interface Configurable.Environment

saveAllChanges

public void saveAllChanges()
                    throws ConfigurationServiceException

Saves all changes in their current configuration.

Specified by:

saveAllChanges in interface Configurable.Environment

Throws:

ConfigurationServiceException

saveChangesForCategories

public void saveChangesForCategories(String... categories)
                              throws ConfigurationServiceException

Changes made in the specified categories are saved under the current configuration for this category, changes on parameters that belong to other categories are left unchanged.

Specified by:

saveChangesForCategories in interface Configurable.Environment

Parameters:

categories - a list of categories

Throws:

ConfigurationServiceException

saveChangesForCategoriesAs

public void saveChangesForCategoriesAs(String... taggedCategories)
                                throws ConfigurationServiceException

Changes made in the specified categories are saved under the newly specified name for this category, changes on parameters that belong to other categories are left unchanged.

Specified by:

saveChangesForCategoriesAs in interface Configurable.Environment

Parameters:

taggedCategories - a list of pairs categoryName:configurationName

Throws:

ConfigurationServiceException

dropAllChanges

public void dropAllChanges()
                    throws Exception

All unsaved changes are dropped, each parameter goes back to the value specified by the current configuration for this category. The configuration context is no longer active.

Specified by:

dropAllChanges in interface Configurable.Environment

Throws:

Exception

dropChangesForCategories

public void dropChangesForCategories(String... categories)
                              throws Exception

Changes occurring for one of the mentioned categories in categories are dropped, other categories are left untouched. The configuration context remains active.

Specified by:

dropChangesForCategories in interface Configurable.Environment

Parameters:

categories - A list of categories

Throws:

Exception

getCheckedValueFromConfiguration

@Deprecated
public org.lsst.ccs.utilities.structs.ViewValue getCheckedValueFromConfiguration(String parameterName,
                                                                                             Object value)
                                                                                      throws Exception

Deprecated. use isParameterConfigurable(String parameterName) instead, the return value is irrelevant.

Checks if a value can be accepted by the Configuration system. to be used by "facade" commands that may set a value.

The returned value is an Object that represent the real value as generated by the Configuration: it is not necessarily the value passed as argument because the argument can both be a real object or its String representation (as extracted from a properties file or from a GUI interaction). This returned object contains both this real value AND its String representation.

Specified by:

getCheckedValueFromConfiguration in interface Configurable.Environment

Parameters:

parameterName -

value - can be a real Object or its String representation

Returns:

An object ViewValue that returns both an Object value and its String representation as used by the Configuration.

Throws:

Exception

isParameterConfigurable

public Boolean isParameterConfigurable(String parameterName)

Specified by:

isParameterConfigurable in interface Configurable.Environment

notifyChangeWithoutPreliminaryChecks

public void notifyChangeWithoutPreliminaryChecks(String parameterName,
                                                 Object value)
                                          throws Exception

to be used by "facade" commands that may set a value then notify the configuration without going through the preliminary check of the configuration service.
use at your own risk!

Specified by:

notifyChangeWithoutPreliminaryChecks in interface Configurable.Environment

Parameters:

parameterName -

value -

Throws:

Exception

notifyChange

public void notifyChange(String parameterName,
                         String value)
                  throws Exception

to be used by "facade" commands that may set a value
the calling must have made a preliminary check with the configuration service.
indiscriminate use should be discouraged

Specified by:

notifyChange in interface Configurable.Environment

Parameters:

parameterName -

value -

Throws:

Exception

getComponentByName

public Object getComponentByName(String name)

request a Component from a Description by its name.

Specified by:

getComponentByName in interface Configurable.Environment

Parameters:

name -

Returns:

A Component. beware unless you are dead sure do not assume this component is a Configurable object (any object can be aliased and so put in the dictionary)

getChildren

public <T> LinkedHashMap<String,T> getChildren(Class<T> classFilter)

get the children of the Configurable object that are assignable to an instance of the class argument.

Specified by:

getChildren in interface Configurable.Environment

Type Parameters:

T -

Parameters:

classFilter -

Returns:

a map with name of the component as key and its class as value.

getParent

public Map.Entry<String,Object> getParent()

returns the parent of the current component

Specified by:

getParent in interface Configurable.Environment

Returns:

the Component (value) and its name (key) null if there is no parent.

getNameOfComponent

public String getNameOfComponent()

Specified by:

getNameOfComponent in interface Configurable.Environment

Returns:

the name associated with this component

getSubsystem

public Optional<Subsystem> getSubsystem()

Specified by:

getSubsystem in interface Configurable.Environment

dropBulkChange

public void dropBulkChange()

Specified by:

dropBulkChange in interface Configurable.Environment

getComponentTree

public org.lsst.ccs.utilities.structs.TreeBranch<String> getComponentTree()

Specified by:

getComponentTree in interface Configurable.Environment

sendSignal

public void sendSignal(Signal signal)

Specified by:

sendSignal in interface Configurable.Environment

printConfigurableParameters

public Map printConfigurableParameters(String[] categories)

Specified by:

printConfigurableParameters in interface Configurable.Environment

getSubmittedChanges

public Map<String,String> getSubmittedChanges()

Specified by:

getSubmittedChanges in interface Configurable.Environment