org.lsst.ccs.startup

Class NodeModularSubsystem

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.config.ConfigurableSubsystem

org.lsst.ccs.startup.NodeModularSubsystem

All Implemented Interfaces:

CommandExecutor

public class NodeModularSubsystem
extends org.lsst.ccs.config.ConfigurableSubsystem

the top modular subsystem that deals with configuration proxy and lookup service

Author:

bamade

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

Method Summary

Modifier and Type	Method and Description
void	abort() forwards a HALT signal to all components (that are signalHandlers)
void	abort(long expectedMaxDelay) same as abort but with a time span.
void	checkAllHardwareStarted() checks if all HardwareControllers have been started
void	checkAllHardwareStopped() checks if all HardwareControllers have been stopped
void	checkHardware() invoke a checkHardware on all HardwareController (except when return diag modifies the path of invocation)
void	doShutdown() invokes the shutdownNow() methods on all components (starting from the top main Module)
void	doStart() invokes the start() methods on all components (starting from the top main Module)
protected Configurable	getCommandDestination(String commandDestination) Deprecated. unused
org.lsst.ccs.description.ComponentLookupService	getLookup()
List<org.lsst.ccs.utilities.structs.ViewValue>	getPreOrderComponentList() Deprecated. unused.
void	postStart() invokes the postStart() methods on all components (starting from the top main Module)
void	stop() same as stop(delay) but with an infinite delay
void	stop(long expectedMaxDelay) forwards a STOP signal to all components (that are signalHandlers)
void	stopAndWait(long expectedMaxDelay) forwards a STOP signal to all components and then checks if all hardwares have been stopped within expectedMaxDelay
protected void	updateHeartBeat(org.lsst.ccs.bus.messages.StatusHeartBeat s)

Methods inherited from class org.lsst.ccs.config.ConfigurableSubsystem

commitBulkChange, dropAllChanges, dropBulkChange, dropChangesForCategories, getConfigurationInfo, getConfigurationProxy, getTag, loadCategories, loadConfiguration, saveAllChanges, saveChangesForCategories, saveChangesForCategoriesAs, setConfigurationProxy, submitChange

Methods inherited from class org.lsst.ccs.Subsystem

addClearAlertHandler, clearAlarms, clearAlerts, clearAllAlerts, completeInitialization, completeInitialization, forceShutdown, getLogger, getNumberCommandThreads, getRaisedAlertSummary, initialisationEndPhase, internalShutdown, internalStart, interruptActionThread, ping, printRunningCommands, publishMetaData, publishStatus, publishStatus, publishStatus, publishStatus, publishStatus, publishStatusData, raiseAlarm, raiseAlert, removeLogPanicState, sendRawStatus, setBusLogHandlerLevel, setLogFormat, setLogHandlerLevel, setLogLevel, setStackTraceDepth, 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, updateInternalState, waitFor

Methods inherited from class java.lang.Object

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

Method Detail

updateHeartBeat

protected void updateHeartBeat(org.lsst.ccs.bus.messages.StatusHeartBeat s)

Overrides:

updateHeartBeat in class Agent

getLookup

public org.lsst.ccs.description.ComponentLookupService getLookup()

Specified by:

getLookup in class org.lsst.ccs.config.ConfigurableSubsystem

getPreOrderComponentList

@Deprecated
public List<org.lsst.ccs.utilities.structs.ViewValue> getPreOrderComponentList()

Deprecated. unused.

*

Returns:

a List of [name-component] in PreOrder.

doStart

public void doStart()

invokes the start() methods on all components (starting from the top main Module)

Overrides:

doStart in class org.lsst.ccs.config.ConfigurableSubsystem

postStart

public void postStart()
               throws HardwareException

invokes the postStart() methods on all components (starting from the top main Module)

Overrides:

postStart in class Subsystem

Throws:

HardwareException

doShutdown

public void doShutdown()

invokes the shutdownNow() methods on all components (starting from the top main Module)

Overrides:

doShutdown in class Subsystem

getCommandDestination

protected Configurable getCommandDestination(String commandDestination)

Deprecated. unused

utility method to find a Component out of a Command destination

Parameters:

commandDestination -

Returns:

a Configurable

abort

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

forwards a HALT signal to all components (that are signalHandlers)

Overrides:

abort in class Subsystem

abort

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

same as abort but with a time span.

Overrides:

abort in class Subsystem

Parameters:

expectedMaxDelay -

stop

@Command(description="stops with expected max delay",
         type=ACTION)
public void stop(long expectedMaxDelay)
                                                                                      throws HardwareException

forwards a STOP signal to all components (that are signalHandlers)

Overrides:

stop in class Subsystem

Throws:

HardwareException

stop

@Command(description="stops hardware",
         type=ACTION)
public void stop()
                                                                       throws HardwareException

same as stop(delay) but with an infinite delay

Throws:

HardwareException

stopAndWait

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

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

Parameters:

expectedMaxDelay -

Throws:

HardwareException, - InterruptedException

HardwareException

InterruptedException

checkHardware

public void checkHardware()
                   throws HardwareException

invoke a checkHardware on all HardwareController (except when return diag modifies the path of invocation)

Overrides:

checkHardware in class Subsystem

Throws:

HardwareException - a list of HardwareException

checkAllHardwareStarted

public void checkAllHardwareStarted()
                             throws HardwareException

checks if all HardwareControllers have been started

Overrides:

checkAllHardwareStarted in class Subsystem

Throws:

HardwareException - a list of exception fired by hardware that are not started

checkAllHardwareStopped

public void checkAllHardwareStopped()
                             throws HardwareException

checks if all HardwareControllers have been stopped

Overrides:

checkAllHardwareStopped in class Subsystem

Throws:

HardwareException - a list of exception fired by hardware that are not stopped