org.hobbit.controller.front

Class FrontEndApiHandler.Builder

java.lang.Object

org.hobbit.controller.front.FrontEndApiHandler.Builder

Enclosing class:

FrontEndApiHandler

public static class FrontEndApiHandler.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected PlatformController	controller
protected static String	CONTROLLER_MISSING_ERROR
protected org.hobbit.core.rabbit.RabbitQueueFactory	factory
protected int	maxParallelProcessedMsgs
protected org.hobbit.core.data.RabbitQueue	queue
protected static String	QUEUE_INFO_MISSING_ERROR
protected String	queueName

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
FrontEndApiHandler	build() Builds the DataReceiverImpl instance with the previously given information.
FrontEndApiHandler.Builder	maxParallelProcessedMsgs(int maxParallelProcessedMsgs) Sets the maximum number of incoming messages that are processed in parallel.
FrontEndApiHandler.Builder	platformController(PlatformController controller) Sets the reference to the platform controller that is called if data is incoming.
FrontEndApiHandler.Builder	queue(org.hobbit.core.data.RabbitQueue queue) Sets the queue that is used to receive data.
FrontEndApiHandler.Builder	queue(org.hobbit.core.rabbit.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

Field Detail

QUEUE_INFO_MISSING_ERROR

protected static final String QUEUE_INFO_MISSING_ERROR

See Also:

Constant Field Values

CONTROLLER_MISSING_ERROR

protected static final String CONTROLLER_MISSING_ERROR

See Also:

Constant Field Values

controller

protected PlatformController controller

queue

protected org.hobbit.core.data.RabbitQueue queue

queueName

protected String queueName

maxParallelProcessedMsgs

protected int maxParallelProcessedMsgs

factory

protected org.hobbit.core.rabbit.RabbitQueueFactory factory

Constructor Detail

Builder

public Builder()

Method Detail

platformController

public FrontEndApiHandler.Builder platformController(PlatformController controller)

Sets the reference to the platform controller that is called if data is incoming.

Parameters:

controller - the platform controller that is called if data is incoming

Returns:

this builder instance

queue

public FrontEndApiHandler.Builder queue(org.hobbit.core.data.RabbitQueue queue)

Sets the queue that is used to receive data.

Parameters:

queue - the queue that is used to receive data

Returns:

this builder instance

queue

public FrontEndApiHandler.Builder queue(org.hobbit.core.rabbit.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.

Parameters:

factory - the queue factory used to create a queue

queueName - the name of the newly created queue

Returns:

this builder instance

maxParallelProcessedMsgs

public FrontEndApiHandler.Builder maxParallelProcessedMsgs(int maxParallelProcessedMsgs)

Sets the maximum number of incoming messages that are processed in parallel. Additional messages have to wait in the queue.

Parameters:

maxParallelProcessedMsgs - the maximum number of incoming messages that are processed in parallel

Returns:

this builder instance

build

public FrontEndApiHandler build()
                         throws IllegalStateException,
                                IOException

Builds the DataReceiverImpl instance with the previously given information.

Returns:

The newly created DataReceiver instance

Throws:

IllegalStateException - if the dataHandler is missing or 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 or if the given queue can not be configured by the newly created DataReceiver. Note that in the latter case the queue will be closed.