Module dk.cloudcreate.essentials.components.foundation

Package dk.cloudcreate.essentials.components.foundation.messaging.queue.operations

Class GetNextMessageReadyForDelivery

java.lang.Object

dk.cloudcreate.essentials.components.foundation.messaging.queue.operations.GetNextMessageReadyForDelivery

public class GetNextMessageReadyForDelivery
extends Object

Query the next Queued Message (i.e. not including Dead Letter Messages) that's ready to be delivered to a DurableQueueConsumer
Note this method MUST be called within an existing UnitOfWork IF using TransactionalMode.FullyTransactional
Operation also matched DurableQueuesInterceptor.intercept(GetNextMessageReadyForDelivery, InterceptorChain)

Field Summary

Fields

Modifier and Type	Field	Description
QueueName	queueName	the name of the Queue where we will query for the next message ready for delivery

Constructor Summary

Constructors

Constructor	Description
GetNextMessageReadyForDelivery(QueueName queueName)	Query the next Queued Message (i.e.
GetNextMessageReadyForDelivery(QueueName queueName, Collection<String> excludeOrderedMessagesWithKey)	Query the next Queued Message (i.e.

Method Summary

Modifier and Type	Method	Description
static GetNextMessageReadyForDeliveryBuilder	builder()	Create a new builder that produces a new GetNextMessageReadyForDelivery instance
Collection<String>	getExcludeOrderedMessagesWithKey()
QueueName	getQueueName()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

queueName

public final QueueName queueName

the name of the Queue where we will query for the next message ready for delivery

Constructor Detail

GetNextMessageReadyForDelivery

public GetNextMessageReadyForDelivery(QueueName queueName)

Query the next Queued Message (i.e. not including Dead Letter Messages) that's ready to be delivered to a DurableQueueConsumer
Note this method MUST be called within an existing UnitOfWork IF using TransactionalMode.FullyTransactional

Parameters:

queueName - the name of the Queue where we will query for the next message ready for delivery

GetNextMessageReadyForDelivery

public GetNextMessageReadyForDelivery(QueueName queueName,
                                      Collection<String> excludeOrderedMessagesWithKey)

Query the next Queued Message (i.e. not including Dead Letter Messages) that's ready to be delivered to a DurableQueueConsumer
Note this method MUST be called within an existing UnitOfWork IF using TransactionalMode.FullyTransactional

Parameters:

queueName - the name of the Queue where we will query for the next message ready for delivery

excludeOrderedMessagesWithKey - collection of OrderedMessage.getKey()'s to exclude in the search for the next message

Method Detail

builder

public static GetNextMessageReadyForDeliveryBuilder builder()

Create a new builder that produces a new GetNextMessageReadyForDelivery instance

Returns:

a new GetNextMessageReadyForDeliveryBuilder instance

getQueueName

public QueueName getQueueName()

Returns:

the name of the Queue where we will query for the next message ready for delivery

getExcludeOrderedMessagesWithKey

public Collection<String> getExcludeOrderedMessagesWithKey()

Returns:

collection of OrderedMessage.getKey()'s to exclude in the search for the next message

toString

public String toString()

Overrides:

toString in class Object