java.lang.Object
- org.hibernate.cfg.Configuration
- - org.springframework.orm.hibernate5.LocalSessionFactoryBuilder

All Implemented Interfaces:
Serializable
```
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.
Compatible with Hibernate 5.0/5.1 as well as 5.2, as of Spring 4.3.
Since:
4.2
Author:
Juergen Hoeller
See Also:
LocalSessionFactoryBean, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.hibernate.cfg.Configuration
  Configuration.MappingsImpl, Configuration.MetadataSourceQueue

Field Summary
- Fields inherited from class org.hibernate.cfg.Configuration
  ARTEFACT_PROCESSING_ORDER, auxiliaryDatabaseObjects, classes, collections, columnNameBindingPerTable, DEFAULT_ARTEFACT_PROCESSING_ORDER, DEFAULT_CACHE_CONCURRENCY_STRATEGY, extendsQueue, fetchProfiles, filterDefinitions, imports, metadataSourceQueue, namedEntityGraphMap, namedProcedureCallMap, namedQueries, namedSqlQueries, propertyReferences, secondPasses, settingsFactory, sqlFunctions, sqlResultSetMappings, tableNameBinding, tables, typeDefs, USE_NEW_ID_GENERATOR_MAPPINGS, xmlHelper

Constructor Summary

Constructors
Constructor	Description
`LocalSessionFactoryBuilder(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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`LocalSessionFactoryBuilder`	`addAnnotatedClasses(Class<?>... annotatedClasses)`	Add the given annotated classes in a batch.
`LocalSessionFactoryBuilder`	`addPackages(String... annotatedPackages)`	Add the given annotated packages in a batch.
`SessionFactory`	`buildSessionFactory(AsyncTaskExecutor bootstrapExecutor)`	Build the Hibernate `SessionFactory` through background bootstrapping, using the given executor for a parallel initialization phase (e.g.
`LocalSessionFactoryBuilder`	`scanPackages(String... packagesToScan)`	Perform Spring-based scanning for entity classes, registering them as annotated classes with this `Configuration`.
`void`	`setCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver currentTenantIdentifierResolver)`	Overridden to reliably pass a `CurrentTenantIdentifierResolver` to the SessionFactory.
`LocalSessionFactoryBuilder`	`setEntityTypeFilters(TypeFilter... entityTypeFilters)`	Specify custom type filters for Spring-based scanning for entity classes.
`LocalSessionFactoryBuilder`	`setJtaTransactionManager(Object jtaTransactionManager)`	Set the Spring `JtaTransactionManager` or the JTA `TransactionManager` to be used with Hibernate, if any.
`LocalSessionFactoryBuilder`	`setMultiTenantConnectionProvider(org.hibernate.engine.jdbc.connections.spi.MultiTenantConnectionProvider multiTenantConnectionProvider)`	Set a `MultiTenantConnectionProvider` 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, addFetchProfile, addFile, addFile, addFilterDefinition, addInputStream, addJar, addPackage, addProperties, addResource, addResource, addSqlFunction, addURL, addXML, buildMapping, buildMappings, buildSessionFactory, buildSessionFactory, buildSettings, buildSettings, configure, configure, configure, configure, configure, createMappings, doConfigure, doConfigure, findPossibleExtends, generateDropSchemaScript, generateSchemaCreationScript, generateSchemaUpdateScript, generateSchemaUpdateScriptList, getClassMapping, getClassMappings, getCollectionMapping, getCollectionMappings, getConfigurationInputStream, getCurrentTenantIdentifierResolver, getEntityNotFoundDelegate, getEntityResolver, getEntityTuplizerFactory, getFilterDefinitions, getIdentifierGeneratorFactory, getImports, getInterceptor, getJaccPermissionDeclarations, getMappedSuperclassMappings, getMappedSuperclassMappingsCopy, getNamedEntityGraphs, getNamedProcedureCallMap, getNamedQueries, getNamedSQLQueries, getNamingStrategy, getNamingStrategyDelegator, getProperties, getProperty, getReflectionManager, getSessionFactoryObserver, getSqlFunctions, getSqlResultSetMappings, getTableMappings, getTypeResolver, iterateFetchProfiles, iterateGenerators, mergeProperties, registerTypeContributor, registerTypeOverride, registerTypeOverride, registerTypeOverride, reset, secondPassCompile, secondPassCompileForeignKeys, setCacheConcurrencyStrategy, setCacheConcurrencyStrategy, setCacheConcurrencyStrategy, setCollectionCacheConcurrencyStrategy, setCollectionCacheConcurrencyStrategy, setEntityNotFoundDelegate, setEntityResolver, setInterceptor, setNamingStrategy, setNamingStrategyDelegator, setPrecedence, setProperties, setProperty, setSessionFactoryObserver, validateSchema

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LocalSessionFactoryBuilder
```
public LocalSessionFactoryBuilder(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(DataSource dataSource,
                                  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(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
  - LocalSessionFactoryBuilder
```
public LocalSessionFactoryBuilder(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 be null)
    resourceLoader - the ResourceLoader to load application classes from
    metadataSources - the Hibernate MetadataSources service to use (e.g. reusing an existing one)
    Since:
    4.3
- Method Detail
  - setJtaTransactionManager
```
public LocalSessionFactoryBuilder setJtaTransactionManager(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.
  - setMultiTenantConnectionProvider
```
public LocalSessionFactoryBuilder setMultiTenantConnectionProvider(org.hibernate.engine.jdbc.connections.spi.MultiTenantConnectionProvider multiTenantConnectionProvider)
```
    Set a MultiTenantConnectionProvider to be passed on to the SessionFactory.
    Since:
    4.3
    See Also:
    AvailableSettings.MULTI_TENANT_CONNECTION_PROVIDER
  - setCurrentTenantIdentifierResolver
```
public void setCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver currentTenantIdentifierResolver)
```
    Overridden to reliably pass a CurrentTenantIdentifierResolver to the SessionFactory.
    Overrides:
    setCurrentTenantIdentifierResolver in class Configuration
    Since:
    4.3.2
    See Also:
    AvailableSettings.MULTI_TENANT_IDENTIFIER_RESOLVER
  - 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.
    See Also:
    scanPackages(java.lang.String...)
  - addAnnotatedClasses
```
public LocalSessionFactoryBuilder addAnnotatedClasses(Class<?>... annotatedClasses)
```
    Add the given annotated classes in a batch.
    See Also:
    Configuration.addAnnotatedClass(java.lang.Class), scanPackages(java.lang.String...)
  - addPackages
```
public LocalSessionFactoryBuilder addPackages(String... annotatedPackages)
```
    Add the given annotated packages in a batch.
    See Also:
    Configuration.addPackage(java.lang.String), scanPackages(java.lang.String...)
  - scanPackages
```
public LocalSessionFactoryBuilder scanPackages(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
  - buildSessionFactory
```
public SessionFactory buildSessionFactory(AsyncTaskExecutor bootstrapExecutor)
```
    Build the Hibernate SessionFactory through background bootstrapping, using the given executor for a parallel initialization phase (e.g. a SimpleAsyncTaskExecutor).
    SessionFactory initialization will then switch into background bootstrap mode, with a SessionFactory proxy immediately returned for injection purposes instead of waiting for Hibernate's bootstrapping to complete. However, note that the first actual call to a SessionFactory method will then block until Hibernate's bootstrapping completed, if not ready by then. For maximum benefit, make sure to avoid early SessionFactory calls in init methods of related beans, even for metadata introspection purposes.
    Since:
    4.3
    See Also:
    Configuration.buildSessionFactory()

Class LocalSessionFactoryBuilder

Nested Class Summary

Nested classes/interfaces inherited from class org.hibernate.cfg.Configuration

Field Summary

Fields inherited from class org.hibernate.cfg.Configuration

Constructor Summary

Method Summary

Methods inherited from class org.hibernate.cfg.Configuration

Methods inherited from class java.lang.Object

Constructor Detail

LocalSessionFactoryBuilder

LocalSessionFactoryBuilder

LocalSessionFactoryBuilder

LocalSessionFactoryBuilder

Method Detail

setJtaTransactionManager

setMultiTenantConnectionProvider

setCurrentTenantIdentifierResolver

setEntityTypeFilters

addAnnotatedClasses

addPackages

scanPackages

buildSessionFactory