net.roboconf.messaging.reconfigurables

Class ReconfigurableClientDm

java.lang.Object

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

net.roboconf.messaging.reconfigurables.ReconfigurableClientDm

All Implemented Interfaces:

IClient, IDmClient

public class ReconfigurableClientDm
extends ReconfigurableClient<IDmClient>
implements IDmClient

Author:

Vincent Zurczak - Linagora, Pierre Bourret - Université Joseph Fourier

Nested Class Summary

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

IClient.ListenerCommand

Constructor Summary

Constructors

Constructor and Description
ReconfigurableClientDm()

Method Summary

Methods

Modifier and Type	Method and Description
void	closeConnection() Closes the connection with the message server.
protected void	configureMessageProcessor(AbstractMessageProcessor<IDmClient> messageProcessor) Configures the message processor.
protected IDmClient	createNewMessagingClient(String messageServerIp, String messageServerUser, String messageServerPwd, String factoryName) Creates a new messaging client and opens a connection with the messaging server.
void	deleteMessagingServerArtifacts(net.roboconf.core.model.beans.Application application) Deletes all the server artifacts related to this application.
protected IDmClient	getDismissedClient()
boolean	isConnected()
void	listenToAgentMessages(net.roboconf.core.model.beans.Application application, IClient.ListenerCommand command) Configures the listener for messages sent by 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(IDmClient newMessagingClient) Configures a newly created client.
void	propagateAgentTermination(net.roboconf.core.model.beans.Application application, net.roboconf.core.model.beans.Instance rootInstance) Propagates to all the agents the fact that a given agent is not here anymore.
void	sendMessageToAgent(net.roboconf.core.model.beans.Application application, net.roboconf.core.model.beans.Instance instance, Message message) Sends a message to an agent.
void	sendMessageToTheDm(Message msg) Sends a message to the DM.
void	setMessageQueue(LinkedBlockingQueue<Message> messageQueue) Sets the message queue where the client can store the messages to process.
void	setParameters(String messageServerIp, String messageServerUsername, String messageServerPassword) Sets the connection parameters.

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

ReconfigurableClientDm

public ReconfigurableClientDm()

Method Detail

createNewMessagingClient

protected IDmClient 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<IDmClient>

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(IDmClient 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<IDmClient>

Parameters:

newMessagingClient - the messaging client to configure

Throws:

IOException - if something went wrong

getDismissedClient

protected IDmClient getDismissedClient()

Specified by:

getDismissedClient in class ReconfigurableClient<IDmClient>

Returns:

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

configureMessageProcessor

protected void configureMessageProcessor(AbstractMessageProcessor<IDmClient> messageProcessor)

Description copied from class: ReconfigurableClient

Configures the message processor.

Specified by:

configureMessageProcessor in class ReconfigurableClient<IDmClient>

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

sendMessageToAgent

public void sendMessageToAgent(net.roboconf.core.model.beans.Application application,
                      net.roboconf.core.model.beans.Instance instance,
                      Message message)
                        throws IOException

Description copied from interface: IDmClient

Sends a message to an agent.

Specified by:

sendMessageToAgent in interface IDmClient

Parameters:

application - the application associated with the given agent

instance - an instance managed on the agent (used to find the root instance name)

message - the message to send

Throws:

IOException - if something went wrong

listenToAgentMessages

public void listenToAgentMessages(net.roboconf.core.model.beans.Application application,
                         IClient.ListenerCommand command)
                           throws IOException

Description copied from interface: IDmClient

Configures the listener for messages sent by agents.

Specified by:

listenToAgentMessages in interface IDmClient

Parameters:

application - the application associated with the given agents

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

Throws:

IOException - if something went wrong

sendMessageToTheDm

public void sendMessageToTheDm(Message msg)
                        throws IOException

Description copied from interface: IClient

Sends a message to the DM.

Specified by:

sendMessageToTheDm in interface IClient

Parameters:

msg - 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

deleteMessagingServerArtifacts

public void deleteMessagingServerArtifacts(net.roboconf.core.model.beans.Application application)
                                    throws IOException

Description copied from interface: IDmClient

Deletes all the server artifacts related to this application.

This method must be called when ALL the agents have closed their connection and BEFORE the DM's connection is closed.

Specified by:

deleteMessagingServerArtifacts in interface IDmClient

Parameters:

application - the application whose messaging artifacts must be deleted

Throws:

IOException - if something went wrong

propagateAgentTermination

public void propagateAgentTermination(net.roboconf.core.model.beans.Application application,
                             net.roboconf.core.model.beans.Instance rootInstance)
                               throws IOException

Description copied from interface: IDmClient

Propagates to all the agents the fact that a given agent is not here anymore.

Generally, when an agent undeploys something, it sends notifications to other agents, which themselves invoke their "update" method. However, when the DM terminates a virtual machine, the agent does not always send these notifications to the other agents. Therefore, the DM has to do it. Since it has the application model, it can do it.

The DM should notify all the potential agents that may be concerned. Roughly, it is equivalent to unpublishing all the exports of all the instances that were available on the terminated machine.

Specified by:

propagateAgentTermination in interface IDmClient

Parameters:

application - the application the agent is associated with

rootInstance - the root instance associated with the agent

Throws:

IOException - if something went wrong