Package org.axonframework.messaging.eventhandling.deadletter.jpa

Class JpaSequencedDeadLetterQueue<M extends EventMessage>

java.lang.Object

org.axonframework.messaging.eventhandling.deadletter.jpa.JpaSequencedDeadLetterQueue<M>

Type Parameters:

M - An implementation of Message contained in the dead-letters within this queue.

All Implemented Interfaces:

SequencedDeadLetterQueue<M>

public class JpaSequencedDeadLetterQueue<M extends EventMessage>
extends Object
implements SequencedDeadLetterQueue<M>

JPA-backed implementation of the SequencedDeadLetterQueue, used for storing dead letters containing EventMessages durably as a DeadLetterEntry.

Keeps the insertion order intact by saving an incremented index within each unique sequence, backed by the DeadLetterEntry.getSequenceIndex() property. Each sequence is uniquely identified by the sequence identifier, stored in the DeadLetterEntry.getSequenceIdentifier() field.

When processing an item, single execution across all applications is guaranteed by setting the DeadLetterEntry.getProcessingStarted() property, locking other processes out of the sequence for the configured claimDuration (30 seconds by default).

The stored entries are converted to a JpaDeadLetter when they need to be processed or filtered. In order to restore the original EventMessage the configured DeadLetterJpaConverter is used. The default EventMessageDeadLetterJpaConverter supports all EventMessage implementations provided by the framework.

invalid reference

upcasters

are not supported by this implementation, so breaking changes for events messages stored in the queue should be avoided.

Since:

4.6.0

Author:

Mitchell Herrijgers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JpaSequencedDeadLetterQueue.Builder<T extends EventMessage>	Builder class to instantiate an JpaSequencedDeadLetterQueue.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JpaSequencedDeadLetterQueue(JpaSequencedDeadLetterQueue.Builder<T> builder)	Instantiate a JPA SequencedDeadLetterQueue based on the given builder.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Long>	amountOfSequences(@Nullable ProcessingContext context)	Returns the number of unique sequences contained in this queue.
static <M extends EventMessage> JpaSequencedDeadLetterQueue.Builder<M>	builder()	Creates a new builder, capable of building a JpaSequencedDeadLetterQueue according to the provided configuration.
CompletableFuture<Void>	clear(@Nullable ProcessingContext context)	Clears out all dead letters present in this queue.
CompletableFuture<Boolean>	contains(Object sequenceIdentifier, @Nullable ProcessingContext context)	Check whether there's a sequence of dead letters for the given sequenceIdentifier.
CompletableFuture<Iterable<Iterable<DeadLetter<? extends M>>>>	deadLetters(@Nullable ProcessingContext context)	Return all dead letter sequences held by this queue.
CompletableFuture<Iterable<DeadLetter<? extends M>>>	deadLetterSequence(Object sequenceIdentifier, @Nullable ProcessingContext context)	Return all the dead letters for the given sequenceIdentifier in insert order.
CompletableFuture<Void>	enqueue(Object sequenceIdentifier, DeadLetter<? extends M> letter, @Nullable ProcessingContext context)	Enqueues a dead letter containing an implementation of M to this queue.
CompletableFuture<Void>	evict(DeadLetter<? extends M> letter, @Nullable ProcessingContext context)	Evict the given letter from this queue.
CompletableFuture<Boolean>	isFull(Object sequenceIdentifier, @Nullable ProcessingContext context)	Validates whether this queue is full for the given sequenceIdentifier.
CompletableFuture<Boolean>	process(Function<DeadLetter<? extends M>,CompletableFuture<EnqueueDecision<M>>> processingTask, @Nullable ProcessingContext context)	Process a single sequence of enqueued dead letters with the given processingTask.
CompletableFuture<Boolean>	process(Predicate<DeadLetter<? extends M>> sequenceFilter, Function<DeadLetter<? extends M>,CompletableFuture<EnqueueDecision<M>>> processingTask, @Nullable ProcessingContext context)	Process a single sequence of enqueued dead letters through the given processingTask matching the sequenceFilter.
CompletableFuture<Void>	requeue(DeadLetter<? extends M> letter, UnaryOperator<DeadLetter<? extends M>> letterUpdater, @Nullable ProcessingContext context)	Reenters the given letter, updating the contents with the letterUpdater.
CompletableFuture<Long>	sequenceSize(Object sequenceIdentifier, @Nullable ProcessingContext context)	Returns the number of dead letters for the sequence matching the given sequenceIdentifier contained in this queue.
CompletableFuture<Long>	size(@Nullable ProcessingContext context)	Returns the number of dead letters contained in this queue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

enqueueIfPresent

Constructor Details

JpaSequencedDeadLetterQueue

protected JpaSequencedDeadLetterQueue(JpaSequencedDeadLetterQueue.Builder<T> builder)

Instantiate a JPA SequencedDeadLetterQueue based on the given builder.

Parameters:

builder - The JpaSequencedDeadLetterQueue.Builder used to instantiate a JpaSequencedDeadLetterQueue instance.

Method Details

builder

public static <M extends EventMessage>
JpaSequencedDeadLetterQueue.Builder<M> builder()

Creates a new builder, capable of building a JpaSequencedDeadLetterQueue according to the provided configuration. Note that the JpaSequencedDeadLetterQueue.Builder.processingGroup(String), JpaSequencedDeadLetterQueue.Builder.transactionalExecutorProvider(TransactionalExecutorProvider), JpaSequencedDeadLetterQueue.Builder.eventConverter(EventConverter), and JpaSequencedDeadLetterQueue.Builder.genericConverter(Converter) are mandatory for the queue to be constructed.

Type Parameters:

M - An implementation of Message contained in the dead-letters within this queue.

Returns:

The builder

enqueue

public CompletableFuture<Void> enqueue(Object sequenceIdentifier,
 DeadLetter<? extends M> letter,
 @Nullable ProcessingContext context)

Description copied from interface: SequencedDeadLetterQueue

Enqueues a dead letter containing an implementation of M to this queue.

The dead letter will be appended to a sequence depending on the sequenceIdentifier. If there is no sequence yet, it will construct one.

Specified by:

enqueue in interface SequencedDeadLetterQueue<M extends EventMessage>

Parameters:

sequenceIdentifier - The identifier of the sequence the letter belongs to.

letter - The DeadLetter to enqueue.

context - the processing context within which to enqueue the given letter

Returns:

A CompletableFuture that completes when the operation is done. The future completes exceptionally with a DeadLetterQueueOverflowException when this queue is full.

evict

public CompletableFuture<Void> evict(DeadLetter<? extends M> letter,
 @Nullable ProcessingContext context)

Description copied from interface: SequencedDeadLetterQueue

Evict the given letter from this queue. Nothing happens if the dead letter does not exist in this queue.

Specified by:

evict in interface SequencedDeadLetterQueue<M extends EventMessage>

Parameters:

letter - The dead letter to evict from this queue.

context - the processing context within which to evict the given letter

Returns:

A CompletableFuture that completes when the eviction is done.

requeue

public CompletableFuture<Void> requeue(DeadLetter<? extends M> letter,
 UnaryOperator<DeadLetter<? extends M>> letterUpdater,
 @Nullable ProcessingContext context)

Description copied from interface: SequencedDeadLetterQueue

Reenters the given letter, updating the contents with the letterUpdater. This method should be invoked if processing decided to keep the letter in the queue.

This operation adjusts the DeadLetter.lastTouched(). It may adjust the DeadLetter.cause() and DeadLetter.diagnostics(), depending on the given letterUpdater.

Specified by:

requeue in interface SequencedDeadLetterQueue<M extends EventMessage>

Parameters:

letter - The dead letter to reenter in this queue.

letterUpdater - A lambda taking in the given letter and updating the entry for requeueing. This may adjust the DeadLetter.cause() and DeadLetter.diagnostics(), for example.

context - the processing context within which to requeue the given letter

Returns:

A CompletableFuture that completes when the requeue is done. The future completes exceptionally with a NoSuchDeadLetterException if the given letter does not exist in the queue.

contains

public CompletableFuture<Boolean> contains(Object sequenceIdentifier,
 @Nullable ProcessingContext context)

Description copied from interface: SequencedDeadLetterQueue

Check whether there's a sequence of dead letters for the given sequenceIdentifier.

Specified by:

contains in interface SequencedDeadLetterQueue<M extends EventMessage>

Parameters:

sequenceIdentifier - The identifier used to validate for contained dead letters instances.

context - the ProcessingContext wherein this operation is invoked, if any

Returns:

A CompletableFuture with true if there are dead letters present for the given sequenceIdentifier, false otherwise.

deadLetterSequence

public CompletableFuture<Iterable<DeadLetter<? extends M>>> deadLetterSequence(Object sequenceIdentifier,
 @Nullable ProcessingContext context)

Description copied from interface: SequencedDeadLetterQueue

Return all the dead letters for the given sequenceIdentifier in insert order.

Specified by:

deadLetterSequence in interface SequencedDeadLetterQueue<M extends EventMessage>

Parameters:

sequenceIdentifier - The identifier of the sequence of dead letters to return.

context - the ProcessingContext wherein this operation is invoked, if any

Returns:

A CompletableFuture with all the dead letters for the given sequenceIdentifier in insert order.

deadLetters

public CompletableFuture<Iterable<Iterable<DeadLetter<? extends M>>>> deadLetters(@Nullable ProcessingContext context)

Description copied from interface: SequencedDeadLetterQueue

Return all dead letter sequences held by this queue. The sequences are not necessarily returned in insert order.

Specified by:

deadLetters in interface SequencedDeadLetterQueue<M extends EventMessage>

Parameters:

context - the ProcessingContext wherein this operation is invoked, if any

Returns:

A CompletableFuture with all dead letter sequences held by this queue.

isFull

public CompletableFuture<Boolean> isFull(Object sequenceIdentifier,
 @Nullable ProcessingContext context)

Description copied from interface: SequencedDeadLetterQueue

Validates whether this queue is full for the given sequenceIdentifier.

This method returns true either when the maximum amount of sequences or the maximum sequence size is reached.

Specified by:

isFull in interface SequencedDeadLetterQueue<M extends EventMessage>

Parameters:

sequenceIdentifier - The identifier of the sequence to validate for.

context - the ProcessingContext wherein this operation is invoked, if any

Returns:

A CompletableFuture with true either when the limit of this queue is reached. Contains false otherwise.

process

public CompletableFuture<Boolean> process(Function<DeadLetter<? extends M>,CompletableFuture<EnqueueDecision<M>>> processingTask,
 @Nullable ProcessingContext context)

Process a single sequence of enqueued dead letters with the given processingTask. It will pick the oldest available sequence, determined by the DeadLetter.lastTouched() field of the first entry in each sequence.

Note that only a single matching sequence is processed!

Uses the EnqueueDecision returned by the processingTask to decide whether to SequencedDeadLetterQueue.evict(DeadLetter, ProcessingContext) or SequencedDeadLetterQueue.requeue(DeadLetter, UnaryOperator, ProcessingContext) the dead letter. The processingTask is invoked as long as letters are present in the selected sequence and the result of processing returns false for EnqueueDecision.shouldEnqueue() decision. The latter means the dead letter should be evicted.

This operation protects against concurrent invocations of the processingTask on the filtered sequence. Doing so ensures enqueued messages are handled in order.

Optimized override that retrieves available sequences one at a time (page size of 1) instead of in batches. Since no sequenceFilter is applied, every available sequence is a valid candidate, so there is no need to prefetch multiple sequences. This avoids unnecessary deserialization of dead letter entries that will never be evaluated.

Specified by:

process in interface SequencedDeadLetterQueue<M extends EventMessage>

Parameters:

processingTask - A function processing a dead letter. Returns a CompletableFuture with an EnqueueDecision used to deduce whether to SequencedDeadLetterQueue.evict(DeadLetter, ProcessingContext) or SequencedDeadLetterQueue.requeue(DeadLetter, UnaryOperator, ProcessingContext) the dead letter.

context - the ProcessingContext in which the dead letters are processed

Returns:

A CompletableFuture with true if an entire sequence of dead letters was processed successfully, false otherwise. This means the processingTask processed all dead letters of a sequence and the outcome was to evict each instance.

See Also:

• process(Predicate, Function, ProcessingContext)

process

public CompletableFuture<Boolean> process(Predicate<DeadLetter<? extends M>> sequenceFilter,
 Function<DeadLetter<? extends M>,CompletableFuture<EnqueueDecision<M>>> processingTask,
 @Nullable ProcessingContext context)

Description copied from interface: SequencedDeadLetterQueue

Process a single sequence of enqueued dead letters through the given processingTask matching the sequenceFilter. It will pick the oldest available sequence, determined by the DeadLetter.lastTouched() field of the first entry in each sequence.

Note that only a single matching sequence is processed! Furthermore, only the first dead letter is validated, because it is the blocker for the processing of the rest of the sequence.

Uses the EnqueueDecision returned by the processingTask to decide whether to SequencedDeadLetterQueue.evict(DeadLetter, ProcessingContext) or SequencedDeadLetterQueue.requeue(DeadLetter, UnaryOperator, ProcessingContext) a dead letter from the selected sequence. The processingTask is invoked as long as letters are present in the selected sequence and the result of processing returns false for EnqueueDecision.shouldEnqueue() decision. The latter means the dead letter should be evicted.

This operation protects against concurrent invocations of the processingTask on the filtered sequence. Doing so ensures enqueued messages are handled in order.

Specified by:

process in interface SequencedDeadLetterQueue<M extends EventMessage>

Parameters:

sequenceFilter - A lambda selecting the sequences within this queue to process with the processingTask.

processingTask - A function processing a dead letter. Returns a CompletableFuture with an EnqueueDecision used to deduce whether to SequencedDeadLetterQueue.evict(DeadLetter, ProcessingContext) or SequencedDeadLetterQueue.requeue(DeadLetter, UnaryOperator, ProcessingContext) the dead letter.

context - the ProcessingContext in which the dead letters are processed

Returns:

A CompletableFuture with true if an entire sequence of dead letters was processed successfully, false otherwise. This means the processingTask processed all dead letters of a sequence and the outcome was to evict each instance.

clear

public CompletableFuture<Void> clear(@Nullable ProcessingContext context)

Description copied from interface: SequencedDeadLetterQueue

Clears out all dead letters present in this queue.

Specified by:

clear in interface SequencedDeadLetterQueue<M extends EventMessage>

Parameters:

context - the ProcessingContext wherein this operation is invoked, if any

Returns:

A CompletableFuture that completes when all dead letters have been cleared.

sequenceSize

public CompletableFuture<Long> sequenceSize(Object sequenceIdentifier,
 @Nullable ProcessingContext context)

Description copied from interface: SequencedDeadLetterQueue

Returns the number of dead letters for the sequence matching the given sequenceIdentifier contained in this queue.

Note that there's a window of opportunity where the size might exceed the maximum sequence size to account for concurrent usage.

Specified by:

sequenceSize in interface SequencedDeadLetterQueue<M extends EventMessage>

Parameters:

sequenceIdentifier - The identifier of the sequence to retrieve the size from.

context - the ProcessingContext wherein this operation is invoked, if any

Returns:

A CompletableFuture with the number of dead letters for the sequence matching the given sequenceIdentifier.

size

public CompletableFuture<Long> size(@Nullable ProcessingContext context)

Description copied from interface: SequencedDeadLetterQueue

Returns the number of dead letters contained in this queue.

Specified by:

size in interface SequencedDeadLetterQueue<M extends EventMessage>

Parameters:

context - the ProcessingContext wherein this operation is invoked, if any

Returns:

A CompletableFuture with the number of dead letters contained in this queue.

amountOfSequences

public CompletableFuture<Long> amountOfSequences(@Nullable ProcessingContext context)

Description copied from interface: SequencedDeadLetterQueue

Returns the number of unique sequences contained in this queue.

Note that there's a window of opportunity where the size might exceed the maximum amount of sequences to account for concurrent usage of this dead letter queue.

Specified by:

amountOfSequences in interface SequencedDeadLetterQueue<M extends EventMessage>

Parameters:

context - the ProcessingContext wherein this operation is invoked, if any

Returns:

A CompletableFuture with the number of unique sequences contained in this queue.