Package org.springframework.data.r2dbc.config

Class AbstractR2dbcConfiguration

java.lang.Object

org.springframework.data.r2dbc.config.AbstractR2dbcConfiguration

All Implemented Interfaces:

Aware, ApplicationContextAware

@Configuration(proxyBeanMethods=false)
public abstract class AbstractR2dbcConfiguration
extends Object
implements ApplicationContextAware

Base class for Spring Data R2DBC configuration containing bean declarations that must be registered for Spring Data R2DBC to work.

Author:

Mark Paluch, Jens Schauder

See Also:

• ConnectionFactory
• DatabaseClient
• EnableR2dbcRepositories

Constructor Summary

Constructors

Constructor	Description
AbstractR2dbcConfiguration()

Method Summary

Modifier and Type	Method	Description
abstract io.r2dbc.spi.ConnectionFactory	connectionFactory()	Return a R2DBC ConnectionFactory.
DatabaseClient	databaseClient()	Register a DatabaseClient using connectionFactory() and ReactiveDataAccessStrategy.
protected List<Object>	getCustomConverters()	Customization hook to return custom converters.
R2dbcDialect	getDialect(io.r2dbc.spi.ConnectionFactory connectionFactory)	Return a R2dbcDialect for the given ConnectionFactory.
protected Set<Class<?>>	getInitialEntitySet()	Scans the mapping base package for classes annotated with Table.
protected Collection<String>	getMappingBasePackages()	Returns the base packages to scan for R2DBC mapped entities at startup.
protected CustomConversions.StoreConversions	getStoreConversions()	Returns the R2dbcDialect-specific CustomConversions.StoreConversions.
MappingR2dbcConverter	r2dbcConverter(R2dbcMappingContext mappingContext, R2dbcCustomConversions r2dbcCustomConversions)	Creates a R2dbcConverter using the configured r2dbcMappingContext(Optional, R2dbcCustomConversions, RelationalManagedTypes) R2dbcMappingContext}.
R2dbcCustomConversions	r2dbcCustomConversions()	Register custom Converters in a CustomConversions object if required.
R2dbcEntityTemplate	r2dbcEntityTemplate(DatabaseClient databaseClient, ReactiveDataAccessStrategy dataAccessStrategy)	Register R2dbcEntityTemplate using databaseClient() and connectionFactory().
RelationalManagedTypes	r2dbcManagedTypes()	Returns the a RelationalManagedTypes object holding the initial entity set.
R2dbcMappingContext	r2dbcMappingContext(Optional<NamingStrategy> namingStrategy, R2dbcCustomConversions r2dbcCustomConversions, RelationalManagedTypes r2dbcManagedTypes)	Register a R2dbcMappingContext and apply an optional NamingStrategy.
ReactiveDataAccessStrategy	reactiveDataAccessStrategy(R2dbcConverter converter)	Creates a ReactiveDataAccessStrategy using the configured R2dbcConverter.
protected Set<Class<?>>	scanForEntities(String basePackage)	Scans the given base package for entities, i.e.
void	setApplicationContext(ApplicationContext applicationContext)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractR2dbcConfiguration

public AbstractR2dbcConfiguration()

Method Details

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

connectionFactory

public abstract io.r2dbc.spi.ConnectionFactory connectionFactory()

Return a R2DBC ConnectionFactory. Annotate with Bean in case you want to expose a ConnectionFactory instance to the ApplicationContext.

Returns:

the configured ConnectionFactory.

getMappingBasePackages

protected Collection<String> getMappingBasePackages()

Returns the base packages to scan for R2DBC mapped entities at startup. Returns the package name of the configuration class' (the concrete class, not this one here) by default. So if you have a com.acme.AppConfig extending AbstractR2dbcConfiguration the base package will be considered com.acme unless the method is overridden to implement alternate behavior.

Returns:

the base packages to scan for mapped Table classes or an empty collection to not enable scanning for entities.

Since:

3.0

r2dbcManagedTypes

@Bean
public RelationalManagedTypes r2dbcManagedTypes()
                                         throws ClassNotFoundException

Returns the a RelationalManagedTypes object holding the initial entity set.

Returns:

new instance of RelationalManagedTypes.

Throws:

ClassNotFoundException

Since:

3.0

getDialect

public R2dbcDialect getDialect(io.r2dbc.spi.ConnectionFactory connectionFactory)

Return a R2dbcDialect for the given ConnectionFactory. This method attempts to resolve a R2dbcDialect from ConnectionFactoryMetadata. Override this method to specify a dialect instead of attempting to resolve one.

Parameters:

connectionFactory - the configured ConnectionFactory.

Returns:

the resolved R2dbcDialect.

Throws:

DialectResolver.NoDialectException - if the R2dbcDialect cannot be determined.

databaseClient

@Bean({"r2dbcDatabaseClient","databaseClient"})
public DatabaseClient databaseClient()

Register a DatabaseClient using connectionFactory() and ReactiveDataAccessStrategy.

Returns:

must not be null.

Throws:

IllegalArgumentException - if any of the required args is null.

r2dbcEntityTemplate

@Bean
public R2dbcEntityTemplate r2dbcEntityTemplate(DatabaseClient databaseClient,
 ReactiveDataAccessStrategy dataAccessStrategy)

Register R2dbcEntityTemplate using databaseClient() and connectionFactory().

Parameters:

databaseClient - must not be null.

dataAccessStrategy - must not be null.

Returns:

Since:

1.2

r2dbcMappingContext

@Bean
public R2dbcMappingContext r2dbcMappingContext(Optional<NamingStrategy> namingStrategy,
 R2dbcCustomConversions r2dbcCustomConversions,
 RelationalManagedTypes r2dbcManagedTypes)

Register a R2dbcMappingContext and apply an optional NamingStrategy.

Parameters:

namingStrategy - optional NamingStrategy. Use DefaultNamingStrategy.INSTANCE as fallback.

r2dbcCustomConversions - customized R2DBC conversions.

r2dbcManagedTypes - R2DBC managed types, typically discovered through an entity scan.

Returns:

must not be null.

Throws:

IllegalArgumentException - if any of the required args is null.

reactiveDataAccessStrategy

@Bean
public ReactiveDataAccessStrategy reactiveDataAccessStrategy(R2dbcConverter converter)

Creates a ReactiveDataAccessStrategy using the configured R2dbcConverter.

Parameters:

converter - the configured R2dbcConverter.

Returns:

must not be null.

Throws:

IllegalArgumentException - if any of the mappingContext is null.

See Also:

• r2dbcConverter(R2dbcMappingContext, R2dbcCustomConversions)
• getDialect(ConnectionFactory)

r2dbcConverter

@Bean
public MappingR2dbcConverter r2dbcConverter(R2dbcMappingContext mappingContext,
 R2dbcCustomConversions r2dbcCustomConversions)

Creates a R2dbcConverter using the configured r2dbcMappingContext(Optional, R2dbcCustomConversions, RelationalManagedTypes) R2dbcMappingContext}.

Parameters:

mappingContext - the configured R2dbcMappingContext.

r2dbcCustomConversions - customized R2DBC conversions.

Returns:

must not be null.

Throws:

IllegalArgumentException - if any of the mappingContext is null.

Since:

1.2

See Also:

• r2dbcMappingContext(Optional, R2dbcCustomConversions, RelationalManagedTypes)
• getDialect(ConnectionFactory)

r2dbcCustomConversions

@Bean
public R2dbcCustomConversions r2dbcCustomConversions()

Register custom Converters in a CustomConversions object if required. These CustomConversions will be registered with the MappingR2dbcConverter and r2dbcMappingContext(Optional, R2dbcCustomConversions, RelationalManagedTypes). Returns an empty R2dbcCustomConversions instance by default. Override getCustomConverters() to supply custom converters.

Returns:

must not be null.

See Also:

• getCustomConverters()

getCustomConverters

protected List<Object> getCustomConverters()

Customization hook to return custom converters.

Returns:

return custom converters.

getStoreConversions

protected CustomConversions.StoreConversions getStoreConversions()

Returns the R2dbcDialect-specific CustomConversions.StoreConversions.

Returns:

the R2dbcDialect-specific CustomConversions.StoreConversions.

getInitialEntitySet

protected Set<Class<?>> getInitialEntitySet()
                                     throws ClassNotFoundException

Scans the mapping base package for classes annotated with Table. By default, it scans for entities in all packages returned by getMappingBasePackages().

Returns:

Throws:

ClassNotFoundException

Since:

3.0

See Also:

• getMappingBasePackages()

scanForEntities

protected Set<Class<?>> scanForEntities(String basePackage)

Scans the given base package for entities, i.e. R2DBC-specific types annotated with Table.

Parameters:

basePackage - must not be null.

Returns:

a set of classes identified as entities.

Since:

3.0