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

AGENT_HEARTBEAT_TASK, AGENT_RUNTIMEINFO_TASK, commandExecutorLock, currentAction, currentQueries, currentSignals, innerStateLock, logBusHandler, OBJECT_SUBSYSTEM_MAP

Constructor Summary

Constructors

Constructor and Description
Subsystem(String name, AgentInfo.AgentType type) Constructs a Subsystem of a given type with no inner structure.
Subsystem(String name, AgentInfo.AgentType type, ComponentLookup lookup) Constructs Subsystem with an internal structure that has been built by externally and stored in a ComponentLookup object.

Method Summary

Modifier and Type	Method and Description
void	abort() Command to abort operation.
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.
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.
protected void	doShutdown() Called upon subsystem shutdown.
void	doStart() Called upon subsystem start.
void	forceShutdown() Command to force subsystem shutdown.
Handler	getLogHandler(String handlerName) Get a LogHandler for a given name.
ComponentLookup	getLookup() Deprecated. Use getComponentLookup instead
int	getNumberCommandThreads() Command that returns the number of currently running commands.
static Subsystem	getSubsystemForObject(Object obj) Get the Subsystem for a given object belonging to a ComponentLookup.
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.
void	ping() Command to broadcast a message of presence on the status bus.
String	printRunningCommands() Command returning a String describing which commands are running.
void	setLogFormat(String format) Command to set a format for the TextFormatter of LogBusHandler (see logging.properties doc).
void	setLogHandlerLevel(String handlerName, String level) Command to set a level for a given handler Internally we use java.util.logging.Level#parse(String) to parse the Level corresponding to the provided String.
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
boolean	switchToEngineeringMode() Command to switch to ENGINEERING mode.
void	switchToNormalMode() Command to switch to NORMAL mode.

Methods inherited from class org.lsst.ccs.Agent

addClearAlertHandler, addCommandSet, addCommandsFromObject, addStateChangeListener, broadcastStatus, change, clearAlerts, clearAllAlerts, commitBulkChange, dropAllChanges, dropAllSubmittedChanges, dropChangesForCategories, dropSubmittedChangesForComponent, executeCommandRequest, findAvailableConfigurationsForCategory, getAgentInfo, getAgentPeriodicTaskService, getAgentPersistenceService, getAgentProperties, getAgentPropertiesKeySet, getAgentProperty, getAlertService, getAllSubmittedChanges, getCategories, getCCSVersions, getCommandCount, getCommandSet, getCommandTargets, getComponentConfigurationEnvironment, getComponentConfigurationEnvironmentByName, getComponentLookup, getComponentState, getConfigurationInfo, getCurrentAction, getCurrentValuesForComponent, getDescription, getDictionaries, getDistributionInfo, getEnvironmentMessagingAccess, getLogger, getMessagingAccess, getMonitor, getName, getRaisedAlertSummary, getScheduler, getState, getState, getStatusBroadcastPeriod, getSubmittedChangesForComponent, getSubsystemConfigurationEnvironment, getTag, isComponentInState, isInEngineeringMode, isInState, isInState, isParameterConfigurable, loadCategories, loadConfiguration, persistNow, populateComponentLookup, postStart, publishStateChange, publishSubsystemDataOnStatusBus, raiseAlert, removeStateChangeListener, saveAllChanges, saveChangesForCategories, saveChangesForCategoriesAs, sendAck, sendNack, setAgentProperty, shutdown, start, startAgent, startAgent, submitChange, updateAgentComponentState, 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 a Subsystem of a given type with no inner structure.

Parameters:

name - name of the subsystem : cannot be null

type - Agent type

Subsystem

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

Constructs Subsystem with an internal structure that has been built by externally and stored in a ComponentLookup object.

Parameters:

name - name of the subsystem : cannot be null

type - Agent type

lookup - The ComponentLookup object with the internal structure of the Subsystem.

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

getLookup

@Deprecated
public final ComponentLookup getLookup()

Deprecated. Use getComponentLookup instead

Provides access to the inner modular structure of this Subsystem.

Returns:

a ComponentLookup object.

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. TO-DO: This method is public for testing reasons. Can it be changed to package protected?

doShutdown

protected 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

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

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 handlerName,
                                                                                                                                                    String level)

Command to set a level for a given handler Internally we use java.util.logging.Level#parse(String) to parse the Level corresponding to the provided String.

Parameters:

handlerName - The name of the LogHandler. Valid names are: LogBusHandler, LogBus, ConsoleHandler, Console, FileHandler, File

level - A String corresponding to a java.util.logging.Level

getLogHandler

public Handler getLogHandler(String handlerName)

Get a LogHandler for a given name.

Parameters:

handlerName - The name of the LogHandler. Valid names are: LogBusHandler, LogBus, ConsoleHandler, Console, FileHandler, File

Returns:

The corresponding Handler or null if nothing was found.

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.

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.