net.roboconf.messaging.reconfigurables

Class ReconfigurableClient<T extends IClient>

java.lang.Object

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

Type Parameters:

T - a sub-class of IClient

All Implemented Interfaces:

IClient

Direct Known Subclasses:

ReconfigurableClientAgent, ReconfigurableClientDm

public abstract class ReconfigurableClient<T extends IClient>
extends Object
implements IClient

A class that wraps a messaging client and can reconfigure it.

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
ReconfigurableClient()

Method Summary

Methods

Modifier and Type	Method and Description
void	associateMessageProcessor(AbstractMessageProcessor<T> messageProcessor) Associates a message processor with this instance.
protected abstract void	configureMessageProcessor(AbstractMessageProcessor<T> messageProcessor) Configures the message processor.
protected abstract T	createNewMessagingClient(String messageServerIp, String messageServerUser, String messageServerPwd, String factoryName) Creates a new messaging client and opens a connection with the messaging server.
protected abstract T	getDismissedClient()
AbstractMessageProcessor<T>	getMessageProcessor()
protected T	getMessagingClient()
boolean	hasValidClient()
protected abstract void	openConnection(T newMessagingClient) Configures a newly created client.
protected void	resetInternalClient() Resets the internal client (sets it to null).
void	switchMessagingClient(String messageServerIp, String messageServerUser, String messageServerPwd, String factoryName) Changes the internal messaging client.

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

ReconfigurableClient

public ReconfigurableClient()

Method Detail

switchMessagingClient

public void switchMessagingClient(String messageServerIp,
                         String messageServerUser,
                         String messageServerPwd,
                         String factoryName)

Changes the internal messaging client.

Parameters:

messageServerIp - the IP address of the messaging server

messageServerUser - the user name for the messaging server

messageServerPwd - the password for the messaging server

factoryName - the factory name (see MessagingConstants)

createNewMessagingClient

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

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

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 abstract void openConnection(T newMessagingClient)
                                throws IOException

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.

Parameters:

newMessagingClient - the messaging client to configure

Throws:

IOException - if something went wrong

getDismissedClient

protected abstract T getDismissedClient()

Returns:

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

configureMessageProcessor

protected abstract void configureMessageProcessor(AbstractMessageProcessor<T> messageProcessor)

Configures the message processor.

Parameters:

messageProcessor - the message processor

associateMessageProcessor

public void associateMessageProcessor(AbstractMessageProcessor<T> messageProcessor)

Associates a message processor with this instance.

The message processor cannot be started before. This method will start it.

This method must be invoked only once.

Parameters:

messageProcessor - the message processor

getMessageProcessor

public AbstractMessageProcessor<T> getMessageProcessor()

Returns:

the message processor

hasValidClient

public boolean hasValidClient()

Returns:

true if the internal client exists and is connected, false otherwise

getMessagingClient

protected T getMessagingClient()

Returns:

a messaging client (never null)

resetInternalClient

protected void resetInternalClient()

Resets the internal client (sets it to null).