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, ConfigurationServerSystem

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.

Method Summary

Modifier and Type	Method and Description
void	abort() Command to abort operation.
void	abort(long expectedMaxDelay) Deprecated.
void	addClearAlertHandler(ClearAlertHandler handler) Add a ClearAlertHandler to this Subsystem.
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	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	forceShutdown() Command to force subsystem shutdown.
Logger	getLogger() Returns the current logger (use sparingly and prefer your own logger).
int	getNumberCommandThreads() Command that returns the number of currently running commands.
RaisedAlertSummary	getRaisedAlertSummary() Get the Subsystem's RaisedAlertSummary.
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.
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) Deprecated.
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	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 expectedMaxDelay) Command to stop operation.
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, 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

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

checkHardware

public void checkHardware()
                   throws HardwareException

Called before activating anything and again once problems are supposed to have been addressed.

Throws:

HardwareException - "compound" exception

checkAllHardwareStarted

public void checkAllHardwareStarted()
                             throws HardwareException

Called to check if all hardware has been correctly 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.

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.

abort

@Command(description="halt hardware with expected max delay",
         type=SIGNAL)
 @Deprecated
public void abort(long expectedMaxDelay)

Deprecated.

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(long expectedMaxDelay)
                                                                                               throws HardwareException

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

Parameters:

expectedMaxDelay - time limit for execution

Throws:

HardwareException

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.

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.

raiseAlert

@Deprecated
public final void raiseAlert(Alert alert,
                                         AlertState severity)

Deprecated.

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.