Class LocalSessionFactoryBuilder
Configuration
class,
adding SpringSessionContext
as a default and providing convenient ways
to specify a JDBC 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.
Typically combined with HibernateTransactionManager
for declarative
transactions against the SessionFactory
and its JDBC DataSource
.
Compatible with Hibernate 5.5/5.6, as of Spring 6.0.
This Hibernate-specific factory builder can also be a convenient way to set up
a JPA EntityManagerFactory
since the Hibernate SessionFactory
natively exposes the JPA EntityManagerFactory
interface as well now.
This builder supports Hibernate BeanContainer
integration,
MetadataSources
from custom BootstrapServiceRegistryBuilder
setup, as well as other advanced Hibernate configuration options beyond the
standard JPA bootstrap contract.
- Since:
- 4.2
- Author:
- Juergen Hoeller
- See Also:
-
Field Summary
Fields inherited from class org.hibernate.cfg.Configuration
ARTEFACT_PROCESSING_ORDER
-
Constructor Summary
ConstructorDescriptionLocalSessionFactoryBuilder
(DataSource dataSource) Create a new LocalSessionFactoryBuilder for the given DataSource.LocalSessionFactoryBuilder
(DataSource dataSource, ClassLoader classLoader) Create a new LocalSessionFactoryBuilder for the given DataSource.LocalSessionFactoryBuilder
(DataSource dataSource, ResourceLoader resourceLoader) Create a new LocalSessionFactoryBuilder for the given DataSource.LocalSessionFactoryBuilder
(DataSource dataSource, ResourceLoader resourceLoader, org.hibernate.boot.MetadataSources metadataSources) Create a new LocalSessionFactoryBuilder for the given DataSource. -
Method Summary
Modifier and TypeMethodDescriptionaddAnnotatedClasses
(Class<?>... annotatedClasses) Add the given annotated classes in a batch.addPackages
(String... annotatedPackages) Add the given annotated packages in a batch.buildSessionFactory
(AsyncTaskExecutor bootstrapExecutor) Build the HibernateSessionFactory
through background bootstrapping, using the given executor for a parallel initialization phase (e.g.scanPackages
(String... packagesToScan) Perform Spring-based scanning for entity classes, registering them as annotated classes with thisConfiguration
.setBeanContainer
(ConfigurableListableBeanFactory beanFactory) Set a HibernateBeanContainer
for the given SpringConfigurableListableBeanFactory
.setCacheRegionFactory
(RegionFactory cacheRegionFactory) Set the HibernateRegionFactory
to use for the SessionFactory.void
setCurrentTenantIdentifierResolver
(CurrentTenantIdentifierResolver currentTenantIdentifierResolver) Overridden to reliably pass aCurrentTenantIdentifierResolver
to the SessionFactory.setEntityTypeFilters
(TypeFilter... entityTypeFilters) Specify custom type filters for Spring-based scanning for entity classes.setJtaTransactionManager
(Object jtaTransactionManager) Set the SpringJtaTransactionManager
or the JTATransactionManager
to be used with Hibernate, if any.setMultiTenantConnectionProvider
(org.hibernate.engine.jdbc.connections.spi.MultiTenantConnectionProvider multiTenantConnectionProvider) Set aMultiTenantConnectionProvider
to be passed on to the SessionFactory.Methods inherited from class org.hibernate.cfg.Configuration
add, addAnnotatedClass, addAttributeConverter, addAttributeConverter, addAttributeConverter, addAttributeConverter, addAttributeConverter, addAuxiliaryDatabaseObject, addCacheableFile, addCacheableFile, addCacheableFileStrictly, addClass, addDirectory, addDocument, addFile, addFile, addInputStream, addJar, addPackage, addProperties, addResource, addResource, addSqlFunction, addURL, addXML, addXmlMapping, buildMappings, buildSessionFactory, buildSessionFactory, configure, configure, configure, configure, configure, getCurrentTenantIdentifierResolver, getEntityNotFoundDelegate, getEntityTuplizerFactory, getInterceptor, getNamedEntityGraphs, getNamedProcedureCallMap, getNamedQueries, getNamedSQLQueries, getProperties, getProperty, getSessionFactoryObserver, getSqlFunctions, getSqlResultSetMappings, getStandardServiceRegistryBuilder, getXmlMappingBinderAccess, mergeProperties, registerTypeContributor, registerTypeOverride, registerTypeOverride, registerTypeOverride, reset, setEntityNotFoundDelegate, setImplicitNamingStrategy, setInterceptor, setPhysicalNamingStrategy, setProperties, setProperty, setSessionFactoryObserver, setSharedCacheMode
-
Constructor Details
-
LocalSessionFactoryBuilder
Create a new LocalSessionFactoryBuilder for the given DataSource.- Parameters:
dataSource
- the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may benull
)
-
LocalSessionFactoryBuilder
Create a new LocalSessionFactoryBuilder for the given DataSource.- Parameters:
dataSource
- the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may benull
)classLoader
- the ClassLoader to load application classes from
-
LocalSessionFactoryBuilder
Create a new LocalSessionFactoryBuilder for the given DataSource.- Parameters:
dataSource
- the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may benull
)resourceLoader
- the ResourceLoader to load application classes from
-
LocalSessionFactoryBuilder
public LocalSessionFactoryBuilder(@Nullable DataSource dataSource, ResourceLoader resourceLoader, org.hibernate.boot.MetadataSources metadataSources) Create a new LocalSessionFactoryBuilder for the given DataSource.- Parameters:
dataSource
- the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may benull
)resourceLoader
- the ResourceLoader to load application classes frommetadataSources
- the Hibernate MetadataSources service to use (e.g. reusing an existing one)- Since:
- 4.3
-
-
Method Details
-
setJtaTransactionManager
Set the SpringJtaTransactionManager
or the JTATransactionManager
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 JTATransactionManager
reference to be usable here, except for the WebSphere case where we'll automatically setWebSphereExtendedJtaPlatform
accordingly.Note: If this is set, the Hibernate settings should not contain a JTA platform setting to avoid meaningless double configuration.
-
setBeanContainer
Set a HibernateBeanContainer
for the given SpringConfigurableListableBeanFactory
.This enables autowiring of Hibernate attribute converters and entity listeners.
- Since:
- 5.1
- See Also:
-
setCacheRegionFactory
Set the HibernateRegionFactory
to use for the SessionFactory. Allows for using a Spring-managedRegionFactory
instance.Note: If this is set, the Hibernate settings should not define a cache provider to avoid meaningless double configuration.
- Since:
- 5.1
- See Also:
-
setMultiTenantConnectionProvider
public LocalSessionFactoryBuilder setMultiTenantConnectionProvider(org.hibernate.engine.jdbc.connections.spi.MultiTenantConnectionProvider multiTenantConnectionProvider) Set aMultiTenantConnectionProvider
to be passed on to the SessionFactory.- Since:
- 4.3
- See Also:
-
setCurrentTenantIdentifierResolver
public void setCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver currentTenantIdentifierResolver) Overridden to reliably pass aCurrentTenantIdentifierResolver
to the SessionFactory.- Overrides:
setCurrentTenantIdentifierResolver
in classConfiguration
- Since:
- 4.3.2
- See Also:
-
setEntityTypeFilters
Specify custom type filters for Spring-based scanning for entity classes.Default is to search all specified packages for classes annotated with
@jakarta.persistence.Entity
,@jakarta.persistence.Embeddable
or@jakarta.persistence.MappedSuperclass
.- See Also:
-
addAnnotatedClasses
Add the given annotated classes in a batch. -
addPackages
Add the given annotated packages in a batch. -
scanPackages
Perform Spring-based scanning for entity classes, registering them as annotated classes with thisConfiguration
.- Parameters:
packagesToScan
- one or more Java package names- Throws:
HibernateException
- if scanning fails for any reason
-
buildSessionFactory
Build the HibernateSessionFactory
through background bootstrapping, using the given executor for a parallel initialization phase (e.g. aSimpleAsyncTaskExecutor
).SessionFactory
initialization will then switch into background bootstrap mode, with aSessionFactory
proxy immediately returned for injection purposes instead of waiting for Hibernate's bootstrapping to complete. However, note that the first actual call to aSessionFactory
method will then block until Hibernate's bootstrapping completed, if not ready by then. For maximum benefit, make sure to avoid earlySessionFactory
calls in init methods of related beans, even for metadata introspection purposes.- Since:
- 4.3
- See Also:
-