org.vatplanner.commons.amqp

Class AmqpSubscriptionCreator

java.lang.Object

org.vatplanner.commons.amqp.AmqpSubscriptionCreator

Direct Known Subclasses:

MessageSubscriptionCreator

public class AmqpSubscriptionCreator
extends Object

Creates a new listener for a queue on AMQP to receive "raw" AMQP messages. The listener is only registered, it is not managed any further by this class. To "unregister" either the Channel has to be closed or the queue (if an existing one was bound) needs to be deleted.

The creator instance must not be modified after subscribe().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AmqpSubscriptionCreator.AmqpMessageHandler Handles a message received via AMQP.
static class	AmqpSubscriptionCreator.ReceiptAction Describes how to handle message confirmation on AMQP.

Method Summary

Modifier and Type	Method and Description
AmqpSubscriptionCreator	forExistingQueue(String queueName) Configures the listener to be subscribed to an existing queue.
AmqpSubscriptionCreator	onError(AmqpSubscriptionCreator.ReceiptAction receiptAction) Sets the message receipt to be sent to the AMQP server if an error occurred during message handling.
AmqpSubscriptionCreator	onMessage(AmqpSubscriptionCreator.AmqpMessageHandler amqpMessageHandler) Registers the AmqpSubscriptionCreator.AmqpMessageHandler to process received messages.
void	subscribe() Subscribes to the exchange/queue as previously configured.
static AmqpSubscriptionCreator	usingChannel(com.rabbitmq.client.Channel channel) Instantiates a new AmqpSubscriptionCreator for the given Channel.
AmqpSubscriptionCreator	withAutoAck(boolean autoAck) Controls whether all messages should be automatically acknowledged.
AmqpSubscriptionCreator	withExchangeParameters(ExchangeParameters exchangeParameters) Sets the ExchangeParameters to be used.
AmqpSubscriptionCreator	withLogPrefix(String logPrefix) Configures the prefix name to use for all log messages.
AmqpSubscriptionCreator	withQueueRoutingKeys(Collection<String> queueRoutingKeys) Configures the routing keys the queue should be bound to.
AmqpSubscriptionCreator	withQueueRoutingKeys(String... queueRoutingKeys) Configures the routing key(s) the queue should be bound to.

Methods inherited from class java.lang.Object

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

Method Detail

usingChannel

public static AmqpSubscriptionCreator usingChannel(com.rabbitmq.client.Channel channel)

Instantiates a new AmqpSubscriptionCreator for the given Channel.

Parameters:

channel - Channel to perform all actions on

Returns:

new instance of AmqpSubscriptionCreator

onError

public AmqpSubscriptionCreator onError(AmqpSubscriptionCreator.ReceiptAction receiptAction)

Sets the message receipt to be sent to the AMQP server if an error occurred during message handling.

Parameters:

receiptAction - message receipt to send in case of errors

Returns:

same instance for method-chaining

forExistingQueue

public AmqpSubscriptionCreator forExistingQueue(String queueName)

Configures the listener to be subscribed to an existing queue.

Using an existing queue disables queue declaration and does not set up any bindings.

Parameters:

queueName - name of existing queue to be subscribed to

Returns:

same instance for method-chaining

withQueueRoutingKeys

public AmqpSubscriptionCreator withQueueRoutingKeys(String... queueRoutingKeys)

Configures the routing key(s) the queue should be bound to.

This option has no effect if an existing queue will be subscribed to.

Parameters:

queueRoutingKeys - routing key(s) used to bind queue to exchange

Returns:

same instance for method-chaining

withQueueRoutingKeys

public AmqpSubscriptionCreator withQueueRoutingKeys(Collection<String> queueRoutingKeys)

Configures the routing keys the queue should be bound to.

This option has no effect if an existing queue will be subscribed to.

Parameters:

queueRoutingKeys - routing keys used to bind queue to exchange

Returns:

same instance for method-chaining

withLogPrefix

public AmqpSubscriptionCreator withLogPrefix(String logPrefix)

Configures the prefix name to use for all log messages. The actual prefix will include brackets for additional separation, only the name to go inside those brackets needs to be provided.

Parameters:

logPrefix - name to prefix log messages with

Returns:

same instance for method-chaining

withExchangeParameters

public AmqpSubscriptionCreator withExchangeParameters(ExchangeParameters exchangeParameters)

Sets the ExchangeParameters to be used.

Parameters:

exchangeParameters - describes all relevant parameters to declare and bind to the wanted exchange

Returns:

same instance for method-chaining

withAutoAck

public AmqpSubscriptionCreator withAutoAck(boolean autoAck)

Controls whether all messages should be automatically acknowledged.

See AMQP server/protocol for exact details but generally automated acknowledgments will be issued immediately when a message has been sent which can happen even before the message ever reaches any handling implementations. The majority of messages usually do not require explicit message confirmation, so auto-ack is enabled by default. In order to be able to perform any AmqpSubscriptionCreator.ReceiptActions to indicate actual message handling or errors to the AMQP server, auto-ack needs to be disabled.

Parameters:

autoAck - false disables automated acknowledgements, true (default) enables them

Returns:

same instance for method-chaining

onMessage

public AmqpSubscriptionCreator onMessage(AmqpSubscriptionCreator.AmqpMessageHandler amqpMessageHandler)

Registers the AmqpSubscriptionCreator.AmqpMessageHandler to process received messages.

Parameters:

amqpMessageHandler - will be called for all received messages

Returns:

same instance for method-chaining

subscribe

public void subscribe()

Subscribes to the exchange/queue as previously configured.

This is a terminal operation; this instance must not be altered or reused following this method call.