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

Class JpaSequencedDeadLetterQueue.Builder<T extends EventMessage>

java.lang.Object

org.axonframework.messaging.eventhandling.deadletter.jpa.JpaSequencedDeadLetterQueue.Builder<T>

Type Parameters:

T - The type of Message maintained in this JpaSequencedDeadLetterQueue.

Enclosing class:

JpaSequencedDeadLetterQueue<M extends EventMessage>

public static class JpaSequencedDeadLetterQueue.Builder<T extends EventMessage>
extends Object

Builder class to instantiate an JpaSequencedDeadLetterQueue.

The maximum number of unique sequences defaults to 1024, the maximum amount of dead letters inside a unique sequence to 1024, the claim duration defaults to 30 seconds, the query page size defaults to 100, and the converter defaults to EventMessageDeadLetterJpaConverter.

The processingGroup, TransactionalExecutorProvider, eventConverter, and genericConverter have to be configured for the JpaSequencedDeadLetterQueue to be constructed.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
JpaSequencedDeadLetterQueue<T>	build()	Initializes a JpaSequencedDeadLetterQueue as specified through this Builder.
JpaSequencedDeadLetterQueue.Builder<T>	claimDuration(Duration claimDuration)	Sets the claim duration, which is the time a message gets locked when processing and waiting for it to complete.
JpaSequencedDeadLetterQueue.Builder<T>	converter(DeadLetterJpaConverter<EventMessage> converter)	Sets the DeadLetterJpaConverter used to convert EventMessages to and from DeadLetterEventEntries.
JpaSequencedDeadLetterQueue.Builder<T>	eventConverter(EventConverter eventConverter)	Sets the EventConverter to convert the event payload and metadata of the DeadLetter when storing it to and retrieving it from the database.
JpaSequencedDeadLetterQueue.Builder<T>	genericConverter(Converter genericConverter)	Sets the Converter to convert the tracking token and diagnostics of the DeadLetter when storing it to and retrieving it from the database.
JpaSequencedDeadLetterQueue.Builder<T>	maxSequences(int maxSequences)	Sets the maximum number of unique sequences this SequencedDeadLetterQueue may contain.
JpaSequencedDeadLetterQueue.Builder<T>	maxSequenceSize(int maxSequenceSize)	Sets the maximum amount of letters per unique sequences this SequencedDeadLetterQueue can store.
JpaSequencedDeadLetterQueue.Builder<T>	processingGroup(String processingGroup)	Sets the processing group, which is used for storing and querying which event processor the dead-lettered item belonged to.
JpaSequencedDeadLetterQueue.Builder<T>	queryPageSize(int queryPageSize)	Modifies the page size used when retrieving a sequence of dead letters.
JpaSequencedDeadLetterQueue.Builder<T>	transactionalExecutorProvider(TransactionalExecutorProvider<jakarta.persistence.EntityManager> transactionalExecutorProvider)	Sets the TransactionalExecutorProvider which provides the TransactionalExecutor used to execute operations against the underlying database for this JpaSequencedDeadLetterQueue implementation.
protected void	validate()	Validate whether the fields contained in this Builder are set accordingly.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

processingGroup

public JpaSequencedDeadLetterQueue.Builder<T> processingGroup(String processingGroup)

Sets the processing group, which is used for storing and querying which event processor the dead-lettered item belonged to.

Parameters:

processingGroup - The processing group of this SequencedDeadLetterQueue.

Returns:

the current Builder instance, for fluent interfacing

maxSequences

public JpaSequencedDeadLetterQueue.Builder<T> maxSequences(int maxSequences)

Sets the maximum number of unique sequences this SequencedDeadLetterQueue may contain.

The given maxSequences is required to be a strictly positive number (greater than 0). It defaults to 1024.

Parameters:

maxSequences - The maximum amount of unique sequences for the queue under construction.

Returns:

The current Builder, for fluent interfacing.

maxSequenceSize

public JpaSequencedDeadLetterQueue.Builder<T> maxSequenceSize(int maxSequenceSize)

Sets the maximum amount of letters per unique sequences this SequencedDeadLetterQueue can store.

The given maxSequenceSize is required to be a strictly positive number (greater than 0). It defaults to 1024.

Parameters:

maxSequenceSize - The maximum amount of letters per unique sequence.

Returns:

The current Builder, for fluent interfacing.

transactionalExecutorProvider

public JpaSequencedDeadLetterQueue.Builder<T> transactionalExecutorProvider(TransactionalExecutorProvider<jakarta.persistence.EntityManager> transactionalExecutorProvider)

Sets the TransactionalExecutorProvider which provides the TransactionalExecutor used to execute operations against the underlying database for this JpaSequencedDeadLetterQueue implementation.

Parameters:

transactionalExecutorProvider - A TransactionalExecutorProvider providing TransactionalExecutors used to access the underlying database.

Returns:

the current Builder instance, for fluent interfacing

eventConverter

public JpaSequencedDeadLetterQueue.Builder<T> eventConverter(EventConverter eventConverter)

Sets the EventConverter to convert the event payload and metadata of the DeadLetter when storing it to and retrieving it from the database.

Parameters:

eventConverter - The event converter to use for payload and metadata conversion.

Returns:

the current Builder instance, for fluent interfacing

genericConverter

public JpaSequencedDeadLetterQueue.Builder<T> genericConverter(Converter genericConverter)

Sets the Converter to convert the tracking token and diagnostics of the DeadLetter when storing it to and retrieving it from the database.

Parameters:

genericConverter - The converter to use for tracking token and diagnostics conversion.

Returns:

the current Builder instance, for fluent interfacing

converter

public JpaSequencedDeadLetterQueue.Builder<T> converter(DeadLetterJpaConverter<EventMessage> converter)

Sets the DeadLetterJpaConverter used to convert EventMessages to and from DeadLetterEventEntries. Defaults to EventMessageDeadLetterJpaConverter.

Parameters:

converter - The converter to use.

Returns:

the current Builder instance, for fluent interfacing

claimDuration

public JpaSequencedDeadLetterQueue.Builder<T> claimDuration(Duration claimDuration)

Sets the claim duration, which is the time a message gets locked when processing and waiting for it to complete. Other invocations of the JpaSequencedDeadLetterQueue.process(Predicate, Function, ProcessingContext) method will be unable to process a sequence while the claim is active. Its default is 30 seconds.

Claims are automatically released once the item is requeued, the claim time is a backup policy in case of unforeseen trouble such as down database connections.

Parameters:

claimDuration - The longest claim duration allowed.

Returns:

the current Builder instance, for fluent interfacing

queryPageSize

public JpaSequencedDeadLetterQueue.Builder<T> queryPageSize(int queryPageSize)

Modifies the page size used when retrieving a sequence of dead letters. Defaults to 100 items in a page.

Parameters:

queryPageSize - The page size

Returns:

the current Builder instance, for fluent interfacing

build

public JpaSequencedDeadLetterQueue<T> build()

Initializes a JpaSequencedDeadLetterQueue as specified through this Builder.

Returns:

A JpaSequencedDeadLetterQueue as specified through this Builder.

validate

protected void validate()

Validate whether the fields contained in this Builder are set accordingly.

Throws:

AxonConfigurationException - When one field asserts to be incorrect according to the Builder's specifications.