Module dk.cloudcreate.essentials.components.foundation

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

Class DefaultQueuedMessage

java.lang.Object

dk.cloudcreate.essentials.components.foundation.messaging.queue.DefaultQueuedMessage

All Implemented Interfaces:

QueuedMessage

public final class DefaultQueuedMessage
extends Object
implements QueuedMessage

Represents a message queued onto a Durable Queue

Nested Class Summary

Nested classes/interfaces inherited from interface dk.cloudcreate.essentials.components.foundation.messaging.queue.QueuedMessage

QueuedMessage.DeliveryMode

Field Summary

Fields

Modifier and Type	Field	Description
final OffsetDateTime	addedTimestamp
final OffsetDateTime	deliveryTimestamp
final QueueEntryId	id
final boolean	isBeingDelivered
final boolean	isDeadLetterMessage
final String	lastDeliveryError
final Message	message	The deserialized message payload
final OffsetDateTime	nextDeliveryTimestamp
final QueueName	queueName
final int	redeliveryAttempts
final int	totalDeliveryAttempts

Constructor Summary

Constructors

Constructor	Description
DefaultQueuedMessage(QueueEntryId id, QueueName queueName, Message message, OffsetDateTime addedTimestamp, OffsetDateTime nextDeliveryTimestamp, OffsetDateTime deliveryTimestamp, String lastDeliveryError, int totalDeliveryAttempts, int redeliveryAttempts, boolean isDeadLetterMessage, boolean isBeingDelivered)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
OffsetDateTime	getAddedTimestamp()	When was this message first enqueued (or directly added as a Dead-letter-message)
QueuedMessage.DeliveryMode	getDeliveryMode()	Get the message's QueuedMessage.DeliveryMode
OffsetDateTime	getDeliveryTimestamp()	If QueuedMessage.isBeingDelivered() is true, then QueuedMessage.getDeliveryTimestamp() returns the timestamp for when the message delivery started.
QueueEntryId	getId()	The unique queue entry id for this message
String	getLastDeliveryError()	Get the error from the last delivery (null if no error is recorded)
Message	getMessage()	Get the message queued
OffsetDateTime	getNextDeliveryTimestamp()	Timestamp for when the message should be delivered next time.
QueueName	getQueueName()	Name of the Queue that the message is enqueued on
int	getRedeliveryAttempts()	How many times has we attempted to re-deliver this message (same as QueuedMessage.getTotalDeliveryAttempts()-1)
Duration	getRedeliveryDelay()	In case QueuedMessage.isManuallyMarkedForRedelivery() returns true, then this method will return the requested redelivery delay
int	getTotalDeliveryAttempts()	Get the total number of delivery attempts for this message
int	hashCode()
boolean	isBeingDelivered()	Is the message currently being delivered to a message consumer
boolean	isDeadLetterMessage()	Is this a poison/dead-letter message that will not be delivered until DurableQueues.resurrectDeadLetterMessage(ResurrectDeadLetterMessage) is called
boolean	isManuallyMarkedForRedelivery()	Is the message marked for redelivery - i.e.
void	markForRedeliveryIn(Duration deliveryDelay)	Mark the message for redelivery with the specified deliveryDelay - this manually requested redelivery counts towards the specified RedeliveryPolicy.maximumNumberOfRedeliveries A QueuedMessageHandler can choose to call this method directly to have the message be redelivered. Note: A QueuedMessageHandler should never directly call DurableQueues.retryMessage(RetryMessage) as this doesn't set the QueuedMessage.isManuallyMarkedForRedelivery() flag which the DefaultDurableQueueConsumer relies upon for manually requested message redeliveries
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dk.cloudcreate.essentials.components.foundation.messaging.queue.QueuedMessage

getMetaData, getPayload

Field Details

id

public final QueueEntryId id

queueName

public final QueueName queueName

message

public final Message message

The deserialized message payload

addedTimestamp

public final OffsetDateTime addedTimestamp

nextDeliveryTimestamp

public final OffsetDateTime nextDeliveryTimestamp

deliveryTimestamp

public final OffsetDateTime deliveryTimestamp

lastDeliveryError

public final String lastDeliveryError

totalDeliveryAttempts

public final int totalDeliveryAttempts

redeliveryAttempts

public final int redeliveryAttempts

isDeadLetterMessage

public final boolean isDeadLetterMessage

isBeingDelivered

public final boolean isBeingDelivered

Constructor Details

DefaultQueuedMessage

public DefaultQueuedMessage(QueueEntryId id,
 QueueName queueName,
 Message message,
 OffsetDateTime addedTimestamp,
 OffsetDateTime nextDeliveryTimestamp,
 OffsetDateTime deliveryTimestamp,
 String lastDeliveryError,
 int totalDeliveryAttempts,
 int redeliveryAttempts,
 boolean isDeadLetterMessage,
 boolean isBeingDelivered)

Method Details

getId

public QueueEntryId getId()

Description copied from interface: QueuedMessage

The unique queue entry id for this message

Specified by:

getId in interface QueuedMessage

Returns:

getQueueName

public QueueName getQueueName()

Description copied from interface: QueuedMessage

Name of the Queue that the message is enqueued on

Specified by:

getQueueName in interface QueuedMessage

Returns:

name of the Queue that the message is enqueued on

getMessage

public Message getMessage()

Description copied from interface: QueuedMessage

Get the message queued

Specified by:

getMessage in interface QueuedMessage

getDeliveryMode

public QueuedMessage.DeliveryMode getDeliveryMode()

Description copied from interface: QueuedMessage

Get the message's QueuedMessage.DeliveryMode

Specified by:

getDeliveryMode in interface QueuedMessage

Returns:

the message's QueuedMessage.DeliveryMode

isBeingDelivered

public boolean isBeingDelivered()

Description copied from interface: QueuedMessage

Is the message currently being delivered to a message consumer

Specified by:

isBeingDelivered in interface QueuedMessage

Returns:

s the message currently being delivered to a message consumer

getAddedTimestamp

public OffsetDateTime getAddedTimestamp()

Description copied from interface: QueuedMessage

When was this message first enqueued (or directly added as a Dead-letter-message)

Specified by:

getAddedTimestamp in interface QueuedMessage

Returns:

when was this message first enqueued

getNextDeliveryTimestamp

public OffsetDateTime getNextDeliveryTimestamp()

Description copied from interface: QueuedMessage

Timestamp for when the message should be delivered next time. Null if QueuedMessage.isDeadLetterMessage() is true

Specified by:

getNextDeliveryTimestamp in interface QueuedMessage

Returns:

timestamp for when the message should be delivered next time. Null if QueuedMessage.isDeadLetterMessage() is true

getDeliveryTimestamp

public OffsetDateTime getDeliveryTimestamp()

Description copied from interface: QueuedMessage

If QueuedMessage.isBeingDelivered() is true, then QueuedMessage.getDeliveryTimestamp() returns the timestamp for when the message delivery started. Otherwise, this property is null.

Specified by:

getDeliveryTimestamp in interface QueuedMessage

Returns:

the timestamp for when the message delivery started

markForRedeliveryIn

public void markForRedeliveryIn(Duration deliveryDelay)

Description copied from interface: QueuedMessage

Mark the message for redelivery with the specified deliveryDelay - this manually requested redelivery counts towards the specified RedeliveryPolicy.maximumNumberOfRedeliveries
A QueuedMessageHandler can choose to call this method directly to have the message be redelivered.
Note: A QueuedMessageHandler should never directly call DurableQueues.retryMessage(RetryMessage) as this doesn't set the QueuedMessage.isManuallyMarkedForRedelivery() flag which the DefaultDurableQueueConsumer relies upon for manually requested message redeliveries

Specified by:

markForRedeliveryIn in interface QueuedMessage

Parameters:

deliveryDelay - how long will the queue wait until it delivers the message to the DurableQueueConsumer

isManuallyMarkedForRedelivery

public boolean isManuallyMarkedForRedelivery()

Description copied from interface: QueuedMessage

Is the message marked for redelivery - i.e. QueuedMessage.markForRedeliveryIn(Duration) has been called on the message

Specified by:

isManuallyMarkedForRedelivery in interface QueuedMessage

Returns:

Is the message marked for redelivery

getRedeliveryDelay

public Duration getRedeliveryDelay()

Description copied from interface: QueuedMessage

In case QueuedMessage.isManuallyMarkedForRedelivery() returns true, then this method will return the requested redelivery delay

Specified by:

getRedeliveryDelay in interface QueuedMessage

Returns:

how long will the queue wait until it delivers the message to the DurableQueueConsumer

getLastDeliveryError

public String getLastDeliveryError()

Description copied from interface: QueuedMessage

Get the error from the last delivery (null if no error is recorded)

Specified by:

getLastDeliveryError in interface QueuedMessage

Returns:

Get the error from the last delivery (null if no error is recorded)

getTotalDeliveryAttempts

public int getTotalDeliveryAttempts()

Description copied from interface: QueuedMessage

Get the total number of delivery attempts for this message

Specified by:

getTotalDeliveryAttempts in interface QueuedMessage

Returns:

the total number of delivery attempts for this message

getRedeliveryAttempts

public int getRedeliveryAttempts()

Description copied from interface: QueuedMessage

How many times has we attempted to re-deliver this message (same as QueuedMessage.getTotalDeliveryAttempts()-1)

Specified by:

getRedeliveryAttempts in interface QueuedMessage

Returns:

how many times has we attempted to re-deliver this message (same as QueuedMessage.getTotalDeliveryAttempts()-1)

isDeadLetterMessage

public boolean isDeadLetterMessage()

Description copied from interface: QueuedMessage

Is this a poison/dead-letter message that will not be delivered until DurableQueues.resurrectDeadLetterMessage(ResurrectDeadLetterMessage) is called

Specified by:

isDeadLetterMessage in interface QueuedMessage

Returns:

Is this a poison/dead-letter message

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object