Package org.axonframework.extension.springboot.autoconfig

Class JdbcDeadLetterQueueAutoConfiguration

java.lang.Object

org.axonframework.extension.springboot.autoconfig.JdbcDeadLetterQueueAutoConfiguration

@AutoConfiguration(after={JdbcAutoConfiguration.class,ConverterAutoConfiguration.class,JpaDeadLetterQueueAutoConfiguration.class})
@ConditionalOnClass(javax.sql.DataSource.class)
@ConditionalOnBean(javax.sql.DataSource.class)
public class JdbcDeadLetterQueueAutoConfiguration
extends Object

Spring Boot autoconfiguration that registers a JDBC-backed SequencedDeadLetterQueueFactory bean.

This configuration activates when a DataSource bean is present (i.e. JDBC is on the classpath and configured). The registered factory creates a JdbcSequencedDeadLetterQueue instance per event handling component, using the application's DataSource, EventConverter, and Converter. Each queue is scoped by a component-level processing group identifier (e.g. "DeadLetterQueue[myProcessor][0]").

To enable Dead Letter Queue processing for a specific processor, set:

 axon.eventhandling.processors.<processorName>.dlq.enabled=true
 

The cache size used for sequence identifier caching can be tuned per processor:

 axon.eventhandling.processors.<processorName>.dlq.cache.size=2048
 

To replace the default JDBC factory with a custom backend, declare your own SequencedDeadLetterQueueFactory bean — the @ConditionalOnMissingBean guard on the default will yield to it.

Since:

5.1.0

Author:

Mateusz Nowak

See Also:

• SequencedDeadLetterQueueFactory
• JdbcSequencedDeadLetterQueue

Constructor Summary

Constructors

Constructor	Description
JdbcDeadLetterQueueAutoConfiguration()

Method Summary

Modifier and Type	Method	Description
DeadLetterSchema	deadLetterSchema()	Creates a default DeadLetterSchema bean using the default column and table names.
SequencedDeadLetterQueueFactory	jdbcDeadLetterQueueFactory(DataSource dataSource, EventConverter eventConverter, Converter genericConverter, DeadLetterSchema schema)	Creates a JDBC-backed SequencedDeadLetterQueueFactory that instantiates a JdbcSequencedDeadLetterQueue per event handling component.

Methods inherited from class java.lang.Object

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

Constructor Details

JdbcDeadLetterQueueAutoConfiguration

public JdbcDeadLetterQueueAutoConfiguration()

Method Details

deadLetterSchema

@Bean
@ConditionalOnMissingBean
public DeadLetterSchema deadLetterSchema()

Creates a default DeadLetterSchema bean using the default column and table names.

To customize the schema, declare your own DeadLetterSchema bean — the @ConditionalOnMissingBean guard on this default will yield to it.

Returns:

A DeadLetterSchema with default table and column names.

jdbcDeadLetterQueueFactory

@Bean
@ConditionalOnMissingBean
public SequencedDeadLetterQueueFactory jdbcDeadLetterQueueFactory(DataSource dataSource,
 EventConverter eventConverter,
 Converter genericConverter,
 DeadLetterSchema schema)

Creates a JDBC-backed SequencedDeadLetterQueueFactory that instantiates a JdbcSequencedDeadLetterQueue per event handling component.

The processingGroup passed to the factory is a component-scoped identifier following the pattern "DeadLetterQueue[processorName][componentName]", used to scope dead letters in the database. The configuration parameter is ignored in this Spring implementation since all dependencies are wired via Spring bean injection.

Parameters:

dataSource - The JDBC DataSource used for persistence.

eventConverter - The EventConverter used to convert event payloads and metadata.

genericConverter - The generic Converter used for type conversion.

schema - The DeadLetterSchema describing the table and column names.

Returns:

A SequencedDeadLetterQueueFactory backed by JDBC.