net.roboconf.messaging.client

Interface IDmClient

All Superinterfaces:

IClient

All Known Implementing Classes:

DismissClientDm, RabbitMqClientDm, ReconfigurableClientDm, TestClientDm

public interface IDmClient
extends IClient

A client for the DM.

The DM has one client for ALL the applications.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteMessagingServerArtifacts(net.roboconf.core.model.beans.Application application) Deletes all the server artifacts related to this application.
void	listenToAgentMessages(net.roboconf.core.model.beans.Application application, IClient.ListenerCommand command) Configures the listener for messages sent by agents.
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.

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

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

Method Detail

sendMessageToAgent

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

Sends a message to an agent.

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

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

Configures the listener for messages sent by agents.

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

deleteMessagingServerArtifacts

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

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.

Parameters:

application - the application whose messaging artifacts must be deleted

Throws:

IOException - if something went wrong

propagateAgentTermination

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

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.

Parameters:

application - the application the agent is associated with

rootInstance - the root instance associated with the agent

Throws:

IOException - if something went wrong