net.roboconf.messaging.reconfigurables

Class ReconfigurableClientAgent

java.lang.Object

net.roboconf.messaging.reconfigurables.ReconfigurableClient<IAgentClient>

net.roboconf.messaging.reconfigurables.ReconfigurableClientAgent

All Implemented Interfaces:

IAgentClient, IClient

public class ReconfigurableClientAgent
extends ReconfigurableClient<IAgentClient>
implements IAgentClient

Author:

Vincent Zurczak - Linagora

Nested Class Summary

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

IClient.ListenerCommand

Constructor Summary

Constructors

Constructor and Description
ReconfigurableClientAgent()

Method Summary

Methods

Modifier and Type	Method and Description
void	closeConnection() Closes the connection with the message server.
protected void	configureMessageProcessor(AbstractMessageProcessor<IAgentClient> messageProcessor) Configures the message processor.
protected IAgentClient	createNewMessagingClient(String messageServerIp, String messageServerUser, String messageServerPwd, String factoryName) Creates a new messaging client and opens a connection with the messaging server.
protected IAgentClient	getDismissedClient()
boolean	isConnected()
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	listenToTheDm(IClient.ListenerCommand command) Configures the listener for messages from the DM.
void	openConnection() Opens a connection with the message server.
protected void	openConnection(IAgentClient newMessagingClient) Configures a newly created client.
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	sendMessageToTheDm(Message message) Sends a message to the DM.
void	setApplicationName(String applicationName) Sets the application name.
void	setIpAddress(String ipAddress)
void	setMessageQueue(LinkedBlockingQueue<Message> messageQueue) Sets the message queue where the client can store the messages to process.
void	setNeedsModel(boolean needsModel)
void	setParameters(String messageServerIp, String messageServerUsername, String messageServerPassword) Sets the connection parameters.
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 class net.roboconf.messaging.reconfigurables.ReconfigurableClient

associateMessageProcessor, getMessageProcessor, getMessagingClient, hasValidClient, resetInternalClient, switchMessagingClient

Methods inherited from class java.lang.Object

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

Constructor Detail

ReconfigurableClientAgent

public ReconfigurableClientAgent()

Method Detail

createNewMessagingClient

protected IAgentClient createNewMessagingClient(String messageServerIp,
                                    String messageServerUser,
                                    String messageServerPwd,
                                    String factoryName)
                                         throws IOException

Description copied from class: ReconfigurableClient

Creates a new messaging client and opens a connection with the messaging server.

Specified by:

createNewMessagingClient in class ReconfigurableClient<IAgentClient>

Parameters:

messageServerIp - the server's IP

messageServerUser - the server's user name

messageServerPwd - the server's password

factoryName - the factory name (see MessagingConstants)

Returns:

a new messaging client

Throws:

IOException - if something went wrong

openConnection

protected void openConnection(IAgentClient newMessagingClient)
                       throws IOException

Description copied from class: ReconfigurableClient

Configures a newly created client.

For an agent, it consists into listening to messages coming from the DM.

For the DM, it consists in listening to messages coming from various agents.

Specified by:

openConnection in class ReconfigurableClient<IAgentClient>

Parameters:

newMessagingClient - the messaging client to configure

Throws:

IOException - if something went wrong

getDismissedClient

protected IAgentClient getDismissedClient()

Specified by:

getDismissedClient in class ReconfigurableClient<IAgentClient>

Returns:

a dismiss client for the case where the internal client is null

configureMessageProcessor

protected void configureMessageProcessor(AbstractMessageProcessor<IAgentClient> messageProcessor)

Description copied from class: ReconfigurableClient

Configures the message processor.

Specified by:

configureMessageProcessor in class ReconfigurableClient<IAgentClient>

Parameters:

messageProcessor - the message processor

setParameters

public void setParameters(String messageServerIp,
                 String messageServerUsername,
                 String messageServerPassword)

Description copied from interface: IClient

Sets the connection parameters.

Specified by:

setParameters in interface IClient

Parameters:

messageServerIp - the IP address of the messaging server

messageServerUsername - the user name to connect to the server

messageServerPassword - the password to connect to the server

setMessageQueue

public void setMessageQueue(LinkedBlockingQueue<Message> messageQueue)

Description copied from interface: IClient

Sets the message queue where the client can store the messages to process.

Specified by:

setMessageQueue in interface IClient

Parameters:

messageQueue - the message queue

isConnected

public boolean isConnected()

Specified by:

isConnected in interface IClient

Returns:

true if the client is connected, false otherwise

openConnection

public void openConnection()
                    throws IOException

Description copied from interface: IClient

Opens a connection with the message server.

Specified by:

openConnection in interface IClient

Throws:

IOException

closeConnection

public void closeConnection()
                     throws IOException

Description copied from interface: IClient

Closes the connection with the message server.

There is no need to check IClient.isConnected() before invoking this method.

Specified by:

closeConnection in interface IClient

Throws:

IOException

publishExports

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

Description copied from interface: IAgentClient

Publishes the exports for a given instance.

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

Specified by:

publishExports in interface IAgentClient

Parameters:

instance - the instance whose exports must be published

Throws:

IOException - if something went wrong

publishExports

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

Description copied from interface: IAgentClient

Publishes specific exports for a given instance.

Specified by:

publishExports in interface IAgentClient

Parameters:

instance - the instance whose exports must be published

facetOrComponentName - the prefix of the variables to publish

Throws:

IOException - if something went wrong

unpublishExports

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

Description copied from interface: IAgentClient

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.

Specified by:

unpublishExports in interface IAgentClient

Parameters:

instance - the instance whose exports must be published

Throws:

IOException - if something went wrong

listenToRequestsFromOtherAgents

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

Description copied from interface: IAgentClient

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.

Specified by:

listenToRequestsFromOtherAgents in interface IAgentClient

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

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

Description copied from interface: IAgentClient

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.

Specified by:

requestExportsFromOtherAgents in interface IAgentClient

Parameters:

instance - the instance that need exports from other agents

Throws:

IOException - if something went wrong

listenToExportsFromOtherAgents

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

Description copied from interface: IAgentClient

Configures the listener for the exports from other agents.

Specified by:

listenToExportsFromOtherAgents in interface IAgentClient

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

sendMessageToTheDm

public void sendMessageToTheDm(Message message)
                        throws IOException

Description copied from interface: IClient

Sends a message to the DM.

Specified by:

sendMessageToTheDm in interface IClient

Parameters:

message - the message to send

Throws:

IOException - if something went wrong

listenToTheDm

public void listenToTheDm(IClient.ListenerCommand command)
                   throws IOException

Description copied from interface: IClient

Configures the listener for messages from the DM.

Specified by:

listenToTheDm in interface IClient

Parameters:

command - IClient.ListenerCommand.START to stop listening, IClient.ListenerCommand.STOP to stop listening

Throws:

IOException - if something went wrong

setApplicationName

public void setApplicationName(String applicationName)

Description copied from interface: IAgentClient

Sets the application name.

Specified by:

setApplicationName in interface IAgentClient

setRootInstanceName

public void setRootInstanceName(String rootInstanceName)

Description copied from interface: IAgentClient

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

Specified by:

setRootInstanceName in interface IAgentClient

setIpAddress

public void setIpAddress(String ipAddress)

setNeedsModel

public void setNeedsModel(boolean needsModel)