Module dk.cloudcreate.essentials.components.foundation

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

Class QueueMessageAsDeadLetterMessage

java.lang.Object

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

public class QueueMessageAsDeadLetterMessage
extends Object

Queue the message directly as a Dead Letter Message. Dead Letter Messages won't be delivered to any DurableQueueConsumer
To deliver a Dead Letter Message you must first resurrect the message using DurableQueues.resurrectDeadLetterMessage(QueueEntryId, Duration)
Operation also matches DurableQueuesInterceptor.intercept(QueueMessageAsDeadLetterMessage, InterceptorChain)

Field Summary

Fields

Modifier and Type	Field	Description
QueueName	queueName

Constructor Summary

Constructors

Constructor	Description
QueueMessageAsDeadLetterMessage(QueueName queueName, Message message, Exception causeOfError)	Queue the message directly as a Dead Letter Message.

Method Summary

Modifier and Type	Method	Description
static QueueMessageAsDeadLetterMessageBuilder	builder()	Create a new builder that produces a new QueueMessageAsDeadLetterMessage instance
Exception	getCauseOfError()
Message	getMessage()	Get the dead letter message
MessageMetaData	getMetaData()
Object	getPayload()
QueueName	getQueueName()
void	setCauseOfError(Exception causeOfError)
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

QueueMessageAsDeadLetterMessage

public QueueMessageAsDeadLetterMessage(QueueName queueName,
                                       Message message,
                                       Exception causeOfError)

Queue the message directly as a Dead Letter Message. Dead Letter Messages won't be delivered to any DurableQueueConsumer
To deliver a Dead Letter Message you must first resurrect the message using DurableQueues.resurrectDeadLetterMessage(QueueEntryId, Duration)

Parameters:

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

message - the message being enqueued directly as a Dead Letter Message (Message/OrderedMessage)

causeOfError - the reason for the message being queued directly as a Dead Letter Message

Method Detail

builder

public static QueueMessageAsDeadLetterMessageBuilder builder()

Create a new builder that produces a new QueueMessageAsDeadLetterMessage instance

Returns:

a new QueueMessageAsDeadLetterMessageBuilder instance

getQueueName

public QueueName getQueueName()

Returns:

the name of the Queue the message is added to

getPayload

public Object getPayload()

Returns:

the message payload

getMessage

public Message getMessage()

Get the dead letter message

Returns:

the dead letter message (Message/OrderedMessage)

setMessage

public void setMessage(Message message)

Parameters:

message - set the dead letter message (Message/OrderedMessage)

getCauseOfError

public Exception getCauseOfError()

Returns:

the reason for the message being queued directly as a Dead Letter Message

getMetaData

public MessageMetaData getMetaData()

Returns:

metadata metadata related to the message/payload

setCauseOfError

public void setCauseOfError(Exception causeOfError)

Parameters:

causeOfError - the reason for the message being queued directly as a Dead Letter Message

toString

public String toString()

Overrides:

toString in class Object