Package org.axonframework.eventhandling.deadletter.jdbc

Class JdbcSequencedDeadLetterQueue.Builder<E extends EventMessage<?>>

java.lang.Object

org.axonframework.eventhandling.deadletter.jdbc.JdbcSequencedDeadLetterQueue.Builder<E>

Type Parameters:

E - The type of EventMessage maintained in the dead letter of this SequencedDeadLetterQueue.

Enclosing class:

JdbcSequencedDeadLetterQueue<E extends EventMessage<?>>

public static class JdbcSequencedDeadLetterQueue.Builder<E extends EventMessage<?>>
extends Object

Builder class to instantiate an JdbcSequencedDeadLetterQueue.

The following defaults are set by the builder:

• The table's schema defaults to a DeadLetterSchema.defaultSchema().
• The maximum amount of sequences defaults to 1024.
• The maximum sequence size defaults to 1024.
• The page size defaults to 100.
• The claim duration defaults to 30 seconds.

The processing group, ConnectionProvider, and TransactionManager are hard requirements and should be provided.

The statementFactory(DeadLetterStatementFactory) and converter(DeadLetterJdbcConverter) are also hard requirements, but users can choose to either set both explicitly or rely on the DefaultDeadLetterStatementFactory and DefaultDeadLetterJdbcConverter constructed through the generic Serializer and event Serializer.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
JdbcSequencedDeadLetterQueue<E>	build()	Initializes a JdbcSequencedDeadLetterQueue as specified through this Builder.
JdbcSequencedDeadLetterQueue.Builder<E>	claimDuration(Duration claimDuration)	Sets the claim duration, which is the time a dead-letter gets locked when processing and waiting for it to complete.
JdbcSequencedDeadLetterQueue.Builder<E>	connectionProvider(ConnectionProvider connectionProvider)	Sets the ConnectionProvider which provides access to a JDBC connection.
JdbcSequencedDeadLetterQueue.Builder<E>	converter(DeadLetterJdbcConverter<E,? extends JdbcDeadLetter<E>> converter)	Sets the DeadLetterJdbcConverter used to convert a ResultSet into a JdbcDeadLetter implementation.
JdbcSequencedDeadLetterQueue.Builder<E>	eventSerializer(Serializer eventSerializer)	Sets the Serializer to (de)serialize the events, metadata and diagnostics of the DeadLetter when storing it to a database.
JdbcSequencedDeadLetterQueue.Builder<E>	genericSerializer(Serializer genericSerializer)	Sets the Serializer to (de)serialize the TrackingToken (if present) of the event in the DeadLetter when storing it to the database.
JdbcSequencedDeadLetterQueue.Builder<E>	maxSequences(int maxSequences)	Sets the maximum number of unique sequences this SequencedDeadLetterQueue may contain.
JdbcSequencedDeadLetterQueue.Builder<E>	maxSequenceSize(int maxSequenceSize)	Sets the maximum amount of letters per unique sequences this SequencedDeadLetterQueue can store.
JdbcSequencedDeadLetterQueue.Builder<E>	pageSize(int pageSize)	Modifies the page size used when retrieving a sequence of dead letters.
JdbcSequencedDeadLetterQueue.Builder<E>	processingGroup(String processingGroup)	Sets the processing group, which is used for storing and querying which processing group a dead-lettered EventMessage belonged to.
JdbcSequencedDeadLetterQueue.Builder<E>	schema(DeadLetterSchema schema)	Sets the DeadLetterSchema used to constructs the table and indices required by this SequencedDeadLetterQueue.
JdbcSequencedDeadLetterQueue.Builder<E>	statementFactory(DeadLetterStatementFactory<E> statementFactory)	Sets the DeadLetterStatementFactory used to construct all PreparedStatements executed by this SequencedDeadLetterQueue.
JdbcSequencedDeadLetterQueue.Builder<E>	transactionManager(TransactionManager transactionManager)	Sets the TransactionManager used to manage transaction around fetching dead-letter data.
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 JdbcSequencedDeadLetterQueue.Builder<E> processingGroup(@Nonnull
 String processingGroup)

Sets the processing group, which is used for storing and querying which processing group a dead-lettered EventMessage belonged to.

Parameters:

processingGroup - The processing group of this SequencedDeadLetterQueue.

Returns:

The current Builder instance, for fluent interfacing.

connectionProvider

public JdbcSequencedDeadLetterQueue.Builder<E> connectionProvider(@Nonnull
 ConnectionProvider connectionProvider)

Sets the ConnectionProvider which provides access to a JDBC connection.

Parameters:

connectionProvider - a ConnectionProvider which provides access to a JDBC connection

Returns:

The current Builder instance, for fluent interfacing.

transactionManager

public JdbcSequencedDeadLetterQueue.Builder<E> transactionManager(@Nonnull
 TransactionManager transactionManager)

Sets the TransactionManager used to manage transaction around fetching dead-letter data.

Parameters:

transactionManager - A TransactionManager used to manage transaction around fetching dead-letter data.

Returns:

The current Builder instance, for fluent interfacing.

schema

public JdbcSequencedDeadLetterQueue.Builder<E> schema(@Nonnull
 DeadLetterSchema schema)

Sets the DeadLetterSchema used to constructs the table and indices required by this SequencedDeadLetterQueue.

The schema will be used to construct the DeadLetterStatementFactory when it is not explicitly configured.

Defaults to the default schema configuration.

Parameters:

schema - The DeadLetterSchema used to constructs the table and indices required by this dead-letter queue.

Returns:

The current Builder, for fluent interfacing.

statementFactory

public JdbcSequencedDeadLetterQueue.Builder<E> statementFactory(@Nonnull
 DeadLetterStatementFactory<E> statementFactory)

Sets the DeadLetterStatementFactory used to construct all PreparedStatements executed by this SequencedDeadLetterQueue.

When the statementFactory is not explicitly configured, this builder defaults to the DefaultDeadLetterStatementFactory. To construct the DefaultDeadLetterStatementFactory, the configured schema, generic Serializer, and event Serializer are used.

Parameters:

statementFactory - The DeadLetterStatementFactory used to construct all PreparedStatements executed by this SequencedDeadLetterQueue.

Returns:

The current Builder, for fluent interfacing.

converter

public JdbcSequencedDeadLetterQueue.Builder<E> converter(@Nonnull
 DeadLetterJdbcConverter<E,? extends JdbcDeadLetter<E>> converter)

Sets the DeadLetterJdbcConverter used to convert a ResultSet into a JdbcDeadLetter implementation. The converter is, for example, used to service the JdbcSequencedDeadLetterQueue.deadLetters() and JdbcSequencedDeadLetterQueue.deadLetterSequence(Object) operations.

When the converter is not explicitly configured, this builder defaults to the DefaultDeadLetterJdbcConverter. To construct the DefaultDeadLetterJdbcConverter, the configured generic Serializer, and event Serializer are used.

Parameters:

converter - The DeadLetterJdbcConverter used to convert a ResultSet into a JdbcDeadLetter implementation.

Returns:

The current Builder, for fluent interfacing.

genericSerializer

public JdbcSequencedDeadLetterQueue.Builder<E> genericSerializer(@Nonnull
 Serializer genericSerializer)

Sets the Serializer to (de)serialize the TrackingToken (if present) of the event in the DeadLetter when storing it to the database.

The genericSerializer will be used to construct the DeadLetterStatementFactory and/or DeadLetterJdbcConverter when either of them are not explicitly configured.

Parameters:

genericSerializer - The serializer to use.

Returns:

The current Builder instance, for fluent interfacing.

eventSerializer

public JdbcSequencedDeadLetterQueue.Builder<E> eventSerializer(@Nonnull
 Serializer eventSerializer)

Sets the Serializer to (de)serialize the events, metadata and diagnostics of the DeadLetter when storing it to a database.

The eventSerializer will be used to construct the DeadLetterStatementFactory and/or DeadLetterJdbcConverter when either of them are not explicitly configured.

Parameters:

eventSerializer - The serializer to use.

Returns:

The current Builder instance, for fluent interfacing.

maxSequences

public JdbcSequencedDeadLetterQueue.Builder<E> maxSequences(int maxSequences)

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

The given maxSequences is required to be a positive number. The maximum number of unique sequences 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 JdbcSequencedDeadLetterQueue.Builder<E> maxSequenceSize(int maxSequenceSize)

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

The given maxSequenceSize is required to be a positive number. The maximum amount of letters per unique sequence defaults to 1024.

Parameters:

maxSequenceSize - The maximum amount of letters per unique sequence.

Returns:

The current Builder, for fluent interfacing.

claimDuration

public JdbcSequencedDeadLetterQueue.Builder<E> claimDuration(@Nonnull
 Duration claimDuration)

Sets the claim duration, which is the time a dead-letter gets locked when processing and waiting for it to complete. Other invocations of the JdbcSequencedDeadLetterQueue.process(Predicate, Function) method will be unable to process a sequence while the claim is active. The claim duration defaults to 30 seconds.

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

Parameters:

claimDuration - The longest claim duration allowed.

Returns:

The current Builder instance, for fluent interfacing.

pageSize

public JdbcSequencedDeadLetterQueue.Builder<E> pageSize(int pageSize)

Modifies the page size used when retrieving a sequence of dead letters.

Used during the JdbcSequencedDeadLetterQueue.deadLetterSequence(Object) and JdbcSequencedDeadLetterQueue.deadLetters() operations. Defaults to a 100.

Parameters:

pageSize - The page size used when retrieving a sequence of dead letters.

Returns:

The current Builder instance, for fluent interfacing.

build

public JdbcSequencedDeadLetterQueue<E> build()

Initializes a JdbcSequencedDeadLetterQueue as specified through this Builder.

Returns:

A JdbcSequencedDeadLetterQueue 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.