Package org.springframework.data.jdbc.repository.config

Class AbstractJdbcConfiguration

java.lang.Object

org.springframework.data.jdbc.repository.config.AbstractJdbcConfiguration

All Implemented Interfaces:

Aware, ApplicationContextAware

Direct Known Subclasses:

MyBatisJdbcConfiguration

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

Beans that must be registered for Spring Data JDBC to work.

Since:

1.1

Author:

Greg Turnquist, Jens Schauder, Mark Paluch, Michael Simons, Christoph Strobl, Myeonghyeon Lee, Chirag Tailor

Constructor Summary

Constructors

Constructor	Description
AbstractJdbcConfiguration()

Method Summary

Modifier and Type	Method	Description
DataAccessStrategy	dataAccessStrategyBean(NamedParameterJdbcOperations operations, JdbcConverter jdbcConverter, JdbcMappingContext context, Dialect dialect)	Create a DataAccessStrategy for reuse in the JdbcAggregateOperations and the JdbcConverter.
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 JDBC mapped entities at startup.
JdbcAggregateTemplate	jdbcAggregateTemplate(ApplicationContext applicationContext, JdbcMappingContext mappingContext, JdbcConverter converter, DataAccessStrategy dataAccessStrategy)	Register a JdbcAggregateTemplate as a bean for easy use in applications that need a lower level of abstraction than the normal repository abstraction.
JdbcConverter	jdbcConverter(JdbcMappingContext mappingContext, NamedParameterJdbcOperations operations, RelationResolver relationResolver, JdbcCustomConversions conversions, Dialect dialect)	Creates a RelationalConverter using the configured jdbcMappingContext(Optional, JdbcCustomConversions, RelationalManagedTypes).
JdbcCustomConversions	jdbcCustomConversions()	Register custom Converters in a JdbcCustomConversions object if required.
Dialect	jdbcDialect(NamedParameterJdbcOperations operations)	Resolves a JDBC dialect by inspecting NamedParameterJdbcOperations.
RelationalManagedTypes	jdbcManagedTypes()	Returns the a RelationalManagedTypes object holding the initial entity set.
JdbcMappingContext	jdbcMappingContext(Optional<NamingStrategy> namingStrategy, JdbcCustomConversions customConversions, RelationalManagedTypes jdbcManagedTypes)	Register a JdbcMappingContext and apply an optional NamingStrategy.
protected Set<Class<?>>	scanForEntities(String basePackage)	Scans the given base package for entities, i.e.
void	setApplicationContext(ApplicationContext applicationContext)
protected List<?>	userConverters()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractJdbcConfiguration

public AbstractJdbcConfiguration()

Method Details

getMappingBasePackages

protected Collection<String> getMappingBasePackages()

Returns the base packages to scan for JDBC 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 AbstractJdbcConfiguration 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

jdbcManagedTypes

@Bean
public RelationalManagedTypes jdbcManagedTypes()
                                        throws ClassNotFoundException

Returns the a RelationalManagedTypes object holding the initial entity set.

Returns:

new instance of RelationalManagedTypes.

Throws:

ClassNotFoundException

Since:

3.0

jdbcMappingContext

@Bean
public JdbcMappingContext jdbcMappingContext(Optional<NamingStrategy> namingStrategy,
 JdbcCustomConversions customConversions,
 RelationalManagedTypes jdbcManagedTypes)

Register a JdbcMappingContext and apply an optional NamingStrategy.

Parameters:

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

customConversions - see jdbcCustomConversions().

jdbcManagedTypes - JDBC managed types, typically discovered through an entity scan.

Returns:

must not be null.

jdbcConverter

@Bean
public JdbcConverter jdbcConverter(JdbcMappingContext mappingContext,
 NamedParameterJdbcOperations operations,
 @Lazy
 RelationResolver relationResolver,
 JdbcCustomConversions conversions,
 Dialect dialect)

Creates a RelationalConverter using the configured jdbcMappingContext(Optional, JdbcCustomConversions, RelationalManagedTypes).

Returns:

must not be null.

See Also:

• jdbcMappingContext(Optional, JdbcCustomConversions, RelationalManagedTypes)
• jdbcCustomConversions()

jdbcCustomConversions

@Bean
public JdbcCustomConversions jdbcCustomConversions()

Register custom Converters in a JdbcCustomConversions object if required. These JdbcCustomConversions will be registered with the jdbcConverter(JdbcMappingContext, NamedParameterJdbcOperations, RelationResolver, JdbcCustomConversions, Dialect). Returns an empty JdbcCustomConversions instance by default.

Returns:

will never be null.

userConverters

protected List<?> userConverters()

jdbcAggregateTemplate

@Bean
public JdbcAggregateTemplate jdbcAggregateTemplate(ApplicationContext applicationContext,
 JdbcMappingContext mappingContext,
 JdbcConverter converter,
 DataAccessStrategy dataAccessStrategy)

Register a JdbcAggregateTemplate as a bean for easy use in applications that need a lower level of abstraction than the normal repository abstraction.

Parameters:

applicationContext - for publishing events. Must not be null.

mappingContext - the mapping context to be used. Must not be null.

converter - the conversions used when reading and writing from/to the database. Must not be null.

Returns:

a JdbcAggregateTemplate. Will never be null.

dataAccessStrategyBean

@Bean
public DataAccessStrategy dataAccessStrategyBean(NamedParameterJdbcOperations operations,
 JdbcConverter jdbcConverter,
 JdbcMappingContext context,
 Dialect dialect)

Create a DataAccessStrategy for reuse in the JdbcAggregateOperations and the JdbcConverter. Override this method to register a bean of type DataAccessStrategy if your use case requires a more specialized DataAccessStrategy.

Returns:

will never be null.

jdbcDialect

@Bean
public Dialect jdbcDialect(NamedParameterJdbcOperations operations)

Resolves a JDBC dialect by inspecting NamedParameterJdbcOperations.

Parameters:

operations - the NamedParameterJdbcOperations allowing access to a Connection.

Returns:

the Dialect to be used.

Throws:

DialectResolver.NoDialectException - if the Dialect cannot be determined.

Since:

2.0

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

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. JDBC-specific types annotated with Table.

Parameters:

basePackage - must not be null.

Returns:

a set of classes identified as entities.

Since:

3.0