public class LocalSessionFactoryBuilder
extends Configuration
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.
Requires Hibernate 4.0 or higher. As of Spring 4.0, it is compatible with (the quite refactored) Hibernate 4.3 as well. We recommend using the latest Hibernate 4.2.x or 4.3.x version, depending on whether you need to remain JPA 2.0 compatible at runtime (Hibernate 4.2) or can upgrade to JPA 2.1 (Hibernate 4.3).
NOTE: To set up Hibernate 4 for Spring-driven JTA transactions, make
sure to either use the setJtaTransactionManager(java.lang.Object)
method or to set the
"hibernate.transaction.factory_class" property to CMTTransactionFactory
.
Otherwise, Hibernate's smart flushing mechanism won't work properly.
LocalSessionFactoryBean
Modifier and Type | Field and Description |
---|---|
private RegionFactory |
cacheRegionFactory |
private static java.util.Set<TypeFilter> |
entityTypeFilters |
private static java.lang.String |
PACKAGE_INFO_SUFFIX |
private static java.lang.String |
RESOURCE_PATTERN |
private ResourcePatternResolver |
resourcePatternResolver |
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.
|
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.
|
SessionFactory |
buildSessionFactory()
Build the
SessionFactory . |
Settings |
buildSettings(java.util.Properties props,
ServiceRegistry serviceRegistry) |
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 |
setCacheRegionFactory(RegionFactory cacheRegionFactory)
Set the Hibernate RegionFactory to use for the SessionFactory.
|
LocalSessionFactoryBuilder |
setCurrentTenantIdentifierResolver(java.lang.Object currentTenantIdentifierResolver)
Set a Hibernate 4.1/4.2/4.3
CurrentTenantIdentifierResolver to be passed
on to the SessionFactory: as an instance, a Class, or a String class name. |
LocalSessionFactoryBuilder |
setJtaTransactionManager(java.lang.Object jtaTransactionManager)
Set the Spring
JtaTransactionManager or the JTA TransactionManager
to be used with Hibernate, if any. |
LocalSessionFactoryBuilder |
setMultiTenantConnectionProvider(java.lang.Object multiTenantConnectionProvider)
Set a Hibernate 4.1/4.2/4.3
MultiTenantConnectionProvider to be passed
on to the SessionFactory: as an instance, a Class, or a String class name. |
private static final java.lang.String RESOURCE_PATTERN
private static final java.lang.String PACKAGE_INFO_SUFFIX
private static final java.util.Set<TypeFilter> entityTypeFilters
private final ResourcePatternResolver resourcePatternResolver
private RegionFactory cacheRegionFactory
public LocalSessionFactoryBuilder(javax.sql.DataSource dataSource)
dataSource
- the JDBC DataSource that the resulting Hibernate SessionFactory should be using
(may be null
)public LocalSessionFactoryBuilder(javax.sql.DataSource dataSource, java.lang.ClassLoader classLoader)
dataSource
- the JDBC DataSource that the resulting Hibernate SessionFactory should be using
(may be null
)classLoader
- the ClassLoader to load application classes frompublic LocalSessionFactoryBuilder(javax.sql.DataSource dataSource, ResourceLoader resourceLoader)
dataSource
- the JDBC DataSource that the resulting Hibernate SessionFactory should be using
(may be null
)resourceLoader
- the ResourceLoader to load application classes frompublic LocalSessionFactoryBuilder setJtaTransactionManager(java.lang.Object jtaTransactionManager)
JtaTransactionManager
or the JTA TransactionManager
to be used with Hibernate, if any. Allows for using a Spring-managed transaction
manager for Hibernate 4's session and cache synchronization, with the
"hibernate.transaction.jta.platform" automatically set to it. Also sets
"hibernate.transaction.factory_class" to CMTTransactionFactory
,
instructing Hibernate to interact with externally managed transactions.
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.
public LocalSessionFactoryBuilder setMultiTenantConnectionProvider(java.lang.Object multiTenantConnectionProvider)
MultiTenantConnectionProvider
to be passed
on to the SessionFactory: as an instance, a Class, or a String class name.
Note that the package location of the MultiTenantConnectionProvider
interface changed between Hibernate 4.2 and 4.3. This method accepts both variants.
AvailableSettings#MULTI_TENANT_CONNECTION_PROVIDER
public LocalSessionFactoryBuilder setCurrentTenantIdentifierResolver(java.lang.Object currentTenantIdentifierResolver)
CurrentTenantIdentifierResolver
to be passed
on to the SessionFactory: as an instance, a Class, or a String class name.AvailableSettings#MULTI_TENANT_IDENTIFIER_RESOLVER
public LocalSessionFactoryBuilder setCacheRegionFactory(RegionFactory cacheRegionFactory)
Note: If this is set, the Hibernate settings should not define a cache provider to avoid meaningless double configuration.
org.hibernate.cache.spi.RegionFactory
public LocalSessionFactoryBuilder addAnnotatedClasses(java.lang.Class<?>... annotatedClasses)
#addAnnotatedClass
,
scanPackages(java.lang.String...)
public LocalSessionFactoryBuilder addPackages(java.lang.String... annotatedPackages)
#addPackage
,
scanPackages(java.lang.String...)
public LocalSessionFactoryBuilder scanPackages(java.lang.String... packagesToScan) throws HibernateException
Configuration
.packagesToScan
- one or more Java package namesHibernateException
- if scanning fails for any reasonprivate boolean matchesEntityTypeFilter(MetadataReader reader, MetadataReaderFactory readerFactory) throws java.io.IOException
java.io.IOException
public Settings buildSettings(java.util.Properties props, ServiceRegistry serviceRegistry) throws HibernateException
HibernateException
public SessionFactory buildSessionFactory() throws HibernateException
SessionFactory
.HibernateException