org.lsst.ccs

Class Subsystem

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

All Implemented Interfaces:

CommandExecutor

Direct Known Subclasses:

BusMaster, ConfigurableSubsystem

public class Subsystem
extends Agent

The base class for a CCS subsystem.

This object will register itself on the three buses (control, status, log). It broadcasts its status, and can receive Commands.

Author:

Eric Aubourg, Bernard AMADE

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, logBusHandler, runtimeInfoPublisher

Constructor Summary

Constructors

Constructor and Description
Subsystem(String name, AgentInfo.AgentType type) Constructs Subsystem instance.
Subsystem(String name, AgentInfo.AgentType type, ComponentLookup componentLookupService) Constructs Subsystem instance.
Subsystem(String name, AgentInfo.AgentType type, ComponentLookup componentLookupService, String tagName, String[] startupConfig)

Method Summary

Modifier and Type	Method and Description
void	abort() Command to abort operation.
void	addClearAlertHandler(ClearAlertHandler handler) Add a ClearAlertHandler to this Subsystem.
void	change(String componentName, String parameterName, Object value) Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
void	checkAllHardwareStarted() Called to check if all hardware has been correctly started.
void	checkAllHardwareStopped() Called to check if all hardware has been correctly started.
void	checkHardware() Called before activating anything and again once problems are supposed to have been addressed.
String[]	clearAlerts(String... alertId) Clear one or more Alerts by providing the alert id.
String[]	clearAllAlerts() Attempt to clear all the outstanding alerts.
void	commitBulkChange() Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
void	completeInitialization() Command to complete initialization (if commands were issued to heal hardware problems).
void	completeInitialization(boolean checkHardwareOK) Runs the last phase of the initialization, and transitions to OPERATIONAL state.
void	doShutdown() Called upon subsystem shutdown.
void	doStart() Called upon subsystem start.
void	dropAllChanges() Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
void	dropAllSubmittedChanges() Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
void	dropChangesForCategories(String... categories) Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
void	dropSubmittedChangesForComponent(String name) Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
Set<String>	findAvailableConfigurationsForCategory(String category) Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
void	forceShutdown() Command to force subsystem shutdown.
Map<String,Map<String,String>>	getAllSubmittedChanges() Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
Set<String>	getCategories() Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
ComponentConfigurationEnvironment	getComponentConfigurationEnvironment(Object obj) Get the ComponentConfigurationEnvironment object for a given Object.
ComponentConfigurationEnvironment	getComponentConfigurationEnvironmentByName(String name) Get the ComponentConfigurationEnvironment object for a given node name.
ComponentLookup	getComponentLookup() Get the ComponentLookup for this Subsystem.
ConfigurationInfo	getConfigurationInfo() Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
Map<String,String>	getCurrentValuesForComponent(String componentName, Set<String> categorySet) Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
Logger	getLogger() Returns the current logger (use sparingly and prefer your own logger).
ComponentLookup	getLookup() Deprecated. Use getComponentLookup instead
int	getNumberCommandThreads() Command that returns the number of currently running commands.
RaisedAlertSummary	getRaisedAlertSummary() Get the Subsystem's RaisedAlertSummary.
Map<String,String>	getSubmittedChangesForComponent(String name) Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
SubsystemConfigurationEnvironment	getSubsystemConfigurationEnvironment() Provides programmatic access to the configuration API.
static Subsystem	getSubsystemForObject(Object obj) Get the Subsystem for a given object belonging to a ComponentLookup.
String	getTag() Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
protected void	internalShutdown() Called by the framework on subsystem shutdown, before the Agent shutdown sequence is executed.
protected boolean	internalStart() Called by the framework once the underlying Agent functionality is initialized.
boolean	isParameterConfigurable(String componentName, String parameterName) Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
void	loadCategories(String... taggedCategories) Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
void	loadConfiguration(String... taggedCategories) Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
void	ping() Command to broadcast a message of presence on the status bus.
void	postStart() Called by the framework after subsystem has been started.
String	printRunningCommands() Command returning a String describing which commands are running.
void	raiseAlert(Alert alert, AlertState severity, String cause) Raise an Alert with a given AlertState.
void	removeLogPanicState() Command to try and reset the panic state of a the Log Bus Handler (logging failed before).
void	saveAllChanges() Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
void	saveChangesForCategories(String... categories) Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
void	saveChangesForCategoriesAs(String... taggedCategories) Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
void	setBusLogHandlerLevel(String levelName) Command to set the level at which the Log Bus Hander will start logging.
void	setLogFormat(String format) Command to set a format for the TextFormatter of LogBusHandler (see logging.properties doc).
void	setLogHandlerLevel(String handler, String level) Command to set a level for a given handler
void	setLogLevel(String keyLogger, String levelName) Command to set the Level of a named Logger.
void	setStackTraceDepth(int depth) Will modify the depth of stackTrace printing for ALL handlers (including the LogBusHandler)
void	stop(long timeHint) Command to stop operation.
void	stopAndWait(long timeHint) forwards a STOP signal to all components and then checks if all hardwares have been stopped within timeHint
void	submitChange(String componentName, String parameterName, Object value) Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()
boolean	switchToEngineeringMode() Command to switch to ENGINEERING mode.
void	switchToNormalMode() Command to switch to NORMAL mode.

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, updateAgentState, updateHeartBeat, updateInternalState, waitFor

Methods inherited from class java.lang.Object

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

Constructor Detail

Subsystem

public Subsystem(String name,
                 AgentInfo.AgentType type)

Constructs Subsystem instance.

Parameters:

name - name of the subsystem : cannot be null

type - Agent type

Subsystem

public Subsystem(String name,
                 AgentInfo.AgentType type,
                 ComponentLookup componentLookupService)

Constructs Subsystem instance.

Parameters:

name - name of the subsystem : cannot be null

type - Agent type

Subsystem

public Subsystem(String name,
                 AgentInfo.AgentType type,
                 ComponentLookup componentLookupService,
                 String tagName,
                 String[] startupConfig)

Method Detail

internalStart

protected final boolean internalStart()

Called by the framework once the underlying Agent functionality is initialized.

Overrides:

internalStart in class Agent

Returns:

true if subsystem initialization was successful.

internalShutdown

protected final void internalShutdown()
                               throws Exception

Called by the framework on subsystem shutdown, before the Agent shutdown sequence is executed.

Overrides:

internalShutdown in class Agent

Throws:

Exception - if shutdown fails

completeInitialization

public void completeInitialization(boolean checkHardwareOK)
                            throws HardwareException

Runs the last phase of the initialization, and transitions to OPERATIONAL state.

Parameters:

checkHardwareOK - false if engineering fault was entered due to checkHardware errors

Throws:

HardwareException - if some hardware is still not started

postStart

public void postStart()
               throws HardwareException

Called by the framework after subsystem has been started. Can be overridden by subclasses to provide subsystem-specific post-initialization actions.

Throws:

HardwareException - because some "homing" operations may be tried by the hardware

getLogger

public Logger getLogger()

Returns the current logger (use sparingly and prefer your own logger).

Returns:

logger associated with this subsystem

getComponentLookup

public final ComponentLookup getComponentLookup()

Get the ComponentLookup for this Subsystem.

Returns:

The Subsystem's ComponentLookup.

getLookup

@Deprecated
public final ComponentLookup getLookup()

Deprecated. Use getComponentLookup instead

Returns:

checkHardware

public void checkHardware()
                   throws HardwareException

Called before activating anything and again once problems are supposed to have been addressed. It invokes a checkHardware on all HardwareController (except when return diag modifies the path of invocation)

Throws:

HardwareException - "compound" exception

checkAllHardwareStarted

public void checkAllHardwareStarted()
                             throws HardwareException

Called to check if all hardware has been correctly started. checks if all HardwareControllers have been started

Throws:

HardwareException - a compound exception that list the exceptions fired by hardwares that are not started.

checkAllHardwareStopped

public void checkAllHardwareStopped()
                             throws HardwareException

Called to check if all hardware has been correctly started. It checks if all HardwareControllers have been stopped

Throws:

HardwareException - a compound exception that list the exceptions fired by hardwares that are not stopped.

doStart

public void doStart()

Called upon subsystem start.

doShutdown

public void doShutdown()

Called upon subsystem shutdown. To be overridden by subclasses. This code is called by shutdown after all commands terminated it should notify components it's time to perform shutdown operation

completeInitialization

@Command(description="completes initialization after hardware problems corrections",
         type=ACTION)
public void completeInitialization()
                                                                                                                                       throws SystemStateException,
                                                                                                                                              HardwareException

Command to complete initialization (if commands were issued to heal hardware problems).

Throws:

SystemStateException

HardwareException

forceShutdown

@Command(description="forces blocked shutdown (not implemented yet!)",
         type=SIGNAL)
public void forceShutdown()

Command to force subsystem shutdown. REVIEW: Not yet implemented.

abort

@Command(description="abort subsystem",
         type=SIGNAL)
public void abort()

Command to abort operation. Should be overridden by subsystems to implement specific abort procedures.

stop

@Command(description="stops hardware with expected max delay",
         type=ACTION)
public void stop(@Argument(name="timeHint",defaultValue="-1")
                                                                                                      long timeHint)
                                                                                               throws HardwareException

Command to stop operation. Should be overridden by subsystems to implement specific abort procedures.

Parameters:

timeHint - time limit for execution

Throws:

HardwareException

stopAndWait

@Command(description="waits until all the hardware devices are actually stopped",
         type=ACTION)
public void stopAndWait(long timeHint)
                                                                                                                         throws HardwareException,
                                                                                                                                InterruptedException

forwards a STOP signal to all components and then checks if all hardwares have been stopped within timeHint

Parameters:

timeHint -

Throws:

HardwareException, - InterruptedException

HardwareException

InterruptedException

switchToEngineeringMode

@Command(description="switch to ENGINEERING mode",
         type=ACTION)
public boolean switchToEngineeringMode()

Command to switch to ENGINEERING mode.

Returns:

true if the subsystem state has changed as a result of execution

switchToNormalMode

@Command(description="Tries to get back to NORMAL mode",
         type=ACTION)
public final void switchToNormalMode()
                                                                                                             throws SystemStateException

Command to switch to NORMAL mode.

Throws:

SystemStateException - if alarms are not cleared or signals are still running

addClearAlertHandler

public final void addClearAlertHandler(ClearAlertHandler handler)

Add a ClearAlertHandler to this Subsystem.

Parameters:

handler - The ClearAlertHandler class that will handle the clearing of alerts.

raiseAlert

public final void raiseAlert(Alert alert,
                             AlertState severity,
                             String cause)

Raise an Alert with a given AlertState. When an Alert is raised the AlertState of the Agent might change and lock to the value of the AlertState.

Parameters:

alert - The Alert instance to be raised

severity - The AlertState of this Alert.

cause - The reason the Alert was raised.

clearAlerts

@Command(description="Clear alerts",
         type=ACTION)
public final String[] clearAlerts(String... alertId)

Clear one or more Alerts by providing the alert id.

Parameters:

alertId - the Id of the Alerts to be cleared.

Returns:

The String array with the ids of the alerts that have been cleared.

clearAllAlerts

@Command(description="Clear all alerts",
         type=ACTION)
public final String[] clearAllAlerts()

Attempt to clear all the outstanding alerts.

Returns:

The String array with the ids of the alerts that have been cleared.

getRaisedAlertSummary

@Command(description="Get the Raised Alert Summary",
         type=QUERY)
public final RaisedAlertSummary getRaisedAlertSummary()

Get the Subsystem's RaisedAlertSummary.

Returns:

The RaisedAlertSummary for this subsystem.

setBusLogHandlerLevel

@Command(description="set the level of the BusLogHandler",
         type=QUERY)
public void setBusLogHandlerLevel(String levelName)

Command to set the level at which the Log Bus Hander will start logging.

Parameters:

levelName - name of JUL Level

setLogLevel

@Command(description="set the level of a Logger",
         type=QUERY)
public void setLogLevel(String keyLogger,
                                                                                               String levelName)

Command to set the Level of a named Logger.

Parameters:

keyLogger - name of Logger (can be a package or a "concern" such as "INIT", "CONFIG"

levelName - the name of a JUL Level

setStackTraceDepth

@Command(description="sets the the depth of stacktraces in Logger messages",
         type=QUERY)
public void setStackTraceDepth(int depth)

Will modify the depth of stackTrace printing for ALL handlers (including the LogBusHandler)

Parameters:

depth - could be negative if we want all the stackTrace

setLogFormat

@Command(description="sets the format used by TextFormatter for LogEvent messages ",
         type=QUERY)
public void setLogFormat(String format)

Command to set a format for the TextFormatter of LogBusHandler (see logging.properties doc).

Parameters:

format -

setLogHandlerLevel

@Command(description="sets the handler (ConsoleHandler, FileHandler, LogBusHandler) log level",
         type=QUERY)
public void setLogHandlerLevel(String handler,
                                                                                                                                                    String level)

Command to set a level for a given handler

Parameters:

handler - can be ConsoleHandler, FileHandler, LogBusHandler

level -

removeLogPanicState

@Command(description="tries to stop the panic state of logmanagement",
         type=QUERY)
public void removeLogPanicState()

Command to try and reset the panic state of a the Log Bus Handler (logging failed before).

getNumberCommandThreads

@Command(description="gets the number of commands which are currently running (except the current one!)",
         type=QUERY)
public int getNumberCommandThreads()

Command that returns the number of currently running commands.

Returns:

the number of commands currently executing (except the current one)

printRunningCommands

@Command(description="gets the name of commands which are currently running",
         type=QUERY)
public String printRunningCommands()

Command returning a String describing which commands are running.

Returns:

summary of currently running commands.

ping

@Command(description="broadcast on the status bus a message of presence",
         type=QUERY,
         category=SYSTEM)
public void ping()

Command to broadcast a message of presence on the status bus.

getSubsystemConfigurationEnvironment

public final SubsystemConfigurationEnvironment getSubsystemConfigurationEnvironment()

Provides programmatic access to the configuration API.

Returns:

saveAllChanges

@Deprecated
public final void saveAllChanges()
                                      throws ConfigurationServiceException

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

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

Throws:

ConfigurationServiceException - if configuration service unavailable

saveChangesForCategories

@Deprecated
public final void saveChangesForCategories(@Argument(name="taggedCategories",description="A list of categories")
                                                       String... categories)

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

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

@Deprecated
public final void saveChangesForCategoriesAs(@Argument(name="taggedCategories",description="A list of pairs categoryName:configurationName")
                                                         String... taggedCategories)

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

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

@Deprecated
public void dropAllChanges()

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

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

dropChangesForCategories

@Deprecated
public void dropChangesForCategories(@Argument(name="categories",description="A list of categories")
                                                 String... categories)

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

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

Parameters:

categories - A list of categories

loadConfiguration

@Deprecated
public void loadConfiguration(@Argument(name="taggedCategories",description="a list of pairs categoryName:configurationName")
                                          String... taggedCategories)

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

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

TypeConversionException

loadCategories

@Deprecated
public void loadCategories(@Argument(name="taggedCategories",description="a list of pairs categoryName:configurationName")
                                       String... taggedCategories)

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

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

change

@Deprecated
public void change(String componentName,
                               String parameterName,
                               Object value)

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

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

@Deprecated
public void submitChange(String componentName,
                                     String parameterName,
                                     Object value)

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

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

@Deprecated
public void commitBulkChange()

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

Changes that have been submitted are processed as a group.

dropAllSubmittedChanges

@Deprecated
public void dropAllSubmittedChanges()

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

dropSubmittedChangesForComponent

@Deprecated
public void dropSubmittedChangesForComponent(@Argument(description="the component name")
                                                         String name)

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

getSubmittedChangesForComponent

@Deprecated
public Map<String,String> getSubmittedChangesForComponent(@Argument(description="the component name")
                                                                      String name)

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

getAllSubmittedChanges

@Deprecated
public Map<String,Map<String,String>> getAllSubmittedChanges()

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

Returns the current submitted changes for each component.

Returns:

a map ordered by component name.

getCategories

@Deprecated
public Set<String> getCategories()

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

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

Returns:

a set of category names.

findAvailableConfigurationsForCategory

@Deprecated
public Set<String> findAvailableConfigurationsForCategory(String category)

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

Returns the available configuration names for the given category.

Parameters:

category -

Returns:

a set of configuration names.

getCurrentValuesForComponent

@Deprecated
public Map<String,String> getCurrentValuesForComponent(String componentName,
                                                                   Set<String> categorySet)

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

isParameterConfigurable

@Deprecated
public boolean isParameterConfigurable(String componentName,
                                                   String parameterName)

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

Parameters:

componentName - the component name

parameterName - the parameter name

getConfigurationInfo

@Deprecated
public ConfigurationInfo getConfigurationInfo()

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

Returns:

a ConfigurationInfo object depicting the current configuration state

getTag

@Deprecated
public String getTag()

Deprecated. use the configuration API through the ConfigurationCommandSet object accessible via getSubsystemConfigurationEnvironment()

Returns:

tag name

getSubsystemForObject

public static final Subsystem getSubsystemForObject(Object obj)

Get the Subsystem for a given object belonging to a ComponentLookup. The Subsystem is generally unavailable when the Component is created. It is available only after the Subsystem has been built from the ComponentLookup. If the Subsystem is not available, or not built, null will be returned.

Returns:

The Subsystem to which this object belongs to. If no subsystem is available for this object, null will be returned. TODO: remove public qualifiers once Configurable has been deprecated.

getComponentConfigurationEnvironment

public ComponentConfigurationEnvironment getComponentConfigurationEnvironment(Object obj)

Get the ComponentConfigurationEnvironment object for a given Object.

getComponentConfigurationEnvironmentByName

public ComponentConfigurationEnvironment getComponentConfigurationEnvironmentByName(String name)

Get the ComponentConfigurationEnvironment object for a given node name.