Agent (LSST CCS - Toolkit (Pom) 5.1.10 API)

java.lang.Object
- org.lsst.ccs.Agent

All Implemented Interfaces:

CommandExecutor, ServiceLifecycle

Direct Known Subclasses:

Subsystem
```
public class Agent
extends Object
implements CommandExecutor, ServiceLifecycle
```
Minimal component able to communicate on the buses. The following functionality is supported by the Agent:
- Access to the buses through an instance of AgentMessagingLayer.
- A method for publishing arbitrary objects on the status bus.
- Protected methods for checking, modifying, and publishing the Agent state. Access to the state is synchronized so these methods can be called from any thread.
- Heartbeat publishing.
- Command processing.
- Scheduling periodic and delayed tasks.
IMPLEMENTATION NOTE: Agent must not implement HasLifecycle see https://jira.slac.stanford.edu/browse/LSSTCCS-1487
Author:

emarin

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Agent.RunningCommand
Represents a command accepted for execution by this Agent.

Nested Classes
Modifier and Type	Class and Description
`class`	`Agent.RunningCommand` Represents a command accepted for execution by this `Agent`.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AGENT_HEARTBEAT_TASK`
`static String`	`AGENT_RUNTIMEINFO_TASK`
`protected Object`	`commandExecutorLock` Lock that guards command executor state.
`protected Agent.RunningCommand`	`currentAction` Currently running CONFIGURATION or ACTION command.
`protected Set<Agent.RunningCommand>`	`currentQueries` Currently running QUERY commands.
`protected Set<Agent.RunningCommand>`	`currentSignals` Currently running SIGNAL commands.
`protected AtomicBoolean`	`jvmShutdown` Flag indicating that shutdownAgent() is being executed in a JVM shutdown hook.
`protected LogBusHandler`	`logBusHandler` Logging bus handler
`protected AgentStateService`	`stateService`
`protected boolean`	`treeComponentInitialized`

Constructor Summary

Constructors
Constructor and Description

Agent(String name, AgentInfo.AgentType agentType)
Constructs an Agent.

Constructors
Constructor and Description
`Agent(String name, AgentInfo.AgentType agentType)` Constructs an `Agent`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addCommandSet(String fullPath, Object obj)` Adds a `CommandSet` to extend the set of commands recognized by this `Agent`.
`void`	`addCommandsFromObject(Object obj, String path)` Add the commands defined in an Object to this Agent's CommandSet.
`void`	`addStateChangeListener(StateChangeListener stateChangeListener, Class... states)` Deprecated. use `AgentStateService::addStateChangeListener(StateChangeListener, Class...)` instead
`protected void`	`broadcastStatus()` Broadcasts the current heartbeat status.
`void`	`checkAllHardwareStopped()` Called to check if all hardware has been correctly started.
`protected CommandHelper`	`createHelper()` This method can be overridden by subclasses of Agent to create a subclass of CommandHelper to be returned by `helper()`
`void`	`executeCommandRequest(CommandRequest request)` Executes the received command
`AgentInfo`	`getAgentInfo()` Returns `AgentIfno` instance associated with this `Agent`.
`AgentLockService`	`getAgentLockService()` Deprecated. use `getAgentService(Class)` instead.
`AgentPeriodicTaskService`	`getAgentPeriodicTaskService()` Deprecated. use `getAgentService(Class)` instead.
`PersistencyService`	`getAgentPersistenceService()` Get this agent's local persistence service.
`Properties`	`getAgentProperties()` Get the agent properties.
`Set`	`getAgentPropertiesKeySet()` Get the Set of agent properties.
`String`	`getAgentProperty(String property)` Get an agent property.
`<T extends AgentService> T`	`getAgentService(Class<T> agentClass)` Generic method to access agent services.
`List<AgentService>`	`getAgentServices()` Get the list of available services for this Agent.
`AgentStatusAggregatorService`	`getAgentStatusAggregatorService()` Deprecated. use `getAgentService(Class)` instead.
`AlertService`	`getAlertService()` Deprecated. use `getAgentService(Class)` instead.
`CCSVersions`	`getCCSVersions()` Command to get the CCSVersions object for the current CCS Environment.
`int`	`getCommandCount(Command.CommandType... types)` Returns the number of currently running commands of given types.
`protected CommandSet`	`getCommandSet(String name)`
`List<String>`	`getCommandTargets()` Returns this `Agent` list of command targets.
`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()` Provides access to the inner modular structure of this Subsystem.
`ConfigurationService`	`getConfigurationService()` Deprecated. use `getAgentService(Class)` instead.
`Agent.RunningCommand`	`getCurrentAction()` Get the current RunningCommand action.
`DataProviderDictionaryService`	`getDataProviderDictionaryService()` Deprecated. use `getAgentService(Class)` instead.
`String`	`getDescription()` Gets the name of the description this subsystem was built from.
`HashMap<String,Dictionary>`	`getDictionaries()` Returns the command dictionary used by this `Agent`.
`DistributionInfo`	`getDistributionInfo()` Command to get the DistributionInfo object for this `Agent`.
`static AgentLockService`	`getEnvironmentLockService()`
`static AgentMessagingLayer`	`getEnvironmentMessagingAccess()` Returns `AgentMessagingLayer` associated with this JVM.
`Logger`	`getLogger()` Returns the current logger (use sparingly and prefer your own logger).
`AgentMessagingLayer`	`getMessagingAccess()` Returns `AgentMessagingLayer` used by this `Agent`.
`Monitor`	`getMonitor()` Deprecated.
`String`	`getName()` Returns the name of this `Agent`.
`Scheduler`	`getScheduler()` Returns `Scheduler` used by this `Agent`.
`StateBundle`	`getState()` Deprecated. use `AgentStateService::getState()` instead
`Enum`	`getState(Class stateClass)` Deprecated. use `AgentStateService::getState(Class)` instead
`int`	`getStatusBroadcastPeriod()` Returns heartbeat broadcasting period for this `Agent`.
`CommandHelper`	`helper()` A convenience method for creating a new CommandHelper
`protected void`	`internalCheckHardware()` Called before activating anything and again once problems are supposed to have been addressed.
`boolean`	`isConnectedToTheBuses()`
`boolean`	`isInEngineeringMode()` Command to tell if the subsystem is in Engineering mode.
`boolean`	`isInState(Enum state)` Deprecated. use `AgentStateService::isInState(Enum)` instead
`boolean`	`isInState(StateBundle state)` Deprecated. use `AgentStateService::isInState(StateBundle)` instead
`protected void`	`populateComponentLookup(ComponentLookup lookup)` Sets the component lookup for this Agent.
`void`	`preBuild()`
`void`	`preInit()`
`String`	`printComponentNodeTree()` Get a representation of the component tree.
`void`	`publishSubsystemDataOnStatusBus(KeyValueData keyValueData)` Publishes the provided `KeyValueData` on the Status bus.
`void`	`removeStateChangeListener(StateChangeListener stateChangeListener)` Deprecated. use `AgentStateService::removeStateChangeListener(StateChangeListener)` instead
`boolean`	`sendAck(Duration timeout)` Sends an ACK to the command originator.
`boolean`	`sendNack(Serializable reason)` Sends a NACK to the command originator.
`void`	`setAgentName(String alias)`
`void`	`setAgentProperty(String property, String value)` Set an Agent property.startAge This method can be invoked only up to the point the Agent is about to connect to the buses.
`Object`	`shutdownAgent()` Clean shutdown of subsystem: call stop for hardware stopping before invoking this method.
`void`	`startAgent()` Starts this Agent
`void`	`startAgent(String alias)` Deprecated. Use startAgent(). To set an Alias use setAgentName.
`void`	`updateAgentComponentState(Object component, Enum... stateChanges)` Deprecated. use `AgentStateService::updateAgentComponentState(Object, Enum...)` instead
`void`	`updateAgentState(Enum... stateChanges)` Deprecated. use `AgentStateService::updateAgentState(Enum...)` instead
`void`	`updateAgentState(StateBundle stateChanges)` Deprecated. use `AgentStateService::updateAgentState(StateBundle)` instead
`protected void`	`updateHeartBeat(StatusHeartBeat heartBeat)` Subclasses can override this method to add customized information to the heartbeat.
`boolean`	`waitFor(Predicate<StateBundle> target, long timeout, TimeUnit unit)` Deprecated. use `AgentStateService::waitFor(Predicate<StateBundle>, long, TimeUnit)` instead

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.lsst.ccs.ServiceLifecycle
afterInit, preShutdown, preStart

- Field Detail
  - jvmShutdown
```
protected final AtomicBoolean jvmShutdown
```
    Flag indicating that shutdownAgent() is being executed in a JVM shutdown hook.
  - logBusHandler
```
protected LogBusHandler logBusHandler
```
    Logging bus handler
  - commandExecutorLock
```
protected final Object commandExecutorLock
```
    Lock that guards command executor state.
  - currentQueries
```
protected final Set<Agent.RunningCommand> currentQueries
```
    Currently running QUERY commands.
  - currentAction
```
protected volatile Agent.RunningCommand currentAction
```
    Currently running CONFIGURATION or ACTION command.
  - currentSignals
```
protected final Set<Agent.RunningCommand> currentSignals
```
    Currently running SIGNAL commands.
  - treeComponentInitialized
```
protected volatile boolean treeComponentInitialized
```
  - stateService
```
@LookupField(strategy=CHILDREN)
protected AgentStateService stateService
```
  - AGENT_HEARTBEAT_TASK
```
public static final String AGENT_HEARTBEAT_TASK
```
    See Also:
    
    Constant Field Values
  - AGENT_RUNTIMEINFO_TASK
```
public static final String AGENT_RUNTIMEINFO_TASK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Agent
```
public Agent(String name,
             AgentInfo.AgentType agentType)
```
    Constructs an Agent.
    
    Parameters:
    
    name - name of this Agent; for CONSOLE and LISTENER agents, the name will be modified to ensure uniqueness.
    
    agentType - type of this Agent.
- Method Detail
  - preBuild
```
public void preBuild()
```
    Specified by:
    
    preBuild in interface ServiceLifecycle
  - preInit
```
public void preInit()
```
    Specified by:
    
    preInit in interface ServiceLifecycle
  - populateComponentLookup
```
protected final void populateComponentLookup(ComponentLookup lookup)
```
    Sets the component lookup for this Agent. This method is meant to be invoked from two places: - a constructor - BootUtils after a Subsystem has been built
    
    Parameters:
    
    lookup - the lookup
  - getAgentServices
```
public final List<AgentService> getAgentServices()
```
    Get the list of available services for this Agent.
    
    Returns:
    
    a List of AgentServices
  - getAgentService
```
public final <T extends AgentService> T getAgentService(Class<T> agentClass)
```
    Generic method to access agent services.
    
    Type Parameters:
    
    T - The class of the service to fetch.
    
    Parameters:
    
    agentClass -
    
    Returns:
    
    The services of the requested type.
  - getComponentLookup
```
public final ComponentLookup getComponentLookup()
```
    Provides access to the inner modular structure of this Subsystem.
    
    Returns:
    
    a ComponentLookup object.
  - createHelper
```
protected CommandHelper createHelper()
```
    This method can be overridden by subclasses of Agent to create a subclass of CommandHelper to be returned by helper()
    
    Returns:
    
    The newly created CommandHelper
  - helper
```
public CommandHelper helper()
```
    A convenience method for creating a new CommandHelper
    
    Returns:
    
    The newly created CommandHelper
    
    See Also:
    
    createHelper()
  - getAgentPeriodicTaskService
```
@Deprecated
public final AgentPeriodicTaskService getAgentPeriodicTaskService()
```
    Deprecated. use getAgentService(Class) instead.
    
    Get the AgentPeriodicTaskService. This method is used only at test level.
    
    Returns:
    
    The agent periodic task service.
  - getAgentStatusAggregatorService
```
@Deprecated
public final AgentStatusAggregatorService getAgentStatusAggregatorService()
```
    Deprecated. use getAgentService(Class) instead.
  - setAgentName
```
public final void setAgentName(String alias)
```
  - startAgent
```
@Deprecated
public void startAgent(String alias)
```
    Deprecated. Use startAgent(). To set an Alias use setAgentName.
    
    Parameters:
    
    alias -
  - startAgent
```
public void startAgent()
```
    Starts this Agent
  - shutdownAgent
```
@Command(name="shutdown",
         description="shutdown",
         type=ACTION)
public Object shutdownAgent()
                                                                                                      throws Exception
```
    Clean shutdown of subsystem: call stop for hardware stopping before invoking this method.
    
    Returns:
    
    Status of the shutdown
    
    Throws:
    
    Exception - If anything goes wrong during shutdown
  - getLogger
```
public Logger getLogger()
```
    Returns the current logger (use sparingly and prefer your own logger).
    
    Returns:
    
    logger associated with this subsystem
  - getName
```
public final String getName()
```
    Returns the name of this Agent.
    
    Returns:
    
    name of this Agent
  - getAgentInfo
```
public AgentInfo getAgentInfo()
```
    Returns AgentIfno instance associated with this Agent.
    
    Returns:
    
    AgentIfno instance associated with this Agent
  - getScheduler
```
public Scheduler getScheduler()
```
    Returns Scheduler used by this Agent. Subsystem developers are encouraged to use this scheduler for running all periodic and delayed short tasks.
    
    Returns:
    
    Scheduler provided by this Agent.
  - getCommandCount
```
public int getCommandCount(Command.CommandType... types)
```
    Returns the number of currently running commands of given types. Note that unless this method is called while holding commandExecutorLock monitor, the returned value is not guaranteed to be current when the method returns.
    
    Parameters:
    
    types - Types of commands to include in the count. In no types are given, all commands are included.
    
    Returns:
    
    number of currently running commands of given types
  - getStatusBroadcastPeriod
```
public int getStatusBroadcastPeriod()
```
    Returns heartbeat broadcasting period for this Agent.
    
    Returns:
    
    period (in seconds) for status broadcasting.
  - isInEngineeringMode
```
@Command(description="is the system in engineering mode ?",
         type=QUERY,
         category=SYSTEM)
public boolean isInEngineeringMode()
```
    Command to tell if the subsystem is in Engineering mode.
    
    Returns:
    
    true if this Agent is in ENGINEERING_OK or ENGINEERING_FAULT mode.
  - getCCSVersions
```
@Command(description="Get the CCS Versions for the current CCS Environment",
         type=QUERY,
         category=SYSTEM)
public CCSVersions getCCSVersions()
```
    Command to get the CCSVersions object for the current CCS Environment.
    
    Returns:
    
    The CCSVersions object for the current CCS Environment
  - getDistributionInfo
```
@Command(description="Get the Agent\'s DistributionInfo object.",
         type=QUERY,
         category=SYSTEM)
public DistributionInfo getDistributionInfo()
```
    Command to get the DistributionInfo object for this Agent. The DistributionInfo object contains version information about the distribution from which this Agent was launched.
    
    Returns:
    
    The DistributionInfo for this Agent.
  - getDictionaries
```
@Command(description="get the command dictionary for the subsystem",
         type=QUERY,
         category=SYSTEM)
public HashMap<String,Dictionary> getDictionaries()
```
    Returns the command dictionary used by this Agent.
    
    Returns:
  - getCommandTargets
```
@Command(description="Get the list of command targets",
         type=QUERY,
         category=SYSTEM)
public List<String> getCommandTargets()
```
    Returns this Agent list of command targets.
    
    Returns:
    
    The list of Command targets.
  - printComponentNodeTree
```
@Command(description="Print component lookup",
         type=QUERY,
         category=SYSTEM)
public String printComponentNodeTree()
```
    Get a representation of the component tree.
    
    Returns:
    
    a String representing the component tree
  - getCommandSet
```
protected CommandSet getCommandSet(String name)
```
  - addCommandSet
```
protected void addCommandSet(String fullPath,
                             Object obj)
```
    Adds a CommandSet to extend the set of commands recognized by this Agent.
    
    Parameters:
    
    obj - The object with the commands
    
    fullPath - the full path of the component to add
  - addCommandsFromObject
```
public void addCommandsFromObject(Object obj,
                                  String path)
```
    Add the commands defined in an Object to this Agent's CommandSet. This method will end up throwing a RuntimeException if it is invoked after the Agent has been started. This is because the internal method addCommandSet is protected against such an event.
    
    Parameters:
    
    obj - The Object from which to extract the commands.
    
    path - The path at which the resulting CommandSet will be added.
  - setAgentProperty
```
public void setAgentProperty(String property,
                             String value)
```
    Set an Agent property.startAge This method can be invoked only up to the point the Agent is about to connect to the buses. Once the messaging factory is create, the AgentInfo object of this Agent must be immutable.
    
    Parameters:
    
    property - The name of the property to set.
    
    value - The value of the property.
  - getAgentProperty
```
@Command(category=SYSTEM,
         type=QUERY)
public String getAgentProperty(String property)
```
    Get an agent property.
    
    Parameters:
    
    property - The property name.
    
    Returns:
    
    The value of the property.
  - getAgentPropertiesKeySet
```
@Command(category=SYSTEM,
         type=QUERY)
public Set getAgentPropertiesKeySet()
```
    Get the Set of agent properties.
    
    Returns:
    
    The Set of available Agent properties.
  - getAgentProperties
```
@Command(category=SYSTEM,
         type=QUERY)
public Properties getAgentProperties()
```
    Get the agent properties.
    
    Returns:
    
    The Agent properties.
  - getMessagingAccess
```
public AgentMessagingLayer getMessagingAccess()
```
    Returns AgentMessagingLayer used by this Agent. The returned instance is used by the Agent internally, and can also be used by the client code to publish messages on the buses.
    
    Returns:
    
    AgentMessagingLayer used by this Agent
  - getEnvironmentMessagingAccess
```
public static AgentMessagingLayer getEnvironmentMessagingAccess()
```
    Returns AgentMessagingLayer associated with this JVM. Normally, there is only one instance of AgentMessagingLayer per JVM, providing busses access to the Agent and all its clients. In the test environment, however, multiple agents can run on the same JVM.
    
    Returns:
    
    AgentMessagingLayer associated with this JVM
  - getEnvironmentLockService
```
public static AgentLockService getEnvironmentLockService()
```
  - isConnectedToTheBuses
```
public boolean isConnectedToTheBuses()
```
  - publishSubsystemDataOnStatusBus
```
public final void publishSubsystemDataOnStatusBus(KeyValueData keyValueData)
```
    Publishes the provided KeyValueData on the Status bus. Internally the KeyValueData is wrapped into a StatusSubsystemData before publication.
    
    Parameters:
    
    keyValueData - The KeyValueData to be published.
  - broadcastStatus
```
protected final void broadcastStatus()
```
    Broadcasts the current heartbeat status.
  - updateHeartBeat
```
protected void updateHeartBeat(StatusHeartBeat heartBeat)
```
    Subclasses can override this method to add customized information to the heartbeat.
    
    Parameters:
    
    heartBeat - Heartbeat instance to be modified before publication.
  - executeCommandRequest
```
public void executeCommandRequest(CommandRequest request)
```
    Description copied from interface: CommandExecutor
    
    Executes the received command
    
    Specified by:
    
    executeCommandRequest in interface CommandExecutor
    
    Parameters:
    
    request - the command to be executed by the CommandExecutor
  - sendNack
```
public boolean sendNack(Serializable reason)
```
    Sends a NACK to the command originator. This method can be called from inside methods annotated as commands with autoAck=false. It should be called on the same thread the command method was invoked on. If this method is called under any other circumstances, it has no effect and returns false. The value returned by the command method after sending NACK is ignored.
    
    Parameters:
    
    reason - Reason for rejecting the command.
    
    Returns:
    
    true if the NACK has been sent as a result of this call.
  - sendAck
```
public boolean sendAck(Duration timeout)
```
    Sends an ACK to the command originator. This method can be called from inside methods annotated as commands with autoAck=false. It should be called on the same thread the command method was invoked on. If this method is called under any other circumstances, it has no effect and returns false.
    
    Parameters:
    
    timeout - Timeout for the command. Specifying non-positive or null timeout indicates the default should be used.
    
    Returns:
    
    true if the ACK has been sent as a result of this call.
  - getCurrentAction
```
public Agent.RunningCommand getCurrentAction()
```
    Get the current RunningCommand action.
    
    Returns:
    
    The current RunningCommand for the action.
  - getMonitor
```
@Deprecated
public Monitor getMonitor()
```
    Deprecated.
    
    Provides access to this subsystem's monitor.
    
    Returns:
    
    the monitor for this subsystem
  - getConfigurationService
```
@Deprecated
public final ConfigurationService getConfigurationService()
```
    Deprecated. use getAgentService(Class) instead.
    
    Provides programmatic access to the configuration API.
    
    Returns:
    
    the configuration service for this subsystem
  - getAlertService
```
@Deprecated
public final AlertService getAlertService()
```
    Deprecated. use getAgentService(Class) instead.
    
    Provides access to the alert service.
    
    Returns:
    
    the alert service for this subsystem
  - getDataProviderDictionaryService
```
@Deprecated
public final DataProviderDictionaryService getDataProviderDictionaryService()
```
    Deprecated. use getAgentService(Class) instead.
    
    Provides access to the data provider dictionary service.
    
    Returns:
    
    the data provider dictionary service for this subsystem
  - getAgentLockService
```
@Deprecated
public final AgentLockService getAgentLockService()
```
    Deprecated. use getAgentService(Class) instead.
  - getComponentConfigurationEnvironment
```
public ComponentConfigurationEnvironment getComponentConfigurationEnvironment(Object obj)
```
    Get the ComponentConfigurationEnvironment object for a given Object.
    
    Parameters:
    
    obj - the object for which to get the component configuration service
    
    Returns:
    
    a component configuration service for the given object
  - getComponentConfigurationEnvironmentByName
```
public ComponentConfigurationEnvironment getComponentConfigurationEnvironmentByName(String name)
```
    Get the ComponentConfigurationEnvironment object for a given node name.
    
    Parameters:
    
    name - the name of the object for which to get the component configuration service.
    
    Returns:
    
    a component configuration service for the given object.
  - getAgentPersistenceService
```
public PersistencyService getAgentPersistenceService()
```
    Get this agent's local persistence service.
    
    Returns:
    
    the local persistence service for this agent.
  - getDescription
```
public String getDescription()
```
    Gets the name of the description this subsystem was built from. The description name is set after the initialization step.
    
    Returns:
    
    the description name
  - internalCheckHardware
```
protected void internalCheckHardware()
```
    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)
  - 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.
  - isInState
```
@Deprecated
public boolean isInState(Enum state)
```
    Deprecated. use AgentStateService::isInState(Enum) instead
    
    Check if this Agent is in the given state.
    
    Parameters:
    
    state - The state to check.
    
    Returns:
    
    true if this Agent is in the specified state.
  - isInState
```
@Deprecated
public boolean isInState(StateBundle state)
```
    Deprecated. use AgentStateService::isInState(StateBundle) instead
    
    Checks if this Agent is in all of the states contained in the given StateBundle.
    
    Parameters:
    
    state - A StateBundle.
    
    Returns:
    
    true if the Agent is in the provided StateBundle.
  - getState
```
@Deprecated
public Enum getState(Class stateClass)
```
    Deprecated. use AgentStateService::getState(Class) instead
    
    Returns the state of this Agent for the provided class.
    
    Parameters:
    
    stateClass - The class of the Enum for which we would like the Agent's state.
    
    Returns:
    
    state for the specified class.
  - getState
```
@Deprecated
public StateBundle getState()
```
    Deprecated. use AgentStateService::getState() instead
    
    Returns a copy of a state bundle of this Agent.
    
    Returns:
    
    state for the specified class.
  - updateAgentState
```
@Deprecated
public void updateAgentState(Enum... stateChanges)
```
    Deprecated. use AgentStateService::updateAgentState(Enum...) instead
    
    Updates the state of this Agent and publishes StateChangeNotification message only if the Agent is connected to the buses. Note that this method should be used to modify subsystem-defined states only. Internal Agent states (AlertState, CommandState, OperationalState, PhaseState) are managed by the Agent. This method will produce a StatusStateChangeNotification to be published on the buses only if there are state changes. This method can be invoked at any stage of HasLifecycle
    
    Parameters:
    
    stateChanges - The list of the states that have changed.
    
    Throws:
    
    IllegalArgumentException - if the list of arguments contains internal Agent states.
  - updateAgentState
```
@Deprecated
public void updateAgentState(StateBundle stateChanges)
```
    Deprecated. use AgentStateService::updateAgentState(StateBundle) instead
    
    Updates the state of this Agent and publishes StateChangeNotification message only if the Agent is connected to the buses. Note that this method should be used to modify subsystem-defined states only. Internal Agent states (AlertState, CommandState, OperationalState, PhaseState) are managed by the Agent. This method will produce a StatusStateChangeNotification to be published on the buses only if there are state changes. This method can be invoked at any stage of HasLifecycle
    
    Parameters:
    
    stateChanges - The StateBundle with all the changes.
    
    Throws:
    
    IllegalArgumentException - if the list of arguments contains internal Agent states.
  - updateAgentComponentState
```
@Deprecated
public void updateAgentComponentState(Object component,
                                                  Enum... stateChanges)
```
    Deprecated. use AgentStateService::updateAgentComponentState(Object, Enum...) instead
    
    Updates the state of this Agent and publishes StateChangeNotification message only if the Agent is connected to the buses. Note that this method should be used to modify subsystem-defined states only. Internal Agent states (AlertState, CommandState, OperationalState, PhaseState) are managed by the Agent. This method will produce a StatusStateChangeNotification to be published on the buses only if there are state changes. This method can be invoked at any stage of HasLifecycle
    
    Parameters:
    
    componentName - The name of the component to be updated
    
    stateChanges - The list of the states that have changed.
    
    Throws:
    
    IllegalArgumentException - if the list of arguments contains internal Agent states.
  - waitFor
```
@Deprecated
public final boolean waitFor(Predicate<StateBundle> target,
                                         long timeout,
                                         TimeUnit unit)
                                  throws InterruptedException
```
    Deprecated. use AgentStateService::waitFor(Predicate<StateBundle>, long, TimeUnit) instead
    
    Block until this Agent is in state that satisfies the specified predicate. The condition is not guaranteed to remain true when the thread resumes. The predicate provided to this method should not depend on anything other than its argument, and should not have side effects.
    
    Parameters:
    
    target - Condition to be satisfied for this method to return.
    
    timeout - Timeout value.
    
    unit - Timeout unit.
    
    Returns:
    
    True if the condition was satisfied; false if the method timed out.
    
    Throws:
    
    InterruptedException - if the thread is interrupted while waiting.
  - addStateChangeListener
```
@Deprecated
public void addStateChangeListener(StateChangeListener stateChangeListener,
                                               Class... states)
```
    Deprecated. use AgentStateService::addStateChangeListener(StateChangeListener, Class...) instead
  - removeStateChangeListener
```
@Deprecated
public void removeStateChangeListener(StateChangeListener stateChangeListener)
```
    Deprecated. use AgentStateService::removeStateChangeListener(StateChangeListener) instead

Class Agent

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

Field Detail

jvmShutdown

logBusHandler

commandExecutorLock

currentQueries

currentAction

currentSignals

treeComponentInitialized

stateService

AGENT_HEARTBEAT_TASK

AGENT_RUNTIMEINFO_TASK

Constructor Detail

Agent

Method Detail

preBuild

preInit

populateComponentLookup

getAgentServices

getAgentService

getComponentLookup

createHelper

helper

getAgentPeriodicTaskService

getAgentStatusAggregatorService

setAgentName

startAgent

startAgent

shutdownAgent

getLogger

getName

getAgentInfo

getScheduler

getCommandCount

getStatusBroadcastPeriod

isInEngineeringMode

getCCSVersions

getDistributionInfo

getDictionaries

getCommandTargets

printComponentNodeTree

getCommandSet

addCommandSet

addCommandsFromObject

setAgentProperty

getAgentProperty

getAgentPropertiesKeySet

getAgentProperties

getMessagingAccess

getEnvironmentMessagingAccess

getEnvironmentLockService

isConnectedToTheBuses

publishSubsystemDataOnStatusBus

broadcastStatus

updateHeartBeat

executeCommandRequest

sendNack

sendAck

getCurrentAction

getMonitor

getConfigurationService

getAlertService

getDataProviderDictionaryService

getAgentLockService

getComponentConfigurationEnvironment

getComponentConfigurationEnvironmentByName

getAgentPersistenceService

getDescription

internalCheckHardware

checkAllHardwareStopped

isInState

isInState

getState

getState