org.axonframework.eventhandling.deadletter.jdbc

Class JdbcDeadLetter<E extends EventMessage<?>>

java.lang.Object

org.axonframework.eventhandling.deadletter.jdbc.JdbcDeadLetter<E>

Type Parameters:

E - The EventMessage contained in this DeadLetter.

All Implemented Interfaces:

DeadLetter<E>

public class JdbcDeadLetter<E extends EventMessage<?>>
extends Object
implements DeadLetter<E>

A DeadLetter that was saved to a JDBC-backed database and reconstructed from it. This object is immutable and should only be changed using the withCause(Throwable), withDiagnostics(MetaData) and markTouched() functions. These reconstruct a new object with the specified new properties.

Since:

4.8.0

Author:

Mitchell Herrijgers, Steven van Beelen

Constructor Summary

Constructors

Constructor and Description
JdbcDeadLetter(String identifier, long index, String sequenceIdentifier, Instant enqueuedAt, Instant lastTouched, Cause cause, MetaData diagnostics, E message) Constructs a new JdbcDeadLetter with all possible parameters.

Method Summary

Modifier and Type	Method and Description
Optional<Cause>	cause() The cause for the DeadLetter.message() to be dead lettered.
MetaData	diagnostics() The diagnostic MetaData concerning this letter.
Instant	enqueuedAt() The moment in time when the DeadLetter.message() was entered in a dead letter queue.
boolean	equals(Object o)
String	getIdentifier() The identifier of this letter's database entry.
String	getSequenceIdentifier() The sequence identifier of this DeadLetter.
long	getSequenceIndex() The index of this dead letter within its sequence, identified by the sequenceIdentifier.
int	hashCode()
Instant	lastTouched() The moment in time when this letter was last touched.
DeadLetter<E>	markTouched() Construct a copy of this DeadLetter, replacing the DeadLetter.lastTouched() with the current time.
E	message() The Message of type M contained in this letter.
String	toString()
DeadLetter<E>	withCause(Throwable requeueCause) Construct a copy of this DeadLetter, replacing the DeadLetter.cause() with the given requeueCause.
DeadLetter<E>	withDiagnostics(MetaData diagnostics) Construct a copy of this DeadLetter, replacing the DeadLetter.diagnostics() with the given diagnostics.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.messaging.deadletter.DeadLetter

withDiagnostics

Constructor Detail

JdbcDeadLetter

public JdbcDeadLetter(String identifier,
                      long index,
                      String sequenceIdentifier,
                      Instant enqueuedAt,
                      Instant lastTouched,
                      Cause cause,
                      MetaData diagnostics,
                      E message)

Constructs a new JdbcDeadLetter with all possible parameters.

Parameters:

identifier - The identifier of the dead letter.

index - The index of the dead letter.

sequenceIdentifier - The sequence identifier of the dead letter.

enqueuedAt - The time the letter was enqueued.

lastTouched - The time the letter was last touched.

cause - The cause of enqueueing, can be null if it was queued because there was another letter in the same sequence (based on the sequenceIdentifier).

diagnostics - The diagnostics provided during enqueueing.

message - The message that was enqueued.

Method Detail

message

public E message()

Description copied from interface: DeadLetter

The Message of type M contained in this letter.

Specified by:

message in interface DeadLetter<E extends EventMessage<?>>

Returns:

The Message of type M contained in this letter.

cause

public Optional<Cause> cause()

Description copied from interface: DeadLetter

The cause for the DeadLetter.message() to be dead lettered. Can be an Optional.empty() in case this letter is enqueued without a causal error. For instance, when another letter already present in the queue was blocking it being handled.

Specified by:

cause in interface DeadLetter<E extends EventMessage<?>>

Returns:

The cause for the DeadLetter.message() to be dead lettered.

enqueuedAt

public Instant enqueuedAt()

Description copied from interface: DeadLetter

The moment in time when the DeadLetter.message() was entered in a dead letter queue.

Specified by:

enqueuedAt in interface DeadLetter<E extends EventMessage<?>>

Returns:

The moment in time when the DeadLetter.message() was entered in a dead letter queue.

lastTouched

public Instant lastTouched()

Description copied from interface: DeadLetter

The moment in time when this letter was last touched. Will equal the DeadLetter.enqueuedAt() value if this letter is enqueued for the first time.

Specified by:

lastTouched in interface DeadLetter<E extends EventMessage<?>>

Returns:

The moment in time when this letter was last touched.

diagnostics

public MetaData diagnostics()

Description copied from interface: DeadLetter

The diagnostic MetaData concerning this letter.

Specified by:

diagnostics in interface DeadLetter<E extends EventMessage<?>>

Returns:

The diagnostic MetaData concerning this letter.

getIdentifier

public String getIdentifier()

The identifier of this letter's database entry.

Returns:

The identifier of this JdbcDeadLetter.

getSequenceIndex

public long getSequenceIndex()

The index of this dead letter within its sequence, identified by the sequenceIdentifier. The index ensures the events are kept in the original order.

Returns:

The index of this JdbcDeadLetter.

getSequenceIdentifier

public String getSequenceIdentifier()

The sequence identifier of this DeadLetter. If letters belong to the same sequence, they should be handled sequentially at all times. This ordering is maintained through the getSequenceIndex() property.

Returns:

The sequence identifier of this DeadLetter.

markTouched

public DeadLetter<E> markTouched()

Description copied from interface: DeadLetter

Construct a copy of this DeadLetter, replacing the DeadLetter.lastTouched() with the current time.

Specified by:

markTouched in interface DeadLetter<E extends EventMessage<?>>

Returns:

A copy of this DeadLetter with DeadLetter.lastTouched() set to now.

withCause

public DeadLetter<E> withCause(Throwable requeueCause)

Description copied from interface: DeadLetter

Construct a copy of this DeadLetter, replacing the DeadLetter.cause() with the given requeueCause.

Specified by:

withCause in interface DeadLetter<E extends EventMessage<?>>

Parameters:

requeueCause - The new cause of the DeadLetter under construction.

Returns:

A copy of this DeadLetter, replacing the DeadLetter.cause() with the given requeueCause.

withDiagnostics

public DeadLetter<E> withDiagnostics(MetaData diagnostics)

Description copied from interface: DeadLetter

Construct a copy of this DeadLetter, replacing the DeadLetter.diagnostics() with the given diagnostics.

Specified by:

withDiagnostics in interface DeadLetter<E extends EventMessage<?>>

Parameters:

diagnostics - The diagnostic MetaData to append to the DeadLetter under construction.

Returns:

A copy of this DeadLetter, replacing the DeadLetter.diagnostics() with the given diagnostics.

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