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 inherited from class org.lsst.ccs.Agent

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

Constructor Summary

Constructors

Constructor and Description
ConfigurableSubsystem(String name, ConfigurationProxy configProxy, org.lsst.ccs.bus.states.ConfigurationState initialState)

Method Summary

Modifier and Type	Method and Description
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	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.bus.data.ConfigurationInfo	getConfigurationInfo()
ConfigurationProxy	getConfigurationProxy()
abstract ComponentLookupService	getLookup() The structure of a Configurable Subsystem may be modular (eg {@link NodeModularSubsystem), in that case changing a parameter requires knowledge of this modular structure.
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.

Methods inherited from class org.lsst.ccs.Subsystem

abort, abort, addClearAlertHandler, checkAllHardwareStarted, checkAllHardwareStopped, checkHardware, clearAlarms, clearAlerts, clearAllAlerts, completeInitialization, completeInitialization, doShutdown, forceShutdown, getLogger, getNumberCommandThreads, getRaisedAlertSummary, initialisationEndPhase, internalShutdown, internalStart, interruptActionThread, ping, postStart, printRunningCommands, publishMetaData, publishStatus, publishStatus, publishStatus, publishStatus, publishStatus, publishStatusData, raiseAlarm, raiseAlert, removeLogPanicState, sendRawStatus, setBusLogHandlerLevel, setLogFormat, setLogHandlerLevel, setLogLevel, setStackTraceDepth, stop, switchToEngineeringMode, switchToNormalMode, warning

Methods inherited from class org.lsst.ccs.Agent

addCommandSet, broadcastStatus, executeCommandRequest, fillStatus, getAgentInfo, getAgentState, getAgentState, getCCSVersions, getCommandCount, getCommandSet, getCurrentAction, getDictionaries, getDistributionInfo, getEnvironmentMessagingAccess, getMessagingAccess, getName, getScheduler, getState, getState, getStatusBroadcastPeriod, getSystemDictionary, isAgentInState, isAgentInState, isInEngineeringMode, isInState, isInState, publishStateChange, publishSubsystemDataOnStatusBus, setStatusBroadcastPeriod, shutdown, shutdownAgent, start, startAgent, startStatusBroadcasting, stopStatusBroadcasting, updateAgentState, updateHeartBeat, updateInternalState, waitFor

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurableSubsystem

public ConfigurableSubsystem(String name,
                             ConfigurationProxy configProxy,
                             org.lsst.ccs.bus.states.ConfigurationState initialState)

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)
                                                                                                                                    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.

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)
                                                                                                                                      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.

Parameters:

taggedCategories - a list of pairs categoryName:configurationName

Throws:

ConfigurationServiceException

dropAllChanges

@Command(description="drop all unsaved changes",
         type=CONFIGURATION)
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.

Throws:

Exception

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)
                                                                                                                                     throws Exception

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

Parameters:

categories - A list of categories

Throws:

Exception

loadConfiguration

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

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

Exception

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)
                                                                                                                              throws ConfigurationServiceException,
                                                                                                                                     Exception

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

Exception

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

getLookup

public abstract ComponentLookupService getLookup()

The structure of a Configurable Subsystem may be modular (eg {@link NodeModularSubsystem), in that case changing a parameter requires knowledge of this modular structure.

Returns:

a ComponentLookupService which holds the internal structure of the ConfigurableSubsystem it stands for.

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 -

commitBulkChange

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

Changes that have been submitted are processed as a group.

dropBulkChange

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

doStart

public void doStart()

Overrides:

doStart in class Subsystem