org.springframework.orm.hibernate5

Class LocalSessionFactoryBuilder

java.lang.Object

Configuration

org.springframework.orm.hibernate5.LocalSessionFactoryBuilder

public class LocalSessionFactoryBuilder
extends Configuration

A Spring-provided extension of the standard Hibernate Configuration class, adding SpringSessionContext as a default and providing convenient ways to specify a DataSource and an application class loader.

This is designed for programmatic use, e.g. in @Bean factory methods. Consider using LocalSessionFactoryBean for XML bean definition files.

Since:

4.2

Author:

Juergen Hoeller

See Also:

LocalSessionFactoryBean

Field Summary

Fields

Modifier and Type	Field and Description
private TypeFilter	CONVERTER_TYPE_FILTER
private static TypeFilter[]	DEFAULT_ENTITY_TYPE_FILTERS
private TypeFilter[]	entityTypeFilters
private static java.lang.String	PACKAGE_INFO_SUFFIX
private static java.lang.String	RESOURCE_PATTERN
private ResourcePatternResolver	resourcePatternResolver

Constructor Summary

Constructors

Constructor and Description
LocalSessionFactoryBuilder(javax.sql.DataSource dataSource) Create a new LocalSessionFactoryBuilder for the given DataSource.
LocalSessionFactoryBuilder(javax.sql.DataSource dataSource, java.lang.ClassLoader classLoader) Create a new LocalSessionFactoryBuilder for the given DataSource.
LocalSessionFactoryBuilder(javax.sql.DataSource dataSource, ResourceLoader resourceLoader) Create a new LocalSessionFactoryBuilder for the given DataSource.

Method Summary

Modifier and Type	Method and Description
LocalSessionFactoryBuilder	addAnnotatedClasses(java.lang.Class<?>... annotatedClasses) Add the given annotated classes in a batch.
LocalSessionFactoryBuilder	addPackages(java.lang.String... annotatedPackages) Add the given annotated packages in a batch.
private boolean	matchesEntityTypeFilter(MetadataReader reader, MetadataReaderFactory readerFactory) Check whether any of the configured entity type filters matches the current class descriptor contained in the metadata reader.
LocalSessionFactoryBuilder	scanPackages(java.lang.String... packagesToScan) Perform Spring-based scanning for entity classes, registering them as annotated classes with this Configuration.
LocalSessionFactoryBuilder	setEntityTypeFilters(TypeFilter... entityTypeFilters) Specify custom type filters for Spring-based scanning for entity classes.
LocalSessionFactoryBuilder	setJtaTransactionManager(java.lang.Object jtaTransactionManager) Set the Spring JtaTransactionManager or the JTA TransactionManager to be used with Hibernate, if any.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_PATTERN

private static final java.lang.String RESOURCE_PATTERN

See Also:

Constant Field Values

PACKAGE_INFO_SUFFIX

private static final java.lang.String PACKAGE_INFO_SUFFIX

See Also:

Constant Field Values

DEFAULT_ENTITY_TYPE_FILTERS

private static final TypeFilter[] DEFAULT_ENTITY_TYPE_FILTERS

CONVERTER_TYPE_FILTER

private final TypeFilter CONVERTER_TYPE_FILTER

resourcePatternResolver

private final ResourcePatternResolver resourcePatternResolver

entityTypeFilters

private TypeFilter[] entityTypeFilters

Constructor Detail

LocalSessionFactoryBuilder

public LocalSessionFactoryBuilder(javax.sql.DataSource dataSource)

Create a new LocalSessionFactoryBuilder for the given DataSource.

Parameters:

dataSource - the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may be null)

LocalSessionFactoryBuilder

public LocalSessionFactoryBuilder(javax.sql.DataSource dataSource,
                                  java.lang.ClassLoader classLoader)

Create a new LocalSessionFactoryBuilder for the given DataSource.

Parameters:

dataSource - the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may be null)

classLoader - the ClassLoader to load application classes from

LocalSessionFactoryBuilder

public LocalSessionFactoryBuilder(javax.sql.DataSource dataSource,
                                  ResourceLoader resourceLoader)

Create a new LocalSessionFactoryBuilder for the given DataSource.

Parameters:

dataSource - the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may be null)

resourceLoader - the ResourceLoader to load application classes from

Method Detail

setJtaTransactionManager

public LocalSessionFactoryBuilder setJtaTransactionManager(java.lang.Object jtaTransactionManager)

Set the Spring JtaTransactionManager or the JTA TransactionManager to be used with Hibernate, if any. Allows for using a Spring-managed transaction manager for Hibernate 5's session and cache synchronization, with the "hibernate.transaction.jta.platform" automatically set to it.

A passed-in Spring JtaTransactionManager needs to contain a JTA TransactionManager reference to be usable here, except for the WebSphere case where we'll automatically set WebSphereExtendedJtaPlatform accordingly.

Note: If this is set, the Hibernate settings should not contain a JTA platform setting to avoid meaningless double configuration.

setEntityTypeFilters

public LocalSessionFactoryBuilder setEntityTypeFilters(TypeFilter... entityTypeFilters)

Specify custom type filters for Spring-based scanning for entity classes.

Default is to search all specified packages for classes annotated with @javax.persistence.Entity, @javax.persistence.Embeddable or @javax.persistence.MappedSuperclass.

Since:

4.2

See Also:

scanPackages(java.lang.String...)

addAnnotatedClasses

public LocalSessionFactoryBuilder addAnnotatedClasses(java.lang.Class<?>... annotatedClasses)

Add the given annotated classes in a batch.

See Also:

#addAnnotatedClass, scanPackages(java.lang.String...)

addPackages

public LocalSessionFactoryBuilder addPackages(java.lang.String... annotatedPackages)

Add the given annotated packages in a batch.

See Also:

#addPackage, scanPackages(java.lang.String...)

scanPackages

public LocalSessionFactoryBuilder scanPackages(java.lang.String... packagesToScan)
                                        throws HibernateException

Perform Spring-based scanning for entity classes, registering them as annotated classes with this Configuration.

Parameters:

packagesToScan - one or more Java package names

Throws:

HibernateException - if scanning fails for any reason

matchesEntityTypeFilter

private boolean matchesEntityTypeFilter(MetadataReader reader,
                                        MetadataReaderFactory readerFactory)
                                 throws java.io.IOException

Check whether any of the configured entity type filters matches the current class descriptor contained in the metadata reader.

Throws:

java.io.IOException