AgentInfo (LSST CCS - Buses Definition 5.3.22 API)

java.lang.Object
- org.lsst.ccs.bus.data.AgentInfo

All Implemented Interfaces:

Serializable
```
public final class AgentInfo
extends Object
implements Serializable
```
A class to encapsulate an agent's name and type. This class is used to represent an Agent across the buses. The Agent's name is its unique name on the Buses. Its type defines its role on the buses. Two AgentInfo instances are considered equal if they have the same name and type. When two AgentInfo instances are equal, they represent the same Agent on the buses.

Author:

emarin

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AgentInfo.AgentType
Enumeration of known agent types.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AgentInfo.AgentType` Enumeration of known agent types.

Field Summary

Fields
Modifier and Type Field and Description

static String AGENT_JXM_PORT_PROP

static String AGENT_NAME_PROP

static String AGENT_TYPE_PROP

Fields
Modifier and Type	Field and Description
`static String`	`AGENT_JXM_PORT_PROP`
`static String`	`AGENT_NAME_PROP`
`static String`	`AGENT_TYPE_PROP`

Constructor Summary

Constructors
Constructor and Description
`AgentInfo(String name, AgentInfo.AgentType type)` The base constructor of an AgentInfo.
`AgentInfo(String name, AgentInfo.AgentType type, Properties agentProps)` The base constructor of an AgentInfo.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object a)`
`org.lsst.ccs.utilities.taitime.CCSTimeStamp`	`getAgentJoinedTheBusesTime()` Get the time the Agent joined the buses.
`org.lsst.ccs.utilities.taitime.CCSTimeStamp`	`getAgentOperationalTime()` Get the time the Agent went operational.
`Properties`	`getAgentProperties()` Get the Properties for this AgentInfo.
`String`	`getAgentProperty(String property)` Get the value of the property for this Agent.
`String`	`getAgentProperty(String property, String def)` Get the value of the property for this Agent.
`org.lsst.ccs.utilities.taitime.CCSTimeStamp`	`getAgentStartTime()` Get the CCSTimeStamp corresponding to the time this Agent was started.
`String`	`getName()` The Agent's name on the Buses.
`AgentInfo.AgentType`	`getType()` The Agent's AgentType.
`boolean`	`hasAgentProperty(String property)` Check if a given property is set for this Agent.
`int`	`hashCode()`
`boolean`	`isAgentWorkerOrService()` Utility method to decide this AgentInfo belongs to a WORKER or a Service agent
`boolean`	`isGraphicalConsole()` Return true if this is a graphical console;
`boolean`	`isScriptingConsole()` Return true if this is a scripting console.
`void`	`setAgentJoinedTheBusesTime()` Public method to set the time the Agent became Joined The Buses.
`void`	`setAgentOperationalTime()` Public method to set the time the Agent became OPERATIONAL.
`String`	`toString()`

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

- Field Detail
  - AGENT_NAME_PROP
```
public static final String AGENT_NAME_PROP
```
    See Also:
    
    Constant Field Values
  - AGENT_TYPE_PROP
```
public static final String AGENT_TYPE_PROP
```
    See Also:
    
    Constant Field Values
  - AGENT_JXM_PORT_PROP
```
public static final String AGENT_JXM_PORT_PROP
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AgentInfo
```
public AgentInfo(String name,
                 AgentInfo.AgentType type)
```
    The base constructor of an AgentInfo. It takes the Agent's name and its AgentType.
    
    Parameters:
    
    name - The name of the Agent as defined on the Buses.
    
    type - The AgentType of the Agent. This determines its role.
  - AgentInfo
```
public AgentInfo(String name,
                 AgentInfo.AgentType type,
                 Properties agentProps)
```
    The base constructor of an AgentInfo. It takes the Agent's name and its AgentType.
    
    Parameters:
    
    name - The name of the Agent as defined on the Buses.
    
    type - The AgentType of the Agent. This determines its role.
    
    agentProps - A set of properties for this agent.
- Method Detail
  - getName
```
public String getName()
```
    The Agent's name on the Buses. This must be unique.
    
    Returns:
    
    The name of the Agent on the Buses.
  - getType
```
public AgentInfo.AgentType getType()
```
    The Agent's AgentType. This represents its role on the buses.
    
    Returns:
    
    The AgentType of the Agent.
  - getAgentProperty
```
public String getAgentProperty(String property)
```
    Get the value of the property for this Agent. null is returned if the given property is not defined.
    
    Parameters:
    
    property - The name of the property to retrieve.
    
    Returns:
    
    The value of the Agent property. null if the given property is not set.
  - getAgentProperty
```
public String getAgentProperty(String property,
                               String def)
```
    Get the value of the property for this Agent. null is returned if the given property is not defined.
    
    Parameters:
    
    property - The name of the property to retrieve.
    
    def - The default value to return.
    
    Returns:
    
    The value of the Agent property. The value of the def parameter if the given property is not set.
  - hasAgentProperty
```
public boolean hasAgentProperty(String property)
```
    Check if a given property is set for this Agent.
    
    Parameters:
    
    property - The name of the property to check.
    
    Returns:
    
    true if the property is set for this Agent. false otherwise.
  - getAgentProperties
```
public Properties getAgentProperties()
```
    Get the Properties for this AgentInfo. This method is temporary and should not be used to change Agent Properties. It should only be used by the AgentPropertiesService.
    
    Returns:
    
    the AgentInfo Properties object.
  - getAgentStartTime
```
public org.lsst.ccs.utilities.taitime.CCSTimeStamp getAgentStartTime()
```
    Get the CCSTimeStamp corresponding to the time this Agent was started. NOTE: this timestamp can be null for AgentInfo objects sent across the buses that still don't have this field defined. Client code using this method should protect against null until all the agents on the cluster have been updated to a newer version of the toolkit.
    
    Returns:
  - setAgentOperationalTime
```
public final void setAgentOperationalTime()
```
    Public method to set the time the Agent became OPERATIONAL. This method is meant to be used by the Agent class right before going into OPERATIONAL state.
  - getAgentOperationalTime
```
public final org.lsst.ccs.utilities.taitime.CCSTimeStamp getAgentOperationalTime()
```
    Get the time the Agent went operational. For compatibility with older versions if the operational time has not been set we return the startTime padded by 3 minutes.
  - setAgentJoinedTheBusesTime
```
public final void setAgentJoinedTheBusesTime()
```
    Public method to set the time the Agent became Joined The Buses. This method is meant to be used by the Agent class right after the Agent has joined the buses.
  - getAgentJoinedTheBusesTime
```
public final org.lsst.ccs.utilities.taitime.CCSTimeStamp getAgentJoinedTheBusesTime()
```
    Get the time the Agent joined the buses. For compatibility with older versions if the time it joined the buses has not been set we return the Operational Time.
  - isAgentWorkerOrService
```
public boolean isAgentWorkerOrService()
```
    Utility method to decide this AgentInfo belongs to a WORKER or a Service agent
    
    Returns:
    
    true if the type is equal or above WORKER.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object a)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isScriptingConsole
```
public boolean isScriptingConsole()
```
    Return true if this is a scripting console.
  - isGraphicalConsole
```
public boolean isGraphicalConsole()
```
    Return true if this is a graphical console;

Class AgentInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AGENT_NAME_PROP

AGENT_TYPE_PROP

AGENT_JXM_PORT_PROP

Constructor Detail

AgentInfo

AgentInfo

Method Detail

getName

getType

getAgentProperty

getAgentProperty

hasAgentProperty

getAgentProperties

getAgentStartTime

setAgentOperationalTime

getAgentOperationalTime

setAgentJoinedTheBusesTime

getAgentJoinedTheBusesTime

isAgentWorkerOrService

toString

equals

hashCode

isScriptingConsole

isGraphicalConsole