Module dk.cloudcreate.essentials.components.foundation

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

Class QueueMessage

java.lang.Object

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

public class QueueMessage
extends Object

Queue a message for asynchronous delivery optional delay to a DurableQueueConsumer
Note this method MUST be called within an existing UnitOfWork IF using TransactionalMode.FullyTransactional
Operation also matches DurableQueuesInterceptor.intercept(QueueMessage, InterceptorChain)

Field Summary

Fields

Modifier and Type	Field	Description
QueueName	queueName

Constructor Summary

Constructors

Constructor	Description
QueueMessage(QueueName queueName, Message message, Exception causeOfEnqueuing, Duration deliveryDelay)	Queue a message for asynchronous delivery optional delay to a DurableQueueConsumer Note this method MUST be called within an existing UnitOfWork IF using TransactionalMode.FullyTransactional
QueueMessage(QueueName queueName, Message message, Optional<Exception> causeOfEnqueuing, Optional<Duration> deliveryDelay)	Queue a message for asynchronous delivery optional delay to a DurableQueueConsumer Note this method MUST be called within an existing UnitOfWork IF using TransactionalMode.FullyTransactional

Method Summary

Modifier and Type	Method	Description
static QueueMessageBuilder	builder()	Create a new builder that produces a new QueueMessage instance
Optional<Exception>	getCauseOfEnqueuing()
Optional<Duration>	getDeliveryDelay()
Message	getMessage()	Get the message being queued
MessageMetaData	getMetaData()
Object	getPayload()
QueueName	getQueueName()
void	setCauseOfEnqueuing(Exception causeOfEnqueuing)
void	setCauseOfEnqueuing(Optional<Exception> causeOfEnqueuing)
void	setDeliveryDelay(Duration deliveryDelay)
void	setDeliveryDelay(Optional<Duration> deliveryDelay)
void	setMessage(Message message)
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

Constructor Detail

QueueMessage

public QueueMessage(QueueName queueName,
                    Message message,
                    Optional<Exception> causeOfEnqueuing,
                    Optional<Duration> deliveryDelay)

Queue a message for asynchronous delivery optional delay to a DurableQueueConsumer
Note this method MUST be called within an existing UnitOfWork IF using TransactionalMode.FullyTransactional

Parameters:

queueName - the name of the Queue the message is added to

message - the message being queued (Message/OrderedMessage)

causeOfEnqueuing - the optional reason for the message being queued

deliveryDelay - the Optional delay for the first delivery of the message to the DurableQueueConsumer

See Also:

OrderedMessage

QueueMessage

public QueueMessage(QueueName queueName,
                    Message message,
                    Exception causeOfEnqueuing,
                    Duration deliveryDelay)

Queue a message for asynchronous delivery optional delay to a DurableQueueConsumer
Note this method MUST be called within an existing UnitOfWork IF using TransactionalMode.FullyTransactional

Parameters:

queueName - the name of the Queue the message is added to

message - the message being queued (Message/OrderedMessage)

causeOfEnqueuing - the optional reason for the message being queued

deliveryDelay - the Optional delay for the first delivery of the message to the DurableQueueConsumer

See Also:

OrderedMessage

Method Detail

builder

public static QueueMessageBuilder builder()

Create a new builder that produces a new QueueMessage instance

Returns:

a new QueueMessageBuilder instance

getQueueName

public QueueName getQueueName()

Returns:

the name of the Queue the message is added to

getPayload

public Object getPayload()

Returns:

the message payload

getCauseOfEnqueuing

public Optional<Exception> getCauseOfEnqueuing()

Returns:

the optional reason for the message being queued

getDeliveryDelay

public Optional<Duration> getDeliveryDelay()

Returns:

the Optional delay for the first delivery of the message to the DurableQueueConsumer

setMessage

public void setMessage(Message message)

Parameters:

message - the message being queued (Message/OrderedMessage)

getMessage

public Message getMessage()

Get the message being queued

Returns:

Get the message being queued (Message/OrderedMessage)

setDeliveryDelay

public void setDeliveryDelay(Optional<Duration> deliveryDelay)

Parameters:

deliveryDelay - the Optional delay for the first delivery of the message to the DurableQueueConsumer

getMetaData

public MessageMetaData getMetaData()

Returns:

metadata metadata related to the message/payload

setCauseOfEnqueuing

public void setCauseOfEnqueuing(Optional<Exception> causeOfEnqueuing)

Parameters:

causeOfEnqueuing - the optional reason for the message being queued

setDeliveryDelay

public void setDeliveryDelay(Duration deliveryDelay)

Parameters:

deliveryDelay - the Optional delay for the first delivery of the message to the DurableQueueConsumer

setCauseOfEnqueuing

public void setCauseOfEnqueuing(Exception causeOfEnqueuing)

Parameters:

causeOfEnqueuing - the optional reason for the message being queued

toString

public String toString()

Overrides:

toString in class Object