org.vatplanner.commons.amqp

Class MessageSubscriptionCreator

java.lang.Object

org.vatplanner.commons.amqp.AmqpSubscriptionCreator

org.vatplanner.commons.amqp.MessageSubscriptionCreator

public class MessageSubscriptionCreator
extends AmqpSubscriptionCreator

Creates a new listener for a queue on AMQP to receive deserialized 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 AmqpSubscriptionCreator.subscribe().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MessageSubscriptionCreator.MessageHandler<M extends Message>

Nested classes/interfaces inherited from class org.vatplanner.commons.amqp.AmqpSubscriptionCreator

AmqpSubscriptionCreator.AmqpMessageHandler, AmqpSubscriptionCreator.ReceiptAction

Method Summary

Modifier and Type	Method and Description
MessageSubscriptionCreator	forExistingQueue(String queueName) Configures the listener to be subscribed to an existing queue.
MessageSubscriptionCreator	ignoringMessages(Class<? extends Message>... messageClasses) Registers the given Message types to be ignored.
MessageSubscriptionCreator	ignoringMessages(Collection<Class<? extends Message>> messageClasses) Registers the given Message types to be ignored.
MessageSubscriptionCreator	notOlderThan(Duration messageTimeout) Sets the message timeout.
MessageSubscriptionCreator	notSentAfter(Instant maximumMessageTimestamp) Sets the maximum timestamp received messages must indicate.
MessageSubscriptionCreator	notSentBefore(AtomicReference<Instant> minimumMessageTimestamp) Sets the reference to read the minimum timestamp from which received messages must indicate.
MessageSubscriptionCreator	notSentBefore(Instant minimumMessageTimestamp) Sets the minimum timestamp received messages must indicate.
MessageSubscriptionCreator	onError(AmqpSubscriptionCreator.ReceiptAction receiptAction) Sets the message receipt to be sent to the AMQP server if an error occurred during message handling.
MessageSubscriptionCreator	onIgnore(AmqpSubscriptionCreator.ReceiptAction receiptAction) Sets the ReceiptAction for all ignored messages (filtered by timestamp or message type).
<M extends Message> MessageSubscriptionCreator	onMessage(Class<M> messageClass, MessageSubscriptionCreator.MessageHandler<M> messageHandler) Registers a MessageSubscriptionCreator.MessageHandler for the given Message type.
static MessageSubscriptionCreator	usingChannel(com.rabbitmq.client.Channel channel) Instantiates a new MessageSubscriptionCreator for the given Channel.
MessageSubscriptionCreator	withAutoAck(boolean autoAck) Controls whether all messages should be automatically acknowledged.
MessageSubscriptionCreator	withCryptor(org.vatplanner.commons.crypto.Cryptor cryptor) Provides a Cryptor to decrypt messages and verify signatures.
MessageSubscriptionCreator	withExchangeParameters(ExchangeParameters exchangeParameters) Sets the ExchangeParameters to be used.
MessageSubscriptionCreator	withLogPrefix(String logPrefix) Configures the prefix name to use for all log messages.
MessageSubscriptionCreator	withQueueRoutingKeys(Collection<String> queueRoutingKeys) Configures the routing keys the queue should be bound to.
MessageSubscriptionCreator	withQueueRoutingKeys(String... queueRoutingKeys) Configures the routing key(s) the queue should be bound to.

Methods inherited from class org.vatplanner.commons.amqp.AmqpSubscriptionCreator

onMessage, subscribe

Methods inherited from class java.lang.Object

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

Method Detail

usingChannel

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

Instantiates a new MessageSubscriptionCreator for the given Channel.

Parameters:

channel - Channel to perform all actions on

Returns:

new instance of MessageSubscriptionCreator

withCryptor

public MessageSubscriptionCreator withCryptor(org.vatplanner.commons.crypto.Cryptor cryptor)

Provides a Cryptor to decrypt messages and verify signatures.

Parameters:

cryptor - used for decryption and signature verification

Returns:

same instance for method-chaining

notOlderThan

public MessageSubscriptionCreator notOlderThan(Duration messageTimeout)

Sets the message timeout. Messages indicating an older timestamp will be ignored as configured via #onIgnore(ReceiptAction).

Note that an additional CLOCK_DRIFT_ALLOWANCE is tolerated to permit slight differences due to all timestamps referencing local real-time system clocks instead of a uniform network clock.

Parameters:

messageTimeout - maximum age of messages to be processed

Returns:

same instance for method-chaining

notSentBefore

public MessageSubscriptionCreator notSentBefore(Instant minimumMessageTimestamp)

Sets the minimum timestamp received messages must indicate. Messages sent with an earlier timestamp will be ignored as configured via #onIgnore(ReceiptAction). This is different from the notOlderThan(Duration) timeout which checks the message age compared to time of processing whereas this minimum timestamp is a fixed absolute point in time.

Note that an additional CLOCK_DRIFT_ALLOWANCE is tolerated to permit slight differences due to all timestamps referencing local real-time system clocks instead of a uniform network clock.

Parameters:

minimumMessageTimestamp - earliest point in time to accept messages from

Returns:

same instance for method-chaining

notSentBefore

public MessageSubscriptionCreator notSentBefore(AtomicReference<Instant> minimumMessageTimestamp)

Sets the reference to read the minimum timestamp from which received messages must indicate. The timestamp is allowed to become available after subscription and message processing has already been started. Messages sent with an earlier timestamp will be ignored as configured via #onIgnore(ReceiptAction). This is different from the notOlderThan(Duration) timeout which checks the message age compared to time of processing whereas this minimum timestamp is a fixed absolute point in time.

Note that an additional CLOCK_DRIFT_ALLOWANCE is tolerated to permit slight differences due to all timestamps referencing local real-time system clocks instead of a uniform network clock.

Parameters:

minimumMessageTimestamp - earliest point in time to accept messages from

Returns:

same instance for method-chaining

notSentAfter

public MessageSubscriptionCreator notSentAfter(Instant maximumMessageTimestamp)

Sets the maximum timestamp received messages must indicate. Messages sent with a later timestamp will be ignored as configured via #onIgnore(ReceiptAction). This filter only stops further processing but the listener will continue to receive new messages; the Channel needs to be closed to actually stop receiving useless messages after the given point in time has been reached.

Note that an additional CLOCK_DRIFT_ALLOWANCE is tolerated to permit slight differences due to all timestamps referencing local real-time system clocks instead of a uniform network clock.

Parameters:

maximumMessageTimestamp - latest point in time to accept messages from

Returns:

same instance for method-chaining

onMessage

public <M extends Message> MessageSubscriptionCreator onMessage(Class<M> messageClass,
                                                                MessageSubscriptionCreator.MessageHandler<M> messageHandler)

Registers a MessageSubscriptionCreator.MessageHandler for the given Message type.

Type Parameters:

M - Message type to handle

Parameters:

messageClass - Message type to handle

messageHandler - will receive all messages of the given type

Returns:

same instance for method-chaining

ignoringMessages

@SafeVarargs
public final MessageSubscriptionCreator ignoringMessages(Class<? extends Message>... messageClasses)

Registers the given Message types to be ignored.

This must be set if multiple Message types are expected to be received on the same queue which have no MessageSubscriptionCreator.MessageHandlers registered as all non-ignored but unhandled messages are treated as errors.

Parameters:

messageClasses - Message types to be ignored if received

Returns:

same instance for method-chaining

ignoringMessages

public MessageSubscriptionCreator ignoringMessages(Collection<Class<? extends Message>> messageClasses)

Registers the given Message types to be ignored.

This must be set if multiple Message types are expected to be received on the same queue which have no MessageSubscriptionCreator.MessageHandlers registered as all non-ignored but unhandled messages are treated as errors.

Parameters:

messageClasses - Message types to be ignored if received

Returns:

same instance for method-chaining

onIgnore

public MessageSubscriptionCreator onIgnore(AmqpSubscriptionCreator.ReceiptAction receiptAction)

Sets the ReceiptAction for all ignored messages (filtered by timestamp or message type).

Parameters:

receiptAction - action to perform for ignored messages

Returns:

same instance for method-chaining

forExistingQueue

public MessageSubscriptionCreator forExistingQueue(String queueName)

Description copied from class: AmqpSubscriptionCreator

Configures the listener to be subscribed to an existing queue.

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

Overrides:

forExistingQueue in class AmqpSubscriptionCreator

Parameters:

queueName - name of existing queue to be subscribed to

Returns:

same instance for method-chaining

onError

public MessageSubscriptionCreator onError(AmqpSubscriptionCreator.ReceiptAction receiptAction)

Description copied from class: AmqpSubscriptionCreator

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

Overrides:

onError in class AmqpSubscriptionCreator

Parameters:

receiptAction - message receipt to send in case of errors

Returns:

same instance for method-chaining

withAutoAck

public MessageSubscriptionCreator withAutoAck(boolean autoAck)

Description copied from class: AmqpSubscriptionCreator

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.

Overrides:

withAutoAck in class AmqpSubscriptionCreator

Parameters:

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

Returns:

same instance for method-chaining

withExchangeParameters

public MessageSubscriptionCreator withExchangeParameters(ExchangeParameters exchangeParameters)

Description copied from class: AmqpSubscriptionCreator

Sets the ExchangeParameters to be used.

Overrides:

withExchangeParameters in class AmqpSubscriptionCreator

Parameters:

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

Returns:

same instance for method-chaining

withLogPrefix

public MessageSubscriptionCreator withLogPrefix(String logPrefix)

Description copied from class: AmqpSubscriptionCreator

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.

Overrides:

withLogPrefix in class AmqpSubscriptionCreator

Parameters:

logPrefix - name to prefix log messages with

Returns:

same instance for method-chaining

withQueueRoutingKeys

public MessageSubscriptionCreator withQueueRoutingKeys(String... queueRoutingKeys)

Description copied from class: AmqpSubscriptionCreator

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

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

Overrides:

withQueueRoutingKeys in class AmqpSubscriptionCreator

Parameters:

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

Returns:

same instance for method-chaining

withQueueRoutingKeys

public MessageSubscriptionCreator withQueueRoutingKeys(Collection<String> queueRoutingKeys)

Description copied from class: AmqpSubscriptionCreator

Configures the routing keys the queue should be bound to.

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

Overrides:

withQueueRoutingKeys in class AmqpSubscriptionCreator

Parameters:

queueRoutingKeys - routing keys used to bind queue to exchange

Returns:

same instance for method-chaining