org.lsst.ccs

Class ComponentConfigurationEnvironment

java.lang.Object

org.lsst.ccs.ComponentConfigurationEnvironment

public class ComponentConfigurationEnvironment
extends Object

Utility class to provide access to the Configuration API for a given component. It provides the same configuration API as ConfigurationService but dedicated to the component it extends.

Method Summary

Modifier and Type	Method and Description
void	change(String parameterName, Object value) Single change of parameter that belongs to this component.
void	dropAllChanges() All parameters are set back to the value defined by the current configuration they are running.
void	dropChangesForCategories(String... categories) All parameters that belong to one of the specified categories are set back to the value defined by the current running configuration for this category.
void	dropSubmittedChanges()
String	getConfigurationParameterValue(String parameterName) Get the value of a parameter
Map<String,String>	getSubmittedChanges() Gets the submitted changes for the specified component
Boolean	isParameterConfigurable(String parameterName) Indicates whether their is a configuration parameter named parameterName that belong to this component.
Map<String,String>	printConfigurableParameters(String[] categories) Returns the current values of the configuration parameters that belong to this component and to the specified categories.
void	saveAllChanges() Saves the current value of each parameter in the current running configuration.
void	saveChangesForCategories(String... categories) Saves the current value of each parameter that belongs to one of the specified categories in the current running configuration for this category.
void	saveChangesForCategoriesAs(String... taggedCategories) Saves the current value of each parameter that belongs to one of the specified categories in a new configuration for this category.
void	submitChange(String parameterName, Object value) Submits a change.
void	submitChanges(Map<String,Object> values) Submit a collection of changes.

Methods inherited from class java.lang.Object

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

Method Detail

change

@Command(description="engineering mode change of parameter value",
         type=CONFIGURATION)
public void change(@Argument(name="parameterName",description="Configuration parameter name")
                                                                                                                   String parameterName,
                                                                                                                   @Argument(name="value",description="Configuration parameter value")
                                                                                                                   Object value)

Single change of parameter that belongs to this component.
The value is validated and the parameter is immediately set to this value, without interfering with the current set of submitted changes. If the change is effective, the configuration state goes to DIRTY.

Parameters:

parameterName - the name of the parameter.

value - the new value to affect to this parameter

Throws:

ConfigurationServiceException - if the change has not been registered to the configuration service.

BulkValidationException - if setting the parameters fails at the validation step. The configuration state remains unchanged.

BulkSettingException - if setting the parameter fails at the setting step, or if a suspicious change is detected at the validation step, or if the final values of the parameters is not consistent with the performed change. Existing submitted changes are dropped and an alert is raised.

IllegalStateException - if the subsystem is not in engineering mode or if the subsystem is is INITIAL_SAFE configuration state.

submitChange

@Command(description="submit a potential change for a parameter",
         type=CONFIGURATION)
public void submitChange(@Argument(name="parameterName",description="Configuration parameter name")
                                                                                                                        String parameterName,
                                                                                                                        @Argument(name="value",description="Configuration parameter value")
                                                                                                                        Object value)

Submits a change.
The change will be effective once commitBulkChange is invoked and successful. This does not affect the subsystem configuration state.

Parameters:

parameterName - a parameter that belongs to this component

value - the new value to submit for this component.

Throws:

IllegalArgumentException - if componentName does not have a configurable parameter named parameterName

IllegalStateException - if the subsystem is not in engineering mode or if the subsystem is is INITIAL_SAFE configuration state.

submitChanges

@Command(description="submit potential changes for parameters",
         type=CONFIGURATION)
public void submitChanges(Map<String,Object> values)

Submit a collection of changes. If one submission fails all preceding submissions are dropped. The changes will be validated and set when issuing ConfigurableSubsystem#commitBulkChange()

Parameters:

values - a map of parameter name and the new value to submit for this parameter

getConfigurationParameterValue

public String getConfigurationParameterValue(String parameterName)

Get the value of a parameter

saveAllChanges

public void saveAllChanges()

Saves the current value of each parameter in the current running configuration. If it succeeds, the state will be CONFIGURED.

Throws:

ConfigurationServiceException - if the configuration service is unavailable. The configuration state does not change and the run-time changes are still considered unsaved. In addition, an alert is raised to indicate the configuration service unavailability.

saveChangesForCategories

public void saveChangesForCategories(String... categories)

Saves the current value of each parameter that belongs to one of the specified categories in the current running configuration for this category. If there were run-time changes in other categories, the state is DIRTY, otherwise CONFIGURED.

Parameters:

categories - a list of categories to save

Throws:

ConfigurationServiceException - if the configuration service is unavailable. The configuration state does not change and existing run-time changes are still considered unsaved. In addition, an alert is raised to indicate the configuration service unavailability.

saveChangesForCategoriesAs

public void saveChangesForCategoriesAs(String... taggedCategories)

Saves the current value of each parameter that belongs to one of the specified categories in a new configuration for this category. If there were run-time changes in other categories, the state is DIRTY, otherwise CONFIGURED.

Parameters:

taggedCategories - a list of pairs categoryName:configurationName. {

Throws:

ConfigurationServiceException - if the configuration service is not available.

dropAllChanges

public void dropAllChanges()

All parameters are set back to the value defined by the current configuration they are running. Existing submitted changes are dropped before dropAllChanges operates.

Throws:

ConfigurationServiceException - if the configuration service is unavailable.

BulkValidationException - if setting the parameters back to their configured value fails at the validation step.

BulkSettingException - if setting the parameters back to their configured value fails at the setting step. An alert is raised.

dropChangesForCategories

public void dropChangesForCategories(String... categories)

All parameters that belong to one of the specified categories are set back to the value defined by the current running configuration for this category. Other categories are left untouched. Existing submitted changes are dropped before dropChangesForCategories operates.

Parameters:

categories - A list of categories

Throws:

ConfigurationServiceException - if the configuration service is unavailable.

BulkValidationException - if setting the parameters back to their configured value fails at the validation step.

BulkSettingException - if setting the parameters back to their configured value fails at the setting step. An alert is raised.

isParameterConfigurable

@Command
public Boolean isParameterConfigurable(String parameterName)

Indicates whether their is a configuration parameter named parameterName that belong to this component.

Parameters:

parameterName - the parameter name

Returns:

true if there is a configuration parameter name name which belong to the component {

printConfigurableParameters

@Command(description="displays the current values of the parameters that belong to the given categories",
         type=CONFIGURATION)
public Map<String,String> printConfigurableParameters(@Argument(defaultValue="[]")
                                                                                                                                                                                             String[] categories)

Returns the current values of the configuration parameters that belong to this component and to the specified categories.

Parameters:

categories - regardless of the category if null.

Returns:

a map of parameter names to their current value

Throws:

IllegalArgumentException - if there is no component named name

getSubmittedChanges

@Command(description="prints the current state of the submitted changes",
         type=CONFIGURATION)
public Map<String,String> getSubmittedChanges()

Gets the submitted changes for the specified component

Returns:

a map of parameter names to their submitted value

Throws:

IllegalArgumentException - if there is no component named name

dropSubmittedChanges

@Command(description="drops the submitted changes for this component",
         type=CONFIGURATION)
public void dropSubmittedChanges()