LocalSessionFactoryBean

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.orm.hibernate4
Class LocalSessionFactoryBean

java.lang.Object
  org.springframework.orm.hibernate4.HibernateExceptionTranslator
      org.springframework.orm.hibernate4.LocalSessionFactoryBean

All Implemented Interfaces:: Aware, DisposableBean, FactoryBean<SessionFactory>, InitializingBean, ResourceLoaderAware, PersistenceExceptionTranslator

public class LocalSessionFactoryBean
extends HibernateExceptionTranslator
implements FactoryBean<SessionFactory>, ResourceLoaderAware, InitializingBean, DisposableBean
extends HibernateExceptionTranslator
implements FactoryBean<SessionFactory>, ResourceLoaderAware, InitializingBean, 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.

NOTE: This variant of LocalSessionFactoryBean requires Hibernate 4.0 or higher. It 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 annotation scanning.

NOTE: To set up Hibernate 4 for Spring-driven JTA transactions, make sure to either specify the "jtaTransactionManager" bean property or to set the "hibernate.transaction.factory_class" property to CMTTransactionFactory. Otherwise, Hibernate's smart flushing mechanism won't work properly.

Since:: 3.1
Author:: Juergen Hoeller
See Also:: setDataSource(javax.sql.DataSource), setPackagesToScan(java.lang.String...)

Constructor Summary
`LocalSessionFactoryBean()`

Method Summary
`void`	`afterPropertiesSet()` Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
`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()` Invoked by a BeanFactory on destruction of a singleton.
`Configuration`	`getConfiguration()` Return the Hibernate Configuration object used to build the SessionFactory.
`Properties`	`getHibernateProperties()` Return the Hibernate properties, if any.
`SessionFactory`	`getObject()` Return an instance (possibly shared or independent) of the object managed by this factory.
`Class<?>`	`getObjectType()` Return the type of object that this FactoryBean creates, or `null` if not known in advance.
`boolean`	`isSingleton()` Is the object managed by this factory a singleton? That is, will `FactoryBean.getObject()` always return the same object (a reference that can be cached)?
`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(Resource[] cacheableMappingLocations)` Set locations of cacheable Hibernate mapping files, for example as web app resource "/WEB-INF/mapping/example.hbm.xml".
`void`	`setConfigLocation(Resource configLocation)` Set the location of a single Hibernate XML config file, for example as classpath resource "classpath:hibernate.cfg.xml".
`void`	`setConfigLocations(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`	`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`	`setHibernateProperties(Properties hibernateProperties)` Set Hibernate properties, such as "hibernate.dialect".
`void`	`setJtaTransactionManager(Object jtaTransactionManager)` Set the Spring `JtaTransactionManager` or the JTA `TransactionManager` to be used with Hibernate, if any.
`void`	`setMappingDirectoryLocations(Resource[] mappingDirectoryLocations)` Set locations of directories that contain Hibernate mapping resources, like "WEB-INF/mappings".
`void`	`setMappingJarLocations(Resource[] mappingJarLocations)` Set locations of jar files that contain Hibernate mapping resources, like "WEB-INF/lib/example.hbm.jar".
`void`	`setMappingLocations(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`	`setNamingStrategy(NamingStrategy namingStrategy)` Set a Hibernate NamingStrategy for the SessionFactory, determining the physical column and table names given the info in the mapping document.
`void`	`setPackagesToScan(String... packagesToScan)` Specify packages to search for autodetection of your entity classes in the classpath.
`void`	`setResourceLoader(ResourceLoader resourceLoader)` Set the ResourceLoader that this object runs in.

Methods inherited from class org.springframework.orm.hibernate4.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(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(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.