agentgui.core.jade

Class Platform

java.lang.Object

agentgui.core.jade.Platform

public class Platform
extends java.lang.Object

This class manages the interaction between Agent.GUI and JADE. It provides methods to start / stop JADE, as well as methods for starting new container or agents.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Platform.RemoteStartAgentWaiter The Class RemoteStartAgentWaiter.
static class	Platform.SystemAgent The enumeration that names the system agents like the RMA and other.

Constructor Summary

Constructors

Constructor and Description
Platform() Constructor of this class.

Method Summary

Modifier and Type	Method and Description
jade.wrapper.AgentContainer	createAgentContainer(java.lang.String newContainerName) Adding an AgentContainer to the local platform.
java.util.ArrayList<jade.wrapper.AgentContainer>	getAgentContainerList() Returns the List of local agent container.
jade.wrapper.AgentContainer	getContainer(java.lang.String containerNameSearch) Returns the AgentContainer given by it's name.
jade.core.ProfileImpl	getContainerProfile() This method returns the JADE-Profile, which has to be used for the container-profiles.
jade.wrapper.AgentContainer	getMainContainer() Returns the Jade main container.
NetworkAddresses	getNetworkAddresses() Returns the currently available network addresses / IP's.
int	getSuffixNoForAgentName(java.lang.String agentName) Returns a new suffix number for the specified name of an agent.
java.util.Hashtable<Platform.SystemAgent,java.lang.String>	getSystemAgentClasses() Returns the relation of known system agents, like the rma or the sniffer, and its classes.
boolean	isAgentRunning(java.lang.String localAgentName) Checks, if the specified Agent is running (or not).
boolean	isAgentRunning(java.lang.String localAgentName, jade.wrapper.AgentContainer agentContainer) Checks, whether one Agent is running (or not) in the specified container.
boolean	isAgentRunning(java.lang.String localAgentName, java.lang.String localContainerName) Checks, whether one Agent is running (or not) in the specified container
boolean	isAgentRunningInMainContainer(java.lang.String localAgentName) Checks, whether one Agent is running (or not) in the main-container.
boolean	isMainContainerRunning() Jade main container is running.
boolean	isMainContainerRunning(boolean forceJadeStart) Checks, whether the main-container (Jade himself) is running or not.
void	killAgentInMainContainer(java.lang.String localAgentName) Kills an agent in the MainContainer, if it is running.
void	killContainer(java.lang.String containerName) Kills an AgentContainer to the local platform.
boolean	start() Starts JADE without displaying the RMA
boolean	start(boolean showRMA) Starts JADE.
boolean	start(boolean showRMA, jade.core.Profile containerProfile) Starts JADE.
boolean	start4EmbeddedSystemAgent() Start JADE for a globally specified embedded system agent.
boolean	start4EmbeddedSystemAgent(java.lang.String agentName, java.lang.String agentClassName) Start JADE for a specified embedded system agent.
void	startAgent(java.lang.String agentName, java.lang.Class<? extends jade.core.Agent> agentClass, java.lang.Object[] startArguments, java.lang.String inContainer) Starts an agent as specified
void	startAgent(java.lang.String agentName, java.lang.String agentClassName) Adding an Agent to a Container.
void	startAgent(java.lang.String agentName, java.lang.String agentClassName, java.lang.Object[] startArguments) Starts an agent as specified
void	startAgent(java.lang.String agentName, java.lang.String agentClassName, java.lang.Object[] startArguments, java.lang.String inContainer) Starts an agent as specified
void	startAgent(java.lang.String agentName, java.lang.String agentClassName, java.lang.String inContainer) Starts an agent as specified
void	startSystemAgent(Platform.SystemAgent systemAgentToStart, java.lang.Integer optionalSuffixNo) Starts an Agent, if the main-container exists.
void	startSystemAgent(Platform.SystemAgent systemAgentToStart, java.lang.Integer optionalSuffixNo, java.lang.Object[] openArgs) Starts agents that are available by JADE or Agent.Workbench like the rma, sniffer etc.
void	startUtilityAgent(java.lang.Object[] utilityAgentStartArguments) Starts the Utility-Agent with the specified start arguments.
void	startUtilityAgent(UtilityAgent.UtilityAgentJob utilityAgentJob) Starts the Utility-Agent with a job defined in its start argument.
void	stop() Shutting down the jade-platform.
boolean	stopAskUserBefore() Asks the user to shutdown Jade.

Methods inherited from class java.lang.Object

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

Constructor Detail

Platform

public Platform()

Constructor of this class.

Method Detail

getNetworkAddresses

public NetworkAddresses getNetworkAddresses()

Returns the currently available network addresses / IP's.

Returns:

the network addresses

start

public boolean start()

Starts JADE without displaying the RMA

Returns:

true, if successful

start

public boolean start(boolean showRMA)

Starts JADE.

Parameters:

showRMA - set true, if you want also to start the RMA agent and its visualization

Returns:

true, if successful

start

public boolean start(boolean showRMA,
                     jade.core.Profile containerProfile)

Starts JADE.

Parameters:

showRMA - set true, if you want also to start the RMA agent and its visualization

containerProfile - the actual container Profile

Returns:

true, if successful

start4EmbeddedSystemAgent

public boolean start4EmbeddedSystemAgent()

Start JADE for a globally specified embedded system agent.

Returns:

true, if the start was successful for every agent

start4EmbeddedSystemAgent

public boolean start4EmbeddedSystemAgent(java.lang.String agentName,
                                         java.lang.String agentClassName)

Start JADE for a specified embedded system agent.

Parameters:

defaultAgentName - the agents name

agentClassName - the agent class name

Returns:

true, if successful

getContainerProfile

public jade.core.ProfileImpl getContainerProfile()

This method returns the JADE-Profile, which has to be used for the container-profiles. If a project is focused the specific project-configuration will be used. Otherwise the default-configuration of AgentGUI will be used.

Returns:

Profile (for Jade-Containers)

stop

public void stop()

Shutting down the jade-platform.

stopAskUserBefore

public boolean stopAskUserBefore()

Asks the user to shutdown Jade.

Returns:

true, if the user answered 'yes'

isMainContainerRunning

public boolean isMainContainerRunning(boolean forceJadeStart)

Checks, whether the main-container (Jade himself) is running or not.

Parameters:

forceJadeStart - will force the jade start, if JADE is not running

Returns:

true, if the MainContainer is running

isMainContainerRunning

public boolean isMainContainerRunning()

Jade main container is running.

Returns:

true, if the Main-Container is running

startUtilityAgent

public void startUtilityAgent(UtilityAgent.UtilityAgentJob utilityAgentJob)

Starts the Utility-Agent with a job defined in its start argument.

Parameters:

utilityAgentJob - the job for the utility UtilityAgent to do

See Also:

UtilityAgent.UtilityAgentJob, UtilityAgent

startUtilityAgent

public void startUtilityAgent(java.lang.Object[] utilityAgentStartArguments)

Starts the Utility-Agent with the specified start arguments.

Parameters:

utilityAgentStartArguments - the utility agent start arguments

startSystemAgent

public void startSystemAgent(Platform.SystemAgent systemAgentToStart,
                             java.lang.Integer optionalSuffixNo)

Starts an Agent, if the main-container exists.

Parameters:

systemAgentToStart - the system agent to start

optionalSuffixNo - the optional postfix no

startSystemAgent

public void startSystemAgent(Platform.SystemAgent systemAgentToStart,
                             java.lang.Integer optionalSuffixNo,
                             java.lang.Object[] openArgs)

Starts agents that are available by JADE or Agent.Workbench like the rma, sniffer etc.

Parameters:

systemAgentToStart - the system agent to start

optionalSuffixNo - an optional postfix no

openArgs - the open arguments

getSystemAgentClasses

public java.util.Hashtable<Platform.SystemAgent,java.lang.String> getSystemAgentClasses()

Returns the relation of known system agents, like the rma or the sniffer, and its classes.

Returns:

the system agent descriptions

getSuffixNoForAgentName

public int getSuffixNoForAgentName(java.lang.String agentName)

Returns a new suffix number for the specified name of an agent.

Parameters:

defaultAgentName - the agent name

Returns:

the integer

killAgentInMainContainer

public void killAgentInMainContainer(java.lang.String localAgentName)

Kills an agent in the MainContainer, if it is running.

Parameters:

localAgentName - the agent name

isAgentRunningInMainContainer

public boolean isAgentRunningInMainContainer(java.lang.String localAgentName)

Checks, whether one Agent is running (or not) in the main-container.

Parameters:

localAgentName - the agent name

Returns:

true, if the agent is running

isAgentRunning

public boolean isAgentRunning(java.lang.String localAgentName)

Checks, if the specified Agent is running (or not).

Parameters:

localAgentName - the agent name

Returns:

true, if the agent is running

isAgentRunning

public boolean isAgentRunning(java.lang.String localAgentName,
                              java.lang.String localContainerName)

Checks, whether one Agent is running (or not) in the specified container

Parameters:

localAgentName - the agent name

localContainerName - the local container name

Returns:

true, if the agent is running

isAgentRunning

public boolean isAgentRunning(java.lang.String localAgentName,
                              jade.wrapper.AgentContainer agentContainer)

Checks, whether one Agent is running (or not) in the specified container.

Parameters:

localAgentName - the agent name

agentContainer - the agent container

Returns:

true, if the agent is running

getMainContainer

public jade.wrapper.AgentContainer getMainContainer()

Returns the Jade main container.

Returns:

the agent container

createAgentContainer

public jade.wrapper.AgentContainer createAgentContainer(java.lang.String newContainerName)

Adding an AgentContainer to the local platform.

Parameters:

newContainerName - the container name

Returns:

the agent container

getAgentContainerList

public java.util.ArrayList<jade.wrapper.AgentContainer> getAgentContainerList()

Returns the List of local agent container.

Returns:

the agent container local

getContainer

public jade.wrapper.AgentContainer getContainer(java.lang.String containerNameSearch)

Returns the AgentContainer given by it's name.

Parameters:

containerNameSearch - the container name search

Returns:

the agent container

killContainer

public void killContainer(java.lang.String containerName)

Kills an AgentContainer to the local platform.

Parameters:

containerName - the container name

startAgent

public void startAgent(java.lang.String agentName,
                       java.lang.String agentClassName)

Adding an Agent to a Container.

Parameters:

defaultAgentName - the agent name

agentClassName - the agent class name

startAgent

public void startAgent(java.lang.String agentName,
                       java.lang.String agentClassName,
                       java.lang.String inContainer)

Starts an agent as specified

Parameters:

defaultAgentName - the agent name

agentClassName - the agent class name

inContainer - the container name

startAgent

public void startAgent(java.lang.String agentName,
                       java.lang.String agentClassName,
                       java.lang.Object[] startArguments)

Starts an agent as specified

Parameters:

defaultAgentName - the agent name

agentClassName - the agent class name

startArguments - the start arguments for the agent

startAgent

public void startAgent(java.lang.String agentName,
                       java.lang.String agentClassName,
                       java.lang.Object[] startArguments,
                       java.lang.String inContainer)

Starts an agent as specified

Parameters:

defaultAgentName - the agent name

agentClassName - the agent class name

startArguments - the start arguments for the agent

inContainer - the container name

startAgent

public void startAgent(java.lang.String agentName,
                       java.lang.Class<? extends jade.core.Agent> agentClass,
                       java.lang.Object[] startArguments,
                       java.lang.String inContainer)

Starts an agent as specified

Parameters:

defaultAgentName - the agent name

agentClass - the class of the agent

startArguments - the start arguments for the agent

inContainer - the container name