Package org.axonframework.extension.springboot.autoconfig

Class JdbcAutoConfiguration

java.lang.Object

org.axonframework.extension.springboot.autoconfig.JdbcAutoConfiguration

@AutoConfiguration(after=JpaAutoConfiguration.class)
@ConditionalOnBean(javax.sql.DataSource.class)
@ConditionalOnClass(SpringDataSourceConnectionProvider.class)
@EnableConfigurationProperties(TokenStoreProperties.class)
public class JdbcAutoConfiguration
extends Object

Autoconfiguration class for Axon's JDBC specific infrastructure components.

Registers a ConnectionProvider, a TokenSchema, a TokenStore, and a PersistenceExceptionResolver when a DataSource bean is present in the application context. All beans are conditional on the absence of user-supplied alternatives, so they can be overridden by providing custom beans of the same types.

This configuration runs after JpaAutoConfiguration to allow JPA-specific beans (such as a JPA-based PersistenceExceptionResolver) to take precedence.

Since:

3.1

Author:

Allard Buijze

Constructor Summary

Constructors

Constructor	Description
JdbcAutoConfiguration(TokenStoreProperties tokenStoreProperties)	Creates a new JdbcAutoConfiguration with the given TokenStoreProperties.

Method Summary

Modifier and Type	Method	Description
ConnectionProvider	connectionProvider(DataSource dataSource)	Provides a ConnectionProvider backed by the application's DataSource.
PersistenceExceptionResolver	persistenceExceptionResolver()	Provides a PersistenceExceptionResolver that detects duplicate key violations from JDBC SQLIntegrityConstraintViolationException exceptions.
TokenSchema	tokenSchema()	Provides a default TokenSchema describing the table and column names used by the JDBC token store.
TokenStore	tokenStore(DataSource dataSource, TokenSchema tokenSchema, tools.jackson.databind.ObjectMapper defaultAxonObjectMapper)	Provides a JDBC-backed TokenStore for tracking event processor token persistence.

Methods inherited from class java.lang.Object

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

Constructor Details

JdbcAutoConfiguration

public JdbcAutoConfiguration(TokenStoreProperties tokenStoreProperties)

Creates a new JdbcAutoConfiguration with the given TokenStoreProperties.

Parameters:

tokenStoreProperties - properties used to configure the JDBC-backed TokenStore

Method Details

connectionProvider

@Bean
@ConditionalOnMissingBean
public ConnectionProvider connectionProvider(DataSource dataSource)

Provides a ConnectionProvider backed by the application's DataSource.

Uses SpringDataSourceConnectionProvider, which is aware of Spring's transaction management and returns the connection bound to the active transaction when one is present.

Parameters:

dataSource - the data source to obtain connections from

Returns:

a connection provider for use in JDBC-based Axon components

tokenSchema

@Bean
@ConditionalOnMissingBean({TokenStore.class,TokenSchema.class})
public TokenSchema tokenSchema()

Provides a default TokenSchema describing the table and column names used by the JDBC token store.

Only created when neither a TokenStore nor a TokenSchema bean is already present, because a custom TokenStore may use its own schema definition.

Returns:

a default TokenSchema

tokenStore

@Bean
@ConditionalOnMissingBean(TokenStore.class)
public TokenStore tokenStore(DataSource dataSource,
 TokenSchema tokenSchema,
 tools.jackson.databind.ObjectMapper defaultAxonObjectMapper)

Provides a JDBC-backed TokenStore for tracking event processor token persistence.

Uses a JdbcTransactionalExecutorProvider to participate in JDBC transactions and a JacksonConverter to serialize tokens as JSON.

Parameters:

dataSource - the data source used to execute token store queries

tokenSchema - the schema describing the token store table layout

defaultAxonObjectMapper - the object mapper used to serialize tokens

Returns:

a configured JdbcTokenStore

persistenceExceptionResolver

@Bean
@ConditionalOnMissingBean
public PersistenceExceptionResolver persistenceExceptionResolver()

Provides a PersistenceExceptionResolver that detects duplicate key violations from JDBC SQLIntegrityConstraintViolationException exceptions.

Conditional on the absence of an existing PersistenceExceptionResolver bean, since JpaAutoConfiguration may already register one when JPA is on the classpath.

Returns:

a JdbcSQLErrorCodesResolver instance