AgentManager

java.lang.Object
- sk.fiit.testframework.communication.agent.AgentManager

All Implemented Interfaces:

IAgentMonitorListener
```
public class AgentManager
extends Object
implements IAgentMonitorListener
```
Manages agent instances that are connected to the test framework. Handles agents that are launched externally after they connect to the test framework, and can also launch agents locally itself. Agents are represented as AgentJim objects.

A new agent is launched by calling the getAgent(int, java.lang.String, boolean) method with a uniform number and team name that aren't taken yet, with the blocking parameter set to true.

Agents that are launched locally have the advantage of having all their standard output redirected to the test framework, where it can be handled by the GUI

Field Summary

Fields
Modifier and Type	Field and Description
`private static AgentManager`	`agentManager`
`private long`	`agentWaitTime`
`private Logger`	`logger`
`private List<IAgentManagerListener>`	`managerListeners`
`private List<AgentJim>`	`orderedAgents`
`private List<Integer>`	`queuedScenePlayers`
`private Map<String,AgentJim>`	`runningAgents` Maps the agents' unique names to their agent objects.
`private Map<String,Process>`	`runningProcesses` Maps the agents' unique names to their process objects.
`private Map<Integer,Player>`	`scenePlayerMap`

Constructor Summary

Constructors
Modifier Constructor and Description

private AgentManager()

Constructors
Modifier	Constructor and Description
`private`	`AgentManager()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAgentManagerListener(IAgentManagerListener listener)`
`void`	`enqueueScenePlayer(Player p)`
`AgentJim`	`getAgent(int uniform, String team, boolean blocking)` Returns the object of an agent determined by its uniform number and team name.
`AgentJim`	`getAgentByOrder(int order)` Returns an agent determined by its position in the internal structures, or null if no such agent exists.
`int`	`getAgentCount()` Returns the number of currently managed agents
`int`	`getFreeTFTPPort(String ip)` Returns the lowest expected free port for a TFTP server on a certain IP address
`int`	`getFreeUniform(String team)` Returns the lowest expected free uniform number in the specified team.
`static AgentManager`	`getManager()` Returns the instance of this singleton class
`private void`	`readForever(String agentName, BufferedReader stream)` Handles the standard output of an agent process started by the test framework.
`void`	`receivedMessage(int uniform, String team, AgentMonitorMessage message)` Handles a message received from the agent
`void`	`removeAgent(AgentJim agent)` Removes an agent that was started by the test framework and terminates its process.
`void`	`removeAgentManagerListener(IAgentManagerListener listener)`
`void`	`setAgentWaitTime(long waitTime)`
`void`	`shutDownAgents()` Destroys all agent processes launched by the test framework
`void`	`startAgent(int uniform, String team)`
`void`	`startAgent(int uniform, String team, boolean tftp_enabled, int tftp_port)` Starts a new agent with the specified parameters

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

- Field Detail
  - logger
```
private Logger logger
```
  - agentManager
```
private static AgentManager agentManager
```
  - runningProcesses
```
private Map<String,Process> runningProcesses
```
    Maps the agents' unique names to their process objects. Only for agents launched by the test framework. The unique name consists of the agent's uniform number followed by its team name (no spaces).
  - runningAgents
```
private Map<String,AgentJim> runningAgents
```
    Maps the agents' unique names to their agent objects. The unique name consists of the agent's uniform number followed by its team name (no spaces).
    Unlike runningProcesses, this also contains agents that were launched externally.
  - orderedAgents
```
private List<AgentJim> orderedAgents
```
  - queuedScenePlayers
```
private List<Integer> queuedScenePlayers
```
  - scenePlayerMap
```
private Map<Integer,Player> scenePlayerMap
```
  - agentWaitTime
```
private long agentWaitTime
```
  - managerListeners
```
private List<IAgentManagerListener> managerListeners
```
- Constructor Detail
  - AgentManager
```
private AgentManager()
```
- Method Detail
  - getManager
```
public static AgentManager getManager()
```
    Returns the instance of this singleton class
  - getAgent
```
public AgentJim getAgent(int uniform,
                String team,
                boolean blocking)
```
    Returns the object of an agent determined by its uniform number and team name.
    
    Can also launch a new agent when blocking is set to true. That is a blocking operation which takes quite a long time (roughly 10 seconds).
    
    Parameters:
    uniform - uniform number of the agent, must be unique within a team
    team - name of the team that the agent plays for
    blocking - if true, a new agent will be started locally in case an agent with the given uniform number and team doesn't exist
    
    Returns:
    the agent's object, or null in case of an error
  - getAgentCount
```
public int getAgentCount()
```
    Returns the number of currently managed agents
  - getAgentByOrder
```
public AgentJim getAgentByOrder(int order)
```
    Returns an agent determined by its position in the internal structures, or null if no such agent exists. Useful for picking an agent out of a list (like in a combo box model).
  - receivedMessage
```
public void receivedMessage(int uniform,
                   String team,
                   AgentMonitorMessage message)
```
    Handles a message received from the agent
    
    Specified by:
    
    receivedMessage in interface IAgentMonitorListener
    
    Parameters:
    uniform - the uniform number of the agent who sent the message
    team - the team of the agent who sent the message
    message - the message's object
  - startAgent
```
public void startAgent(int uniform,
              String team)
```
  - startAgent
```
public void startAgent(int uniform,
              String team,
              boolean tftp_enabled,
              int tftp_port)
```
    Starts a new agent with the specified parameters
    
    Parameters:
    uniform - uniform number of the agent
    team - name of the agent's team
    tftp_enabled - whether to enable TFTP server on the agent
    tftp_port - port on which the agent's TFTP server should listen
  - readForever
```
private void readForever(String agentName,
               BufferedReader stream)
```
    Handles the standard output of an agent process started by the test framework.
    
    Notifies all the manager listeners about each new line of output.
    
    Parameters:
    agentName - unique identifier of the agent, which is its uniform number followed by its team name (no spaces)
    stream - input stream connected to the agent's standard output
  - removeAgent
```
public void removeAgent(AgentJim agent)
```
    Removes an agent that was started by the test framework and terminates its process. Does nothing for agents that were not launched by the test framework.
    
    TODO: send an exit command to agents not launched by the test framework
    
    Parameters:
    agent - the agent to remove
  - shutDownAgents
```
public void shutDownAgents()
```
    Destroys all agent processes launched by the test framework
  - getFreeTFTPPort
```
public int getFreeTFTPPort(String ip)
```
    Returns the lowest expected free port for a TFTP server on a certain IP address
  - getFreeUniform
```
public int getFreeUniform(String team)
```
    Returns the lowest expected free uniform number in the specified team. Assumes all agents to be managed by this test framework instance.
  - addAgentManagerListener
```
public void addAgentManagerListener(IAgentManagerListener listener)
```
  - removeAgentManagerListener
```
public void removeAgentManagerListener(IAgentManagerListener listener)
```
  - enqueueScenePlayer
```
public void enqueueScenePlayer(Player p)
```
  - setAgentWaitTime
```
public void setAgentWaitTime(long waitTime)
```

Class AgentManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

agentManager

runningProcesses

runningAgents

orderedAgents

queuedScenePlayers

scenePlayerMap

agentWaitTime

managerListeners

Constructor Detail

AgentManager

Method Detail

getManager

getAgent

getAgentCount

getAgentByOrder

receivedMessage

startAgent

startAgent

readForever

removeAgent

shutDownAgents

getFreeTFTPPort

getFreeUniform

addAgentManagerListener

removeAgentManagerListener

enqueueScenePlayer

setAgentWaitTime