net.obvj.agents

Class AgentManager

java.lang.Object

net.obvj.agents.AgentManager

@Component
public class AgentManager
extends Object

A component that provides methods for Agents maintenance.

Author:

oswaldo.bapvic.jr

Constructor Summary

Constructors

Constructor and Description
AgentManager()

Method Summary

Modifier and Type	Method and Description
AbstractAgent	findAgentByName(String name) Searches and returns the agent with the specified name in this manager's scope.
Collection<AbstractAgent>	getAgents()
String	getAgentStatusStr(String name) Returns a string containing agent status information for reporting.
static AgentManager	getInstance() Returns the managed instance of this component.
boolean	isAgentRunning(String name) Returns a flag indicating whether an agent is running or not.
boolean	isAgentStarted(String name) Returns a flag indicating whether an agent is started or not.
void	removeAgent(String name) Removes an agent identified by the given name, if it is not started
void	resetAgent(String name) Creates a new instance of the agent identified by the given name.
void	runNow(String name) Posts immediate execution of the agent identified by the given name.
void	scanPackage(String basePackage) Scans the specified base package for agent candidates.
void	startAgent(String name) Starts the agent identified by the given name.
void	startAllAgents()
void	stopAgent(String name) Posts a graceful stop request for the agent identified by the given name.

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentManager

public AgentManager()

Method Detail

getInstance

public static AgentManager getInstance()

Returns the managed instance of this component.

Returns:

an instance of this AgentManager

scanPackage

public void scanPackage(String basePackage)

Scans the specified base package for agent candidates. Then, builds each agent and registers them inside this manager instance.

Parameters:

basePackage - the base package to search for agent candidates

findAgentByName

public AbstractAgent findAgentByName(String name)

Searches and returns the agent with the specified name in this manager's scope.

Parameters:

name - the agent name to search for, not null

Returns:

the agent object associated with the specified name in this manager's scope

Throws:

IllegalArgumentException - if no agent with the given name found, or if the specified string is either null or empty

removeAgent

public void removeAgent(String name)

Removes an agent identified by the given name, if it is not started

Parameters:

name - the identifier of the agent to be removed

Throws:

IllegalArgumentException - if no agent with the given name was found

IllegalStateException - if the requested agent is started

resetAgent

public void resetAgent(String name)

Creates a new instance of the agent identified by the given name.

Parameters:

name - the identifier of the agent to be reset

Throws:

IllegalArgumentException - if no agent with the given name was found

IllegalStateException - if the agent is either started or running

startAgent

public void startAgent(String name)

Starts the agent identified by the given name.

Parameters:

name - the identifier of the agent to be started

Throws:

IllegalArgumentException - if no agent with the given name was found

IllegalStateException - if the requested agent is already started

runNow

public void runNow(String name)

Posts immediate execution of the agent identified by the given name.

Parameters:

name - the identifier of the agent to be run

Throws:

IllegalArgumentException - if no agent with the given name was found

stopAgent

public void stopAgent(String name)

Posts a graceful stop request for the agent identified by the given name.

Parameters:

name - the identifier of the agent to be stopped

Throws:

IllegalArgumentException - if no agent with the given name was found

getAgents

public Collection<AbstractAgent> getAgents()

isAgentRunning

public boolean isAgentRunning(String name)

Returns a flag indicating whether an agent is running or not.

Parameters:

name - the identifier of the agent to be reset

Returns:

true if the agent is running, otherwise false

Throws:

IllegalArgumentException - if no agent with the given name was found

isAgentStarted

public boolean isAgentStarted(String name)

Returns a flag indicating whether an agent is started or not.

Parameters:

name - the identifier of the agent to be reset

Returns:

true if the agent is started, otherwise false

Throws:

IllegalArgumentException - if no agent with the given name was found

getAgentStatusStr

public String getAgentStatusStr(String name)

Returns a string containing agent status information for reporting.

Parameters:

name - the identifier of the agent to be reported

Returns:

a String containing agent status information and other metadata

Throws:

IllegalArgumentException - if no agent with the given name was found

startAllAgents

public void startAllAgents()