LocalSessionFactoryBean (spring-orm 4.2.8.RELEASE API)

java.lang.Object
- org.springframework.orm.hibernate5.HibernateExceptionTranslator
- - org.springframework.orm.hibernate5.LocalSessionFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<SessionFactory>, org.springframework.beans.factory.InitializingBean, org.springframework.context.ResourceLoaderAware, org.springframework.dao.support.PersistenceExceptionTranslator
```
public class LocalSessionFactoryBean
extends HibernateExceptionTranslator
implements org.springframework.beans.factory.FactoryBean<SessionFactory>, org.springframework.context.ResourceLoaderAware, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean
```
FactoryBean that creates a Hibernate SessionFactory. This is the usual way to set up a shared Hibernate SessionFactory in a Spring application context; the SessionFactory can then be passed to Hibernate-based data access objects via dependency injection.
This class is similar in role to the same-named class in the orm.hibernate3 package. However, in practice, it is closer to AnnotationSessionFactoryBean since its core purpose is to bootstrap a SessionFactory from package scanning.

Since:

4.2

Author:

Juergen Hoeller

See Also:

setDataSource(javax.sql.DataSource), setPackagesToScan(java.lang.String...), LocalSessionFactoryBuilder

Constructor Summary

Constructors
Constructor and Description

LocalSessionFactoryBean()

Constructors
Constructor and Description
`LocalSessionFactoryBean()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`protected SessionFactory`	`buildSessionFactory(LocalSessionFactoryBuilder sfb)` Subclasses can override this method to perform custom initialization of the SessionFactory instance, creating it via the given Configuration object that got prepared by this LocalSessionFactoryBean.
`void`	`destroy()`
`Configuration`	`getConfiguration()` Return the Hibernate Configuration object used to build the SessionFactory.
`Properties`	`getHibernateProperties()` Return the Hibernate properties, if any.
`SessionFactory`	`getObject()`
`Class<?>`	`getObjectType()`
`boolean`	`isSingleton()`
`void`	`setAnnotatedClasses(Class<?>... annotatedClasses)` Specify annotated entity classes to register with this Hibernate SessionFactory.
`void`	`setAnnotatedPackages(String... annotatedPackages)` Specify the names of annotated packages, for which package-level annotation metadata will be read.
`void`	`setCacheableMappingLocations(org.springframework.core.io.Resource... cacheableMappingLocations)` Set locations of cacheable Hibernate mapping files, for example as web app resource "/WEB-INF/mapping/example.hbm.xml".
`void`	`setConfigLocation(org.springframework.core.io.Resource configLocation)` Set the location of a single Hibernate XML config file, for example as classpath resource "classpath:hibernate.cfg.xml".
`void`	`setConfigLocations(org.springframework.core.io.Resource... configLocations)` Set the locations of multiple Hibernate XML config files, for example as classpath resources "classpath:hibernate.cfg.xml,classpath:extension.cfg.xml".
`void`	`setCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver currentTenantIdentifierResolver)` Set a `CurrentTenantIdentifierResolver` to be passed on to the SessionFactory.
`void`	`setDataSource(DataSource dataSource)` Set the DataSource to be used by the SessionFactory.
`void`	`setEntityInterceptor(Interceptor entityInterceptor)` Set a Hibernate entity interceptor that allows to inspect and change property values before writing to and reading from the database.
`void`	`setEntityTypeFilters(org.springframework.core.type.filter.TypeFilter... entityTypeFilters)` Specify custom type filters for Spring-based scanning for entity classes.
`void`	`setHibernateProperties(Properties hibernateProperties)` Set Hibernate properties, such as "hibernate.dialect".
`void`	`setImplicitNamingStrategy(org.hibernate.boot.model.naming.ImplicitNamingStrategy implicitNamingStrategy)` Set a Hibernate 5.0 ImplicitNamingStrategy for the SessionFactory.
`void`	`setJtaTransactionManager(Object jtaTransactionManager)` Set the Spring `JtaTransactionManager` or the JTA `TransactionManager` to be used with Hibernate, if any.
`void`	`setMappingDirectoryLocations(org.springframework.core.io.Resource... mappingDirectoryLocations)` Set locations of directories that contain Hibernate mapping resources, like "WEB-INF/mappings".
`void`	`setMappingJarLocations(org.springframework.core.io.Resource... mappingJarLocations)` Set locations of jar files that contain Hibernate mapping resources, like "WEB-INF/lib/example.hbm.jar".
`void`	`setMappingLocations(org.springframework.core.io.Resource... mappingLocations)` Set locations of Hibernate mapping files, for example as classpath resource "classpath:example.hbm.xml".
`void`	`setMappingResources(String... mappingResources)` Set Hibernate mapping resources to be found in the class path, like "example.hbm.xml" or "mypackage/example.hbm.xml".
`void`	`setPackagesToScan(String... packagesToScan)` Specify packages to search for autodetection of your entity classes in the classpath.
`void`	`setPhysicalNamingStrategy(org.hibernate.boot.model.naming.PhysicalNamingStrategy physicalNamingStrategy)` Set a Hibernate 5.0 PhysicalNamingStrategy for the SessionFactory.
`void`	`setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)`

Methods inherited from class org.springframework.orm.hibernate5.HibernateExceptionTranslator
convertHibernateAccessException, translateExceptionIfPossible

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

- Constructor Detail
  - LocalSessionFactoryBean
```
public LocalSessionFactoryBean()
```
- Method Detail
  - setDataSource
```
public void setDataSource(DataSource dataSource)
```
    Set the DataSource to be used by the SessionFactory. If set, this will override corresponding settings in Hibernate properties.
    If this is set, the Hibernate settings should not define a connection provider to avoid meaningless double configuration.
  - setConfigLocation
```
public void setConfigLocation(org.springframework.core.io.Resource configLocation)
```
    Set the location of a single Hibernate XML config file, for example as classpath resource "classpath:hibernate.cfg.xml".
    Note: Can be omitted when all necessary properties and mapping resources are specified locally via this bean.
    
    See Also:
    
    Configuration.configure(java.net.URL)
  - setConfigLocations
```
public void setConfigLocations(org.springframework.core.io.Resource... configLocations)
```
    Set the locations of multiple Hibernate XML config files, for example as classpath resources "classpath:hibernate.cfg.xml,classpath:extension.cfg.xml".
    Note: Can be omitted when all necessary properties and mapping resources are specified locally via this bean.
    
    See Also:
    
    Configuration.configure(java.net.URL)
  - setMappingResources
```
public void setMappingResources(String... mappingResources)
```
    Set Hibernate mapping resources to be found in the class path, like "example.hbm.xml" or "mypackage/example.hbm.xml". Analogous to mapping entries in a Hibernate XML config file. Alternative to the more generic setMappingLocations method.
    Can be used to add to mappings from a Hibernate XML config file, or to specify all mappings locally.
    
    See Also:
    
    setMappingLocations(org.springframework.core.io.Resource...), Configuration.addResource(java.lang.String, java.lang.ClassLoader)
  - setMappingLocations
```
public void setMappingLocations(org.springframework.core.io.Resource... mappingLocations)
```
    Set locations of Hibernate mapping files, for example as classpath resource "classpath:example.hbm.xml". Supports any resource location via Spring's resource abstraction, for example relative paths like "WEB-INF/mappings/example.hbm.xml" when running in an application context.
    Can be used to add to mappings from a Hibernate XML config file, or to specify all mappings locally.
    
    See Also:
    
    Configuration.addInputStream(java.io.InputStream)
  - setCacheableMappingLocations
```
public void setCacheableMappingLocations(org.springframework.core.io.Resource... cacheableMappingLocations)
```
    Set locations of cacheable Hibernate mapping files, for example as web app resource "/WEB-INF/mapping/example.hbm.xml". Supports any resource location via Spring's resource abstraction, as long as the resource can be resolved in the file system.
    Can be used to add to mappings from a Hibernate XML config file, or to specify all mappings locally.
    
    See Also:
    
    Configuration.addCacheableFile(File)
  - setMappingJarLocations
```
public void setMappingJarLocations(org.springframework.core.io.Resource... mappingJarLocations)
```
    Set locations of jar files that contain Hibernate mapping resources, like "WEB-INF/lib/example.hbm.jar".
    Can be used to add to mappings from a Hibernate XML config file, or to specify all mappings locally.
    
    See Also:
    
    Configuration.addJar(File)
  - setMappingDirectoryLocations
```
public void setMappingDirectoryLocations(org.springframework.core.io.Resource... mappingDirectoryLocations)
```
    Set locations of directories that contain Hibernate mapping resources, like "WEB-INF/mappings".
    Can be used to add to mappings from a Hibernate XML config file, or to specify all mappings locally.
    
    See Also:
    
    Configuration.addDirectory(File)
  - setEntityInterceptor
```
public void setEntityInterceptor(Interceptor entityInterceptor)
```
    Set a Hibernate entity interceptor that allows to inspect and change property values before writing to and reading from the database. Will get applied to any new Session created by this factory.
    
    See Also:
    
    Configuration.setInterceptor(org.hibernate.Interceptor)
  - setImplicitNamingStrategy
```
public void setImplicitNamingStrategy(org.hibernate.boot.model.naming.ImplicitNamingStrategy implicitNamingStrategy)
```
    Set a Hibernate 5.0 ImplicitNamingStrategy for the SessionFactory.
    
    See Also:
    
    Configuration#setImplicitNamingStrategy
  - setPhysicalNamingStrategy
```
public void setPhysicalNamingStrategy(org.hibernate.boot.model.naming.PhysicalNamingStrategy physicalNamingStrategy)
```
    Set a Hibernate 5.0 PhysicalNamingStrategy for the SessionFactory.
    
    See Also:
    
    Configuration#setPhysicalNamingStrategy
  - setJtaTransactionManager
```
public void setJtaTransactionManager(Object jtaTransactionManager)
```
    Set the Spring JtaTransactionManager or the JTA TransactionManager to be used with Hibernate, if any. Implicitly sets up JtaPlatform.
    
    See Also:
    
    LocalSessionFactoryBuilder.setJtaTransactionManager(java.lang.Object)
  - setCurrentTenantIdentifierResolver
```
public void setCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver currentTenantIdentifierResolver)
```
    Set a CurrentTenantIdentifierResolver to be passed on to the SessionFactory.
    
    See Also:
    
    LocalSessionFactoryBuilder#setCurrentTenantIdentifierResolver
  - setEntityTypeFilters
```
public void setEntityTypeFilters(org.springframework.core.type.filter.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:
    
    setPackagesToScan(java.lang.String...)
  - setHibernateProperties
```
public void setHibernateProperties(Properties hibernateProperties)
```
    Set Hibernate properties, such as "hibernate.dialect".
    Note: Do not specify a transaction provider here when using Spring-driven transactions. It is also advisable to omit connection provider settings and use a Spring-set DataSource instead.
    
    See Also:
    
    setDataSource(javax.sql.DataSource)
  - getHibernateProperties
```
public Properties getHibernateProperties()
```
    Return the Hibernate properties, if any. Mainly available for configuration through property paths that specify individual keys.
  - setAnnotatedClasses
```
public void setAnnotatedClasses(Class<?>... annotatedClasses)
```
    Specify annotated entity classes to register with this Hibernate SessionFactory.
    
    See Also:
    
    Configuration.addAnnotatedClass(Class)
  - setAnnotatedPackages
```
public void setAnnotatedPackages(String... annotatedPackages)
```
    Specify the names of annotated packages, for which package-level annotation metadata will be read.
    
    See Also:
    
    Configuration.addPackage(String)
  - setPackagesToScan
```
public void setPackagesToScan(String... packagesToScan)
```
    Specify packages to search for autodetection of your entity classes in the classpath. This is analogous to Spring's component-scan feature (org.springframework.context.annotation.ClassPathBeanDefinitionScanner).
  - setResourceLoader
```
public void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)
```
    Specified by:
    
    setResourceLoader in interface org.springframework.context.ResourceLoaderAware
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws IOException
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    IOException
  - buildSessionFactory
```
protected SessionFactory buildSessionFactory(LocalSessionFactoryBuilder sfb)
```
    Subclasses can override this method to perform custom initialization of the SessionFactory instance, creating it via the given Configuration object that got prepared by this LocalSessionFactoryBean.
    The default implementation invokes LocalSessionFactoryBuilder's buildSessionFactory. A custom implementation could prepare the instance in a specific way (e.g. applying a custom ServiceRegistry) or use a custom SessionFactoryImpl subclass.
    
    Parameters:
    
    sfb - LocalSessionFactoryBuilder prepared by this LocalSessionFactoryBean
    
    Returns:
    
    the SessionFactory instance
    
    See Also:
    
    Configuration.buildSessionFactory()
  - getConfiguration
```
public final Configuration getConfiguration()
```
    Return the Hibernate Configuration object used to build the SessionFactory. Allows for access to configuration metadata stored there (rarely needed).
    
    Throws:
    
    IllegalStateException - if the Configuration object has not been initialized yet
  - getObject
```
public SessionFactory getObject()
```
    Specified by:
    
    getObject in interface org.springframework.beans.factory.FactoryBean<SessionFactory>
  - getObjectType
```
public Class<?> getObjectType()
```
    Specified by:
    
    getObjectType in interface org.springframework.beans.factory.FactoryBean<SessionFactory>
  - isSingleton
```
public boolean isSingleton()
```
    Specified by:
    
    isSingleton in interface org.springframework.beans.factory.FactoryBean<SessionFactory>
  - destroy
```
public void destroy()
```
    Specified by:
    
    destroy in interface org.springframework.beans.factory.DisposableBean

Class LocalSessionFactoryBean

Constructor Summary

Method Summary

Methods inherited from class org.springframework.orm.hibernate5.HibernateExceptionTranslator

Methods inherited from class java.lang.Object

Constructor Detail

LocalSessionFactoryBean

Method Detail

setDataSource

setConfigLocation

setConfigLocations

setMappingResources

setMappingLocations

setCacheableMappingLocations

setMappingJarLocations

setMappingDirectoryLocations

setEntityInterceptor

setImplicitNamingStrategy

setPhysicalNamingStrategy

setJtaTransactionManager

setCurrentTenantIdentifierResolver

setEntityTypeFilters

setHibernateProperties

getHibernateProperties

setAnnotatedClasses

setAnnotatedPackages

setPackagesToScan

setResourceLoader

afterPropertiesSet

buildSessionFactory

getConfiguration

getObject

getObjectType

isSingleton

destroy