org.hobbit.core.components

Class AbstractComponent

java.lang.Object

org.hobbit.core.components.AbstractComponent

All Implemented Interfaces:

Closeable, AutoCloseable, Component, RabbitQueueFactory

Direct Known Subclasses:

AbstractCommandReceivingComponent

public abstract class AbstractComponent
extends Object
implements Component, RabbitQueueFactory

This abstract class implements basic functionalities of a hobbit component.

Author:

Michael Röder (roeder@informatik.uni-leipzig.de)

Field Summary

Fields

Modifier and Type	Field and Description
protected com.rabbitmq.client.ConnectionFactory	connectionFactory The factory that can be used to create additional connections.
protected com.rabbitmq.client.Connection	dataConnection The connection to the RabbitMQ broker.
private String	hobbitSessionId
private static org.slf4j.Logger	LOGGER
static int	NUMBER_OF_RETRIES_TO_CONNECT_TO_RABBIT_MQ Maximum number of retries that are executed to connect to RabbitMQ.
protected String	rabbitMQHostName The host name of the RabbitMQ broker.
static long	START_WAITING_TIME_BEFORE_RETRY Time, the system waits before retrying to connect to RabbitMQ.

Constructor Summary

Constructors

Constructor and Description
AbstractComponent()

Method Summary

Modifier and Type	Method and Description
void	close()
RabbitQueue	createDefaultRabbitQueue(String name) This method opens a channel using the established dataConnection to RabbitMQ and creates a new queue using the given name and the following configuration: The channel number is automatically derived from the connection.
String	generateSessionQueueName(String queueName)
String	getHobbitSessionId()
void	init() This method initializes the component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hobbit.core.components.Component

run

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

NUMBER_OF_RETRIES_TO_CONNECT_TO_RABBIT_MQ

public static final int NUMBER_OF_RETRIES_TO_CONNECT_TO_RABBIT_MQ

Maximum number of retries that are executed to connect to RabbitMQ.

See Also:

Constant Field Values

START_WAITING_TIME_BEFORE_RETRY

public static final long START_WAITING_TIME_BEFORE_RETRY

Time, the system waits before retrying to connect to RabbitMQ. Note that this time will be multiplied with the number of already failed tries.

See Also:

Constant Field Values

hobbitSessionId

private String hobbitSessionId

dataConnection

protected com.rabbitmq.client.Connection dataConnection

The connection to the RabbitMQ broker. In most cases it will be used for handling data.

rabbitMQHostName

protected String rabbitMQHostName

The host name of the RabbitMQ broker.

connectionFactory

protected com.rabbitmq.client.ConnectionFactory connectionFactory

The factory that can be used to create additional connections. However, in most cases it is sufficient to create a new channel using the already established dataConnection.

Constructor Detail

AbstractComponent

public AbstractComponent()

Method Detail

init

public void init()
          throws Exception

Description copied from interface: Component

This method initializes the component.

Specified by:

init in interface Component

Throws:

Exception - if an error occurs during the initialization

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getHobbitSessionId

public String getHobbitSessionId()

generateSessionQueueName

public String generateSessionQueueName(String queueName)

createDefaultRabbitQueue

public RabbitQueue createDefaultRabbitQueue(String name)
                                     throws IOException

This method opens a channel using the established dataConnection to RabbitMQ and creates a new queue using the given name and the following configuration:

• The channel number is automatically derived from the connection.
• The queue is not durable.
• The queue is not exclusive.
• The queue is configured to be deleted automatically.
• No additional queue configuration is defined.

Specified by:

createDefaultRabbitQueue in interface RabbitQueueFactory

Parameters:

name - name of the queue

Returns:

RabbitQueue object comprising the Channel and the name of the created queue

Throws:

IOException - if a communication error occurs