org.lsst.ccs

Class ComponentConfigurationEnvironment

java.lang.Object

org.lsst.ccs.ComponentConfigurationEnvironment

All Implemented Interfaces:

Configurable.Environment

public class ComponentConfigurationEnvironment
extends Object
implements Configurable.Environment

Utility class to provide access to the Configuration API for a given component. It provides the same configuration API as SubsystemConfigurationEnvironment but dedicated to the component it extends. It can be accessed in the following ways:

• Subsystem.getSubsystemForObject(this).getConfigurationEnvironmentForComponent(Object obj)
• Subsystem.getSubsystemForObject(this).getConfigurationEnvironmentByName(String name)
• By extending UsesSubsystem and using method getComponentConfigurationEnvironment()

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	dropBulkChange() Drops the submitted changes for this component.
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.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.framework.Configurable.Environment

getChildren, getComponentByName, getNameOfComponent, getParent, getSubsystem

Method Detail

change

public void change(String parameterName,
                   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.

Specified by:

change in interface Configurable.Environment

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

public void submitChange(String parameterName,
                         Object value)

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

Specified by:

submitChange in interface Configurable.Environment

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.

saveAllChanges

public void saveAllChanges()

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

Specified by:

saveAllChanges in interface Configurable.Environment

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.

Specified by:

saveChangesForCategories in interface Configurable.Environment

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.

Specified by:

saveChangesForCategoriesAs in interface Configurable.Environment

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.

Specified by:

dropAllChanges in interface Configurable.Environment

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.

Specified by:

dropChangesForCategories in interface Configurable.Environment

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

public Boolean isParameterConfigurable(String parameterName)

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

Specified by:

isParameterConfigurable in interface Configurable.Environment

Parameters:

parameterName - the parameter name

Returns:

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

dropBulkChange

public void dropBulkChange()

Drops the submitted changes for this component.

Specified by:

dropBulkChange in interface Configurable.Environment

Throws:

IllegalArgumentException - if there is no component named name

printConfigurableParameters

public Map<String,String> printConfigurableParameters(String[] categories)

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

Specified by:

printConfigurableParameters in interface Configurable.Environment

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

public Map<String,String> getSubmittedChanges()

Gets the submitted changes for the specified component

Specified by:

getSubmittedChanges in interface Configurable.Environment

Returns:

a map of parameter names to their submitted value

Throws:

IllegalArgumentException - if there is no component named name