net.roboconf.messaging.client

Interface IAgentClient

All Superinterfaces:

IClient

All Known Implementing Classes:

DismissClientAgent, RabbitMqClientAgent, ReconfigurableClientAgent, TestClientAgent

public interface IAgentClient
extends IClient

A client for the agents.

Each agent must have its own and unique client.

Author:

Vincent Zurczak - Linagora

Nested Class Summary

Nested classes/interfaces inherited from interface net.roboconf.messaging.client.IClient

IClient.ListenerCommand

Method Summary

Methods

Modifier and Type	Method and Description
void	listenToExportsFromOtherAgents(IClient.ListenerCommand command, net.roboconf.core.model.beans.Instance instance) Configures the listener for the exports from other agents.
void	listenToRequestsFromOtherAgents(IClient.ListenerCommand command, net.roboconf.core.model.beans.Instance instance) Configures the listener for requests from other agents.
void	publishExports(net.roboconf.core.model.beans.Instance instance) Publishes the exports for a given instance.
void	publishExports(net.roboconf.core.model.beans.Instance instance, String facetOrComponentName) Publishes specific exports for a given instance.
void	requestExportsFromOtherAgents(net.roboconf.core.model.beans.Instance instance) Requests other agents to export their variables on the messaging server.
void	setApplicationName(String applicationName) Sets the application name.
void	setRootInstanceName(String rootInstanceName) Sets the name of the root instance associated with the agent.
void	unpublishExports(net.roboconf.core.model.beans.Instance instance) Un-publishes the exports for a given instance.

Methods inherited from interface net.roboconf.messaging.client.IClient

closeConnection, isConnected, listenToTheDm, openConnection, sendMessageToTheDm, setMessageQueue, setParameters

Method Detail

setApplicationName

void setApplicationName(String applicationName)

Sets the application name.

setRootInstanceName

void setRootInstanceName(String rootInstanceName)

Sets the name of the root instance associated with the agent.

publishExports

void publishExports(net.roboconf.core.model.beans.Instance instance)
                    throws IOException

Publishes the exports for a given instance.

This method indicates to other instances that they can use the variables exported by THIS instance.

Parameters:

instance - the instance whose exports must be published

Throws:

IOException - if something went wrong

publishExports

void publishExports(net.roboconf.core.model.beans.Instance instance,
                  String facetOrComponentName)
                    throws IOException

Publishes specific exports for a given instance.

Parameters:

instance - the instance whose exports must be published

facetOrComponentName - the prefix of the variables to publish

Throws:

IOException - if something went wrong

unpublishExports

void unpublishExports(net.roboconf.core.model.beans.Instance instance)
                      throws IOException

Un-publishes the exports for a given instance.

This method indicates to other instances that the variables exported by THIS instance cannot be used anymore.

Parameters:

instance - the instance whose exports must be published

Throws:

IOException - if something went wrong

listenToRequestsFromOtherAgents

void listenToRequestsFromOtherAgents(IClient.ListenerCommand command,
                                   net.roboconf.core.model.beans.Instance instance)
                                     throws IOException

Configures the listener for requests from other agents.

Such requests aim at asking an agent to publish its exports. The agent will do so only if it exports a variable prefixed that is required by THIS instance.

Parameters:

command - ListenerCommand#START to start listening, ListenerCommand#STOP to stop listening

instance - the instance that need exports from other agents

Throws:

IOException - if something went wrong

requestExportsFromOtherAgents

void requestExportsFromOtherAgents(net.roboconf.core.model.beans.Instance instance)
                                   throws IOException

Requests other agents to export their variables on the messaging server.

This should be called when a new instance is registered on the agent. It guarantees that any new instance can be notified about the instances located on other agents.

Parameters:

instance - the instance that need exports from other agents

Throws:

IOException - if something went wrong

listenToExportsFromOtherAgents

void listenToExportsFromOtherAgents(IClient.ListenerCommand command,
                                  net.roboconf.core.model.beans.Instance instance)
                                    throws IOException

Configures the listener for the exports from other agents.

Parameters:

command - ListenerCommand#START to start listening, ListenerCommand#STOP to stop listening

instance - the instance that determine which exports must be listened to

Throws:

IOException - if something went wrong