org.arl.fjage.remote

Class MasterContainer

java.lang.Object

org.arl.fjage.Container

org.arl.fjage.remote.MasterContainer

All Implemented Interfaces:

ConnectionListener

public class MasterContainer
extends Container
implements ConnectionListener

Master container supporting multiple remote slave containers. Agents in linked master and slave containers function as if they were in the same container, i.e., are able to communicate with each other through messaging, topics and directory services.

Field Summary

Fields inherited from class org.arl.fjage.Container

agents, agentsToAdd, autoclone, cloner, doClone, FAST_CLONER, idle, inited, initing, listeners, log, name, platform, running, SERIAL_CLONER, services, topics

Constructor Summary

Constructors

Constructor and Description
MasterContainer(Platform platform) Creates a master container, runs its TCP server on an automatically selected port.
MasterContainer(Platform platform, int port) Creates a master container, runs its TCP server on a specified port.
MasterContainer(Platform platform, int port, java.util.function.Supplier<Firewall> fwSupplier) Creates a master container, runs its TCP server on a specified port, with a specified firewall supplier.
MasterContainer(Platform platform, java.lang.String name) Creates a named master container, runs its TCP server on an automatically selected port.
MasterContainer(Platform platform, java.lang.String name, int port) Creates a named master container, runs its TCP server on a specified port.
MasterContainer(Platform platform, java.lang.String name, int port, java.util.function.Supplier<Firewall> fwSupplier) Creates a named master container, runs its TCP server on a specified port, with a specified firewall supplier.
MasterContainer(Platform platform, java.lang.String name, java.util.function.Supplier<Firewall> fwSupplier) Creates a named master container, runs its TCP server on an automatically selected port, with a specified firewall supplier.
MasterContainer(Platform platform, java.util.function.Supplier<Firewall> fwSupplier) Creates a master container, runs its TCP server on an automatically selected port, with a specified firewall supplier.

Method Summary

Modifier and Type	Method and Description
void	addConnector(Connector conn) Adds a connector over which the master container listens.
void	addConnector(Connector conn, Firewall fw) Adds a connector over which the master container listens, but with a custom firewall for that connector.
AgentID	agentForService(java.lang.String service) Finds an agent providing a named service.
AgentID[]	agentsForService(java.lang.String service) Gets the agent IDs of all agents that provide a given service.
boolean	closeWebSocketServer()
void	connected(Connector conn)
void	connectionClosed(ConnectionHandler handler) Callback for closure of connection to remote container.
AgentID[]	getAgents() Gets all agent ids in the container.
ConnectionHandler[]	getConnectionHandlers() Gets a list of connection handlers for the slaves connected to this master container.
java.lang.String[]	getConnectors() Gets a list of connector URLs that slaves can use to access the master container.
int	getPort() Gets the TCP port on which the master container listens for connections.
java.lang.String[]	getServices() Gets a list of all services that agents in this container provide.
protected void	initComplete() Called when the container is initialized.
protected boolean	isDuplicate(AgentID aid) Checks if an agent id already exists in the container.
boolean	openWebSocketServer(int port, java.lang.String context) Opens a WebSocket server at the given context on the web server running on a port.
boolean	openWebSocketServer(int port, java.lang.String context, int maxMsgSize) Opens a WebSocket server at the given context on the web server running on a port.
boolean	send(Message m) Sends a message.
boolean	send(Message m, boolean relay) Sends a message.
void	shutdown() Terminates the container and all agents in it.
java.lang.String	toString() Gets a string representation of the container.

Methods inherited from class org.arl.fjage.Container

add, add, addListener, canLocateAgent, clone, containsAgent, deregister, deregister, getAgent, getAutoClone, getName, getPlatform, getState, isIdle, isRunning, kill, kill, register, removeListener, setAutoClone, setCloner, setName, start, subscribe, unsubscribe, unsubscribe

Methods inherited from class java.lang.Object

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

Constructor Detail

MasterContainer

public MasterContainer(Platform platform)

Creates a master container, runs its TCP server on an automatically selected port.

Parameters:

platform - platform on which the container runs.

MasterContainer

public MasterContainer(Platform platform,
                       java.util.function.Supplier<Firewall> fwSupplier)

Creates a master container, runs its TCP server on an automatically selected port, with a specified firewall supplier.

Parameters:

platform - platform on which the container runs.

fwSupplier - firewall supplier to use.

MasterContainer

public MasterContainer(Platform platform,
                       int port)

Creates a master container, runs its TCP server on a specified port.

Parameters:

platform - platform on which the container runs.

port - port on which the container's TCP server runs.

MasterContainer

public MasterContainer(Platform platform,
                       int port,
                       java.util.function.Supplier<Firewall> fwSupplier)

Creates a master container, runs its TCP server on a specified port, with a specified firewall supplier.

Parameters:

platform - platform on which the container runs.

port - port on which the container's TCP server runs.

fwSupplier - firewall supplier to use.

MasterContainer

public MasterContainer(Platform platform,
                       java.lang.String name)

Creates a named master container, runs its TCP server on an automatically selected port.

Parameters:

platform - platform on which the container runs.

name - name of the container.

MasterContainer

public MasterContainer(Platform platform,
                       java.lang.String name,
                       java.util.function.Supplier<Firewall> fwSupplier)

Creates a named master container, runs its TCP server on an automatically selected port, with a specified firewall supplier.

Parameters:

platform - platform on which the container runs.

name - name of the container.

fwSupplier - firewall supplier to use.

MasterContainer

public MasterContainer(Platform platform,
                       java.lang.String name,
                       int port)

Creates a named master container, runs its TCP server on a specified port.

Parameters:

platform - platform on which the container runs.

name - of the container.

port - port on which the container's TCP server runs.

MasterContainer

public MasterContainer(Platform platform,
                       java.lang.String name,
                       int port,
                       java.util.function.Supplier<Firewall> fwSupplier)

Creates a named master container, runs its TCP server on a specified port, with a specified firewall supplier.

Parameters:

platform - platform on which the container runs.

name - of the container.

port - port on which the container's TCP server runs.

fwSupplier - firewall supplier to use.

Method Detail

getPort

public int getPort()

Gets the TCP port on which the master container listens for connections.

Returns:

port on which the container's TCP server runs, -1 if none.

addConnector

public void addConnector(Connector conn)

Adds a connector over which the master container listens. The connector uses a firewall acquired from the firewall supplier configured for the container.

Parameters:

conn - connector.

addConnector

public void addConnector(Connector conn,
                         Firewall fw)

Adds a connector over which the master container listens, but with a custom firewall for that connector.

Parameters:

conn - connector.

fw - firewall.

getConnectors

public java.lang.String[] getConnectors()

Gets a list of connector URLs that slaves can use to access the master container.

getConnectionHandlers

public ConnectionHandler[] getConnectionHandlers()

Gets a list of connection handlers for the slaves connected to this master container.

Returns:

array of connection handlers.

isDuplicate

protected boolean isDuplicate(AgentID aid)

Description copied from class: Container

Checks if an agent id already exists in the container.

Overrides:

isDuplicate in class Container

Parameters:

aid - the agent id to check.

Returns:

true if it exists, false otherwise.

send

public boolean send(Message m)

Description copied from class: Container

Sends a message. The message is sent to the recipient specified in the message. In case of associated remote containers, the message is only delivered to agents in this container.

Overrides:

send in class Container

Parameters:

m - message to deliver

Returns:

true if delivered, false otherwise.

send

public boolean send(Message m,
                    boolean relay)

Description copied from class: Container

Sends a message. The message is sent to the recipient specified in the message.

Overrides:

send in class Container

Parameters:

m - message to deliver

relay - enable relaying to associated remote containers.

Returns:

true if delivered, false otherwise.

getAgents

public AgentID[] getAgents()

Description copied from class: Container

Gets all agent ids in the container.

Overrides:

getAgents in class Container

Returns:

an array of agent ids.

getServices

public java.lang.String[] getServices()

Description copied from class: Container

Gets a list of all services that agents in this container provide.

Overrides:

getServices in class Container

Returns:

an array of service names.

agentForService

public AgentID agentForService(java.lang.String service)

Description copied from class: Container

Finds an agent providing a named service.

Overrides:

agentForService in class Container

Parameters:

service - name of the service.

Returns:

agent id for service provider, null if none found.

agentsForService

public AgentID[] agentsForService(java.lang.String service)

Gets the agent IDs of all agents that provide a given service.

Overrides:

agentsForService in class Container

Parameters:

service - name of the service.

Returns:

array of agent IDs, empty if no agents provide the service.

initComplete

protected void initComplete()

Description copied from class: Container

Called when the container is initialized. This is called after all agents have been initialized.

Overrides:

initComplete in class Container

shutdown

public void shutdown()

Description copied from class: Container

Terminates the container and all agents in it.

Overrides:

shutdown in class Container

toString

public java.lang.String toString()

Description copied from class: Container

Gets a string representation of the container.

Overrides:

toString in class Container

Returns:

string representation of the container.

See Also:

Object.toString()

connectionClosed

public void connectionClosed(ConnectionHandler handler)

Callback for closure of connection to remote container.

Parameters:

handler - indicates the connection that is closed.

openWebSocketServer

public boolean openWebSocketServer(int port,
                                   java.lang.String context)

Opens a WebSocket server at the given context on the web server running on a port. If a web server isn't already created, this will start the web server.

Parameters:

port - web server port.

context - context path for the WebSocket server.

Returns:

true if opened, false if already open, the web server cannot be started, or the context is already in use.

openWebSocketServer

public boolean openWebSocketServer(int port,
                                   java.lang.String context,
                                   int maxMsgSize)

Opens a WebSocket server at the given context on the web server running on a port. If a web server isn't already created, this will start the web server.

Parameters:

port - web server port.

context - context path for the WebSocket server.

maxMsgSize - maximum text message size, or -1 for the default.

Returns:

true if opened, false if already open, the web server cannot be started, or the context is already in use.

closeWebSocketServer

public boolean closeWebSocketServer()

connected

public void connected(Connector conn)

Specified by:

connected in interface ConnectionListener