org.hobbit.core.rabbit.paired

Class PairedDataSender.Builder

java.lang.Object

org.hobbit.core.rabbit.DataSenderImpl.Builder

org.hobbit.core.rabbit.paired.PairedDataSender.Builder

Enclosing class:

PairedDataSender

public static final class PairedDataSender.Builder
extends DataSenderImpl.Builder

Field Summary

Fields inherited from class org.hobbit.core.rabbit.DataSenderImpl.Builder

deliveryMode, factory, idGenerator, messageConfirmBuffer, messageSize, name, queue, QUEUE_INFO_MISSING_ERROR, queueName

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PairedDataSender	build() Builds the DataReceiverImpl instance with the previously given information.
PairedDataSender.Builder	deliveryMode(int deliveryMode) Sets the delivery mode used for the RabbitMQ messages.
PairedDataSender.Builder	idGenerator(IdGenerator idGenerator) Sets the Id generator used to create unique stream Ids.
PairedDataSender.Builder	messageBuffer(int messageConfirmBuffer) Sets the number of messages that are buffered while waiting for a confirmation that they have been received by the broker.
PairedDataSender.Builder	messageSize(int messageSize) Sets the size of the messages that will be send.
PairedDataSender.Builder	name(String name)
PairedDataSender.Builder	queue(RabbitQueue queue) Sets the queue that is used to receive data.
PairedDataSender.Builder	queue(RabbitQueueFactory factory, String queueName) Method for providing the necessary information to create a queue if it has not been provided with the queue(RabbitQueue) method.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

idGenerator

public PairedDataSender.Builder idGenerator(IdGenerator idGenerator)

Sets the Id generator used to create unique stream Ids.

Overrides:

idGenerator in class DataSenderImpl.Builder

Parameters:

dataHandler - the Id generator used to create unique stream Ids

Returns:

this builder instance

queue

public PairedDataSender.Builder queue(RabbitQueue queue)

Sets the queue that is used to receive data.

Overrides:

queue in class DataSenderImpl.Builder

Parameters:

queue - the queue that is used to receive data

Returns:

this builder instance

queue

public PairedDataSender.Builder queue(RabbitQueueFactory factory,
                                      String queueName)

Method for providing the necessary information to create a queue if it has not been provided with the queue(RabbitQueue) method. Note that this information is not used if a queue has been provided.

Overrides:

queue in class DataSenderImpl.Builder

Parameters:

factory - the queue factory used to create a queue

queueName - the name of the newly created queue

Returns:

this builder instance

messageSize

public PairedDataSender.Builder messageSize(int messageSize)

Sets the size of the messages that will be send. Note that the maximum size of a message can be 2 * the given value.

Overrides:

messageSize in class DataSenderImpl.Builder

Parameters:

messageSize - the size of the messages that will be send

Returns:

this builder instance

messageBuffer

public PairedDataSender.Builder messageBuffer(int messageConfirmBuffer)

Sets the number of messages that are buffered while waiting for a confirmation that they have been received by the broker. Note that if the message buffer has reached is maximum size, the sender will block until confirmations are received.

If the given message buffer size is <1 the usage of confirmation messages is turned off.

Overrides:

messageBuffer in class DataSenderImpl.Builder

Parameters:

messageConfirmBuffer - the size of the messages buffer

Returns:

this builder instance

deliveryMode

public PairedDataSender.Builder deliveryMode(int deliveryMode)

Sets the delivery mode used for the RabbitMQ messages. Please have a look into the RabbitMQ documentation to see the different meanings of the values. By default, the sender uses DataSenderImpl.DEFAULT_DELIVERY_MODE.

Overrides:

deliveryMode in class DataSenderImpl.Builder

Parameters:

deliveryMode - the delivery mode used for the RabbitMQ messages

Returns:

this builder instance

name

public PairedDataSender.Builder name(String name)

Overrides:

name in class DataSenderImpl.Builder

build

public PairedDataSender build()
                       throws IllegalStateException,
                              IOException

Builds the DataReceiverImpl instance with the previously given information.

Overrides:

build in class DataSenderImpl.Builder

Returns:

The newly created DataReceiver instance

Throws:

IllegalStateException - if neither a queue nor the information needed to create a queue have been provided.

IOException - if an exception is thrown while creating a new queue.