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 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.config.ConfigurableSubsystem

configurationProxy, parameterSetterDictionary

Fields inherited from class org.lsst.ccs.Agent

commandExecutorLock, currentAction, currentQueries, currentSignals, heartbeatPublisher, innerStateLock, 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 timeHint) Deprecated.
protected Set<ParameterPath>	bulkChange() Processes the change of configurable parameters contained in the bulk changes.
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	commitBulkChange() Changes that have been submitted are processed as a group.
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)
ComponentLookupService	getLookup()
void	postStart() invokes the postStart() methods on all components (starting from the top main Module)
void	stop(long timeHint) forwards a STOP signal to all components (that are signalHandlers)
void	stopAndWait(long timeHint) forwards a STOP signal to all components and then checks if all hardwares have been stopped within timeHint
protected void	updateHeartBeat(StatusHeartBeat s) Subclasses can override this method to add customized information to the heartbeat.
protected void	validateBulkChanges() Validates the set of submitted changes as a group.

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

change, dropAllChanges, dropAllSubmittedChanges, dropBulkChange, dropChangesForCategories, dropSubmittedChangesForComponent, findAvailableConfigurationsForCategory, getAllSubmittedChanges, getCategories, getConfigurationInfo, getConfigurationProxy, getSubmittedChangesForComponent, getTag, loadCategories, loadConfiguration, saveAllChanges, saveChangesForCategories, saveChangesForCategoriesAs, setConfigurationProxy, submitChange, updateStateAndSendStatusConfigurationInfo

Methods inherited from class org.lsst.ccs.Subsystem

addClearAlertHandler, clearAlerts, clearAllAlerts, completeInitialization, completeInitialization, forceShutdown, getLogger, getNumberCommandThreads, getRaisedAlertSummary, internalShutdown, internalStart, ping, printRunningCommands, raiseAlert, raiseAlert, removeLogPanicState, setBusLogHandlerLevel, setLogFormat, setLogHandlerLevel, setLogLevel, setStackTraceDepth, switchToEngineeringMode, switchToNormalMode

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, 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(StatusHeartBeat s)

Description copied from class: Agent

Subclasses can override this method to add customized information to the heartbeat.

Overrides:

updateHeartBeat in class Agent

Parameters:

s - Heartbeat instance to be modified before publication.

getLookup

public ComponentLookupService getLookup()

doStart

public void doStart()

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

Overrides:

doStart in class 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

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)
 @Deprecated
public void abort(long timeHint)

Deprecated.

same as abort but with a time span.

Overrides:

abort in class Subsystem

Parameters:

timeHint -

stop

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

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

Overrides:

stop in class Subsystem

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

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

commitBulkChange

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

Changes that have been submitted are processed as a group.

Overrides:

commitBulkChange in class ConfigurableSubsystem

validateBulkChanges

protected void validateBulkChanges()

Description copied from class: ConfigurableSubsystem

Validates the set of submitted changes as a group.

Specified by:

validateBulkChanges in class ConfigurableSubsystem

bulkChange

protected Set<ParameterPath> bulkChange()

Processes the change of configurable parameters contained in the bulk changes.

Specified by:

bulkChange in class ConfigurableSubsystem

Returns:

the processed parameters ordered by component name