Package org.axonframework.eventhandling.deadletter.jpa

Class JpaDeadLetter<M extends EventMessage<?>>

java.lang.Object

org.axonframework.eventhandling.deadletter.jpa.JpaDeadLetter<M>

Type Parameters:

M - The EventMessage type of the contained message.

All Implemented Interfaces:

DeadLetter<M>

public class JpaDeadLetter<M extends EventMessage<?>>
extends Object
implements DeadLetter<M>

A DeadLetter that was saved to the 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.6.0

Author:

Mitchell Herrijgers

Constructor Summary

Constructors

Constructor	Description
JpaDeadLetter(DeadLetterEntry entry, MetaData diagnostics, M message)	Constructs a new JpaDeadLetter from a DeadLetterEntry, deserialized diagnostics and a reconstructed message.

Method Summary

Modifier and Type	Method	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	getId()	The ID of the entity in the database.
Long	getIndex()	The index of the dead letter within its sequence identified by the sequenceIdentifier.
String	getSequenceIdentifier()	The sequence identifier of this DeadLetter.
int	hashCode()
Instant	lastTouched()	The moment in time when this letter was last touched.
DeadLetter<M>	markTouched()	Construct a copy of this DeadLetter, replacing the DeadLetter.lastTouched() with the current time.
M	message()	The Message of type M contained in this letter.
String	toString()
DeadLetter<M>	withCause(Throwable requeueCause)	Construct a copy of this DeadLetter, replacing the DeadLetter.cause() with the given requeueCause.
DeadLetter<M>	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 Details

JpaDeadLetter

public JpaDeadLetter(DeadLetterEntry entry,
 MetaData diagnostics,
 M message)

Constructs a new JpaDeadLetter from a DeadLetterEntry, deserialized diagnostics and a reconstructed message.

Parameters:

entry - The DeadLetterEntry to construct this letter from.

diagnostics - The deserialized diagnostics MetaData.

message - The reconstructed EventMessage.

Method Details

message

public M message()

Description copied from interface: DeadLetter

The Message of type M contained in this letter.

Specified by:

message in interface DeadLetter<M 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<M 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<M 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<M 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<M extends EventMessage<?>>

Returns:

The diagnostic MetaData concerning this letter.

getId

public String getId()

The ID of the entity in the database.

Returns:

The ID of this JpaDeadLetter.

getIndex

public Long getIndex()

The index of the dead letter within its sequence identified by the sequenceIdentifier. Will ensure the events are kept in the original order.

Returns:

The index of this JpaDeadLetter.

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 is ensured by the getIndex() property.

Returns:

The sequence identifier of this DeadLetter.

markTouched

public DeadLetter<M> 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<M extends EventMessage<?>>

Returns:

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

withCause

public DeadLetter<M> 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<M 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<M> 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<M 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.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object