net.roboconf.messaging.internal.utils

Class RabbitMqUtils

java.lang.Object

net.roboconf.messaging.internal.utils.RabbitMqUtils

public final class RabbitMqUtils
extends Object

Author:

Vincent Zurczak - Linagora

Method Summary

Methods

Modifier and Type	Method and Description
static String	buildExchangeName(net.roboconf.core.model.beans.Application application, boolean dm) Builds the exchange name for RabbitMQ.
static String	buildExchangeName(String applicationName, boolean dm) Builds the exchange name for RabbitMQ.
static String	buildRoutingKeyForAgent(net.roboconf.core.model.beans.Instance instance) Builds the routing key for an agent.
static String	buildRoutingKeyForAgent(String rootInstanceName) Builds the routing key for an agent.
static void	closeConnection(com.rabbitmq.client.Channel channel) Closes the connection to a channel.
static void	configureFactory(com.rabbitmq.client.ConnectionFactory factory, String messageServerIp, String messageServerUsername, String messageServerPassword) Configures the connection factory with the right settings.
static void	declareApplicationExchanges(String applicationName, com.rabbitmq.client.Channel channel) Declares the required exchanges for an application.
static void	listenToRabbitMq(String sourceName, Logger logger, com.rabbitmq.client.QueueingConsumer consumer, LinkedBlockingQueue<Message> messages) Listens to RabbitMQ messages.

Methods inherited from class java.lang.Object

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

Method Detail

buildExchangeName

public static String buildExchangeName(String applicationName,
                       boolean dm)

Builds the exchange name for RabbitMQ.

Parameters:

applicationName - the application name

dm - true if we want the exchange name for the DM, false for the agents

Returns:

a non-null string

buildExchangeName

public static String buildExchangeName(net.roboconf.core.model.beans.Application application,
                       boolean dm)

Builds the exchange name for RabbitMQ.

Parameters:

application - an application

dm - true if we want the exchange name for the DM, false for the agents

Returns:

a non-null string

buildRoutingKeyForAgent

public static String buildRoutingKeyForAgent(net.roboconf.core.model.beans.Instance instance)

Builds the routing key for an agent.

Parameters:

instance - an instance managed by the agent

Returns:

a non-null string

buildRoutingKeyForAgent

public static String buildRoutingKeyForAgent(String rootInstanceName)

Builds the routing key for an agent.

Parameters:

rootInstanceName - the name of the root instance associated with the agent

Returns:

a non-null string

configureFactory

public static void configureFactory(com.rabbitmq.client.ConnectionFactory factory,
                    String messageServerIp,
                    String messageServerUsername,
                    String messageServerPassword)
                             throws IOException

Configures the connection factory with the right settings.

Parameters:

factory - the connection factory

messageServerIp - the message server IP (can contain a port and can but null too)

messageServerUsername - the user name for the message server

messageServerPassword - the password for the message server

Throws:

IOException - if something went wrong

closeConnection

public static void closeConnection(com.rabbitmq.client.Channel channel)
                            throws IOException

Closes the connection to a channel.

Parameters:

channel - the channel to close (can be null)

Throws:

IOException - if something went wrong

declareApplicationExchanges

public static void declareApplicationExchanges(String applicationName,
                               com.rabbitmq.client.Channel channel)
                                        throws IOException

Declares the required exchanges for an application.

Every time the DM or an agent must send a message, we must be sure all the exchanges have been declared. Otherwise, it will result in an error in the client. And this error will close the channel.

To PREVENT stupid errors, it is really important to declare both exchanges at once!

Parameters:

applicationName - the application name

channel - the RabbitMQ channel

Throws:

IOException - if an error occurs

listenToRabbitMq

public static void listenToRabbitMq(String sourceName,
                    Logger logger,
                    com.rabbitmq.client.QueueingConsumer consumer,
                    LinkedBlockingQueue<Message> messages)

Listens to RabbitMQ messages.

Be careful, this method aims at avoiding duplicate code. It starts an (almost) infinite loop and should be used with caution.

Parameters:

sourceName - the source name (DM, agent name...)

logger - the logger

consumer - the RabbitMQ consumer

messages - the list where to store the received messages