org.lsst.ccs.config

Class ConfigurableSubsystem

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.config.ConfigurableSubsystem

All Implemented Interfaces:

CommandExecutor

public abstract class ConfigurableSubsystem
extends Subsystem

Abstract subclass of subsystems which provides access to the configuration proxy.

Author:

The LSST CCS Team

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.Agent

Agent.RunningCommand

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationProxy	configurationProxy Provides access to the configuration service.
protected Map<String,ParameterSetter>	parameterSetterDictionary The dictionary of config changer methods for each component.

Fields inherited from class org.lsst.ccs.Agent

commandExecutorLock, currentAction, currentQueries, currentSignals, heartbeatPublisher, innerStateLock, logBusHandler, runtimeInfoPublisher

Constructor Summary

Constructors

Constructor and Description
ConfigurableSubsystem(String name, ConfigurationProxy configProxy, org.lsst.ccs.bus.states.ConfigurationState initialState, Map<String,ParameterSetter> parameterSetterDictionary)

Method Summary

Modifier and Type	Method and Description
protected abstract Set<ParameterPath>	bulkChange() Processes the set of submitted changes as a group.
void	change(String componentName, String parameterName, Object value) Single change of parameter.
void	commitBulkChange() Changes that have been submitted are processed as a group.
void	doStart()
void	dropAllChanges() All unsaved changes are dropped, each parameter goes back to the value specified by the current configuration for this category.
void	dropAllSubmittedChanges()
void	dropBulkChange() Deprecated. use dropSubmittedChanges instead
void	dropChangesForCategories(String... categories) Changes occurring for one of the mentioned categories in categories are dropped, other categories are left untouched.
void	dropSubmittedChangesForComponent(String name)
Set<String>	findAvailableConfigurationsForCategory(String category) Returns the available configuration names for the given category.
Map<String,Map<String,String>>	getAllSubmittedChanges() Returns the current submitted changes for each component.
Set<String>	getCategories() Returns the set of categories the subsystem's configurable parameters are split into.
org.lsst.ccs.bus.data.ConfigurationInfo	getConfigurationInfo()
ConfigurationProxy	getConfigurationProxy()
Map<String,String>	getSubmittedChangesForComponent(String name)
String	getTag()
void	loadCategories(String... taggedCategories) Loads the configuration specified for each category, parameters that belong to other categories are left unchanged.
void	loadConfiguration(String... taggedCategories) Loads the configuration specified for each category specified in configName and loads the default configuration for the other 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.
protected void	setConfigurationProxy(ConfigurationProxy configurationProxy) this method should not be used once the proxy is delegated to all components so it should not be public!
void	submitChange(String componentName, String parameterName, Object value) Stores a change parameter to be validated later.
protected void	updateStateAndSendStatusConfigurationInfo(String message, Set<ParameterPath> recentChanges) Updates the state of the subsystem and sends a StatusConfigurationInfo status message
protected abstract void	validateBulkChanges() Validates the set of submitted changes as a group.

Methods inherited from class org.lsst.ccs.Subsystem

abort, abort, addClearAlertHandler, checkAllHardwareStarted, checkAllHardwareStopped, checkHardware, clearAlerts, clearAllAlerts, completeInitialization, completeInitialization, doShutdown, forceShutdown, getLogger, getNumberCommandThreads, getRaisedAlertSummary, internalShutdown, internalStart, ping, postStart, printRunningCommands, raiseAlert, raiseAlert, removeLogPanicState, setBusLogHandlerLevel, setLogFormat, setLogHandlerLevel, setLogLevel, setStackTraceDepth, stop, switchToEngineeringMode, switchToNormalMode

Methods inherited from class org.lsst.ccs.Agent

addCommandSet, addCommandsFromObject, broadcastStatus, executeCommandRequest, getAgentInfo, getCCSVersions, getCommandCount, getCommandSet, getCommandTargets, getCurrentAction, getDictionaries, getDistributionInfo, getEnvironmentMessagingAccess, getMessagingAccess, getName, getScheduler, getState, getState, getStatusBroadcastPeriod, isInEngineeringMode, isInState, isInState, publishStateChange, publishSubsystemDataOnStatusBus, sendAck, sendNack, setAgentProperty, shutdown, start, updateAgentState, updateHeartBeat, updateInternalState, waitFor

Methods inherited from class java.lang.Object

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

Field Detail

configurationProxy

protected ConfigurationProxy configurationProxy

Provides access to the configuration service.

parameterSetterDictionary

protected final Map<String,ParameterSetter> parameterSetterDictionary

The dictionary of config changer methods for each component.

Constructor Detail

ConfigurableSubsystem

public ConfigurableSubsystem(String name,
                             ConfigurationProxy configProxy,
                             org.lsst.ccs.bus.states.ConfigurationState initialState,
                             Map<String,ParameterSetter> parameterSetterDictionary)

Method Detail

getTag

public String getTag()

Returns:

tag name

getConfigurationProxy

public ConfigurationProxy getConfigurationProxy()

Returns:

the configuration proxy

setConfigurationProxy

protected void setConfigurationProxy(ConfigurationProxy configurationProxy)

this method should not be used once the proxy is delegated to all components so it should not be public!

Parameters:

configurationProxy -

saveAllChanges

@Command(description="Saves all changes in the current configurations",
         type=CONFIGURATION)
public final void saveAllChanges()
                                                                                                                               throws ConfigurationServiceException

Saves all changes in their current configuration. State switches to Configured is no exception.

Throws:

ConfigurationServiceException - if configuration service unavailable

saveChangesForCategories

@Command(description="Saves the specified categories with a name",
         type=CONFIGURATION)
public final void saveChangesForCategories(@Argument(name="taggedCategories",description="A list of categories")
                                                                                                                                           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.

Parameters:

categories - a list of categories

Throws:

ConfigurationServiceException - if configuration service unavailable.

saveChangesForCategoriesAs

@Command(description="Saves the specified categories with a name",
         type=CONFIGURATION)
public final void saveChangesForCategoriesAs(@Argument(name="taggedCategories",description="A list of pairs categoryName:configurationName")
                                                                                                                                             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.

Parameters:

taggedCategories - a list of pairs categoryName:configurationName

Throws:

ConfigurationServiceException - if the configuration service is not available.

dropAllChanges

@Command(description="drop all unsaved changes",
         type=CONFIGURATION)
public void dropAllChanges()

All unsaved changes are dropped, each parameter goes back to the value specified by the current configuration for this category.

dropChangesForCategories

@Command(description="drop unsaved changes for the specified categories",
         type=CONFIGURATION)
public void dropChangesForCategories(@Argument(name="categories",description="A list of categories")
                                                                                                                                            String... categories)

Changes occurring for one of the mentioned categories in categories are dropped, other categories are left untouched.

Parameters:

categories - A list of categories

loadConfiguration

@Command(description="loads a new configuration",
         type=CONFIGURATION)
public void loadConfiguration(@Argument(name="taggedCategories",description="a list of pairs categoryName:configurationName")
                                                                                                             String... taggedCategories)

Loads the configuration specified for each category specified in configName and loads the default configuration for the other categories. Changes that are not saved yet are dropped.

Parameters:

taggedCategories - a list of pairs categoryName:configurationName

Throws:

ConfigurationServiceException

org.lsst.ccs.utilities.conv.TypeConversionException

loadCategories

@Command(description="loads the configuration for the specified categories",
         type=CONFIGURATION)
public void loadCategories(@Argument(name="taggedCategories",description="a list of pairs categoryName:configurationName")
                                                                                                                                     String... taggedCategories)

Loads the configuration specified for each category, parameters that belong to other categories are left unchanged.

Parameters:

taggedCategories - a list of pairs categoryName:configurationName

Throws:

ConfigurationServiceException

getConfigurationInfo

@Command(description="return a ConfigurationInfo object",
         type=CONFIGURATION)
public org.lsst.ccs.bus.data.ConfigurationInfo getConfigurationInfo()

Returns:

a ConfigurationInfo object depicting the current configuration state

change

@Command(description="Submits a single change to be processed immediately",
         type=CONFIGURATION)
public void change(String componentName,
                                                                                                                            String parameterName,
                                                                                                                            Object value)

Single change of parameter. The value is validated and the parameter is immediately set to this value, without interfering with the current set of submitted changes.

Parameters:

componentName - the name of the component the parameter belongs to.

parameterName - the name of the parameter.

value - the new value to affect to this parameter

submitChange

@Command(description="Submits a change of parameter to be validated later",
         type=CONFIGURATION)
public void submitChange(String componentName,
                                                                                                                                  String parameterName,
                                                                                                                                  Object value)

Stores a change parameter to be validated later.

Parameters:

componentName -

parameterName -

value -

Throws:

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

commitBulkChange

@Command(description="processes the bulk change",
         type=CONFIGURATION)
public void commitBulkChange()

Changes that have been submitted are processed as a group.

validateBulkChanges

protected abstract void validateBulkChanges()

Validates the set of submitted changes as a group.

bulkChange

protected abstract Set<ParameterPath> bulkChange()

Processes the set of submitted changes as a group. changes.

Returns:

a map of processed parameters ordered by the component they belong to.

dropBulkChange

@Deprecated
 @Command(description="Drops the submitted changes",
         type=CONFIGURATION)
public void dropBulkChange()

Deprecated. use dropSubmittedChanges instead

Drops the submitted changes.

dropAllSubmittedChanges

@Command(description="Drops the submitted changes for all components",
         type=CONFIGURATION)
public void dropAllSubmittedChanges()

dropSubmittedChangesForComponent

@Command(description="Drops the submitted changes for the given component",
         type=CONFIGURATION)
public void dropSubmittedChangesForComponent(@Argument(description="the component name")
                                                                                                                                                      String name)

doStart

public void doStart()

Overrides:

doStart in class Subsystem

updateStateAndSendStatusConfigurationInfo

protected void updateStateAndSendStatusConfigurationInfo(String message,
                                                         Set<ParameterPath> recentChanges)

Updates the state of the subsystem and sends a StatusConfigurationInfo status message

Parameters:

message -

recentChanges -

getSubmittedChangesForComponent

@Command(description="Returns the current submitted changes for the given component",
         type=CONFIGURATION)
public Map<String,String> getSubmittedChangesForComponent(@Argument(description="the component name")
                                                                                                                                                                             String name)

getAllSubmittedChanges

@Command(description="Returns the current submitted changes for each component",
         type=CONFIGURATION)
public Map<String,Map<String,String>> getAllSubmittedChanges()

Returns the current submitted changes for each component.

Returns:

a map ordered by component name.

getCategories

@Command(description="returns the categories of this subsystem")
public Set<String> getCategories()

Returns the set of categories the subsystem's configurable parameters are split into.

Returns:

a set of category names.

findAvailableConfigurationsForCategory

@Command(description="returns the available configurations for the given category")
public Set<String> findAvailableConfigurationsForCategory(String category)

Returns the available configuration names for the given category.

Parameters:

category -

Returns:

a set of configuration names.