LocalSessionFactoryBean (Spring Framework API 2.0) - Spring Framework 2.0.5 API 文档英文版

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

The Spring Framework

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.orm.hibernate3
Class LocalSessionFactoryBean

java.lang.Object
  org.springframework.orm.hibernate3.AbstractSessionFactoryBean
      org.springframework.orm.hibernate3.LocalSessionFactoryBean

All Implemented Interfaces:: DisposableBean, FactoryBean, InitializingBean, PersistenceExceptionTranslator

Direct Known Subclasses:: AnnotationSessionFactoryBean

public class LocalSessionFactoryBean
extends AbstractSessionFactoryBean
extends AbstractSessionFactoryBean

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 DAOs via dependency injection.

Configuration settings can either be read from a Hibernate XML file, specified as "configLocation", or completely via this class. A typical local configuration consists of one or more "mappingResources", various "hibernateProperties" (not strictly necessary), and a "dataSource" that the SessionFactory should use. The latter can also be specified via Hibernate properties, but "dataSource" supports any Spring-configured DataSource, instead of relying on Hibernate's own connection providers.

This SessionFactory handling strategy is appropriate for most types of applications, from Hibernate-only single database apps to ones that need distributed transactions. Either HibernateTransactionManager or JtaTransactionManager can be used for transaction demarcation, with the latter only necessary for transactions which span multiple databases.

This factory bean will by default expose a transaction-aware SessionFactory proxy, letting data access code work with the plain Hibernate SessionFactory and its getCurrentSession() method, while still being able to participate in current Spring-managed transactions: with any transaction management strategy, either local or JTA / EJB CMT, and any transaction synchronization mechanism, either Spring or JTA. Furthermore, getCurrentSession() will also seamlessly work with a request-scoped Session managed by OpenSessionInViewFilter / OpenSessionInViewInterceptor.

Requires Hibernate 3.0.3 or later. Note that this factory will use "on_close" as default Hibernate connection release mode, unless in the case of a "jtaTransactionManager" specified, for the reason that this is appropriate for most Spring-based applications (in particular when using Spring's HibernateTransactionManager). Hibernate 3.0 used "on_close" as its own default too; however, Hibernate 3.1 changed this to "auto" (i.e. "after_statement" or "after_transaction").

Since:: 1.2
Author:: Juergen Hoeller
See Also:: HibernateAccessor.setSessionFactory(org.hibernate.SessionFactory), HibernateTransactionManager.setSessionFactory(org.hibernate.SessionFactory), AbstractSessionFactoryBean.setExposeTransactionAwareSessionFactory(boolean), setJtaTransactionManager(javax.transaction.TransactionManager), SessionFactory.getCurrentSession(), HibernateTransactionManager

Field Summary

Fields inherited from class org.springframework.orm.hibernate3.AbstractSessionFactoryBean

logger

Constructor Summary

LocalSessionFactoryBean()


Method Summary

protected void afterSessionFactoryCreation()
          Executes schema update if requested.

protected SessionFactory buildSessionFactory()
          Build the underlying Hibernate SessionFactory.

void createDatabaseSchema()
          Execute schema creation script, determined by the Configuration object used for creating the SessionFactory.

void destroy()
          Allows for schema export on shutdown.

void dropDatabaseSchema()
          Execute schema drop script, determined by the Configuration object used for creating the SessionFactory.

protected void executeSchemaScript(Connection con, String[] sql)
          Execute the given schema script on the given JDBC Connection.

protected void executeSchemaStatement(Statement stmt, String sql)
          Execute the given schema SQL on the given JDBC Statement.

static DataSource getConfigTimeDataSource()
          Return the DataSource for the currently configured Hibernate SessionFactory, to be used by LocalDataSourceConnectionProvoder.

static LobHandler getConfigTimeLobHandler()
          Return the LobHandler for the currently configured Hibernate SessionFactory, to be used by UserType implementations like ClobStringType.

static TransactionManager getConfigTimeTransactionManager()
          Return the JTA TransactionManager for the currently configured Hibernate SessionFactory, to be used by LocalTransactionManagerLookup.

Configuration getConfiguration()
          Return the Configuration object used to build the SessionFactory.

Properties getHibernateProperties()
          Return the Hibernate properties, if any.

protected Configuration newConfiguration()
          Subclasses can override this method to perform custom initialization of the Configuration instance used for SessionFactory creation.

protected SessionFactory newSessionFactory(Configuration config)
          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.

protected void postProcessConfiguration(Configuration config)
          To be implemented by subclasses that want to to perform custom post-processing of the Configuration object after this FactoryBean performed its default initialization.

void setCacheableMappingLocations(Resource[] cacheableMappingLocations)
          Set locations of cacheable Hibernate mapping files, for example as web app resource "/WEB-INF/mapping/example.hbm.xml".

void setCollectionCacheStrategies(Properties collectionCacheStrategies)
          Specify the cache strategies for persistent collections (with specific roles).

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 setConfigurationClass(Class configurationClass)
          Specify the Hibernate Configuration class to use.

void setDataSource(DataSource dataSource)
          Set the DataSource to be used by the SessionFactory.

void setEntityCacheStrategies(Properties entityCacheStrategies)
          Specify the cache strategies for entities (persistent classes or named entities).

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 setEventListeners(Map eventListeners)
          Specify the Hibernate event listeners to register, with listener types as keys and listener objects as values.

void setFilterDefinitions(FilterDefinition[] filterDefinitions)
          Specify the Hibernate FilterDefinitions to register with the SessionFactory.

void setHibernateProperties(Properties hibernateProperties)
          Set Hibernate properties, such as "hibernate.dialect".

void setJtaTransactionManager(TransactionManager jtaTransactionManager)
          Set the JTA TransactionManager to be used for Hibernate's TransactionManagerLookup.

void setLobHandler(LobHandler lobHandler)
          Set the LobHandler to be used by the SessionFactory.

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 setSchemaUpdate(boolean schemaUpdate)
          Set whether to execute a schema update after SessionFactory initialization.

void setTypeDefinitions(TypeDefinitionBean[] typeDefinitions)
          Specify the Hibernate type definitions to register with the SessionFactory, as Spring TypeDefinitionBean instances.

void setUseTransactionAwareDataSource(boolean useTransactionAwareDataSource)
          Set whether to use a transaction-aware DataSource for the SessionFactory, i.e. whether to automatically wrap the passed-in DataSource with Spring's TransactionAwareDataSourceProxy.

void updateDatabaseSchema()
          Execute schema update script, determined by the Configuration object used for creating the SessionFactory.

Methods inherited from class org.springframework.orm.hibernate3.AbstractSessionFactoryBean

afterPropertiesSet, beforeSessionFactoryDestruction, convertHibernateAccessException, getObject, getObjectType, getSessionFactory, getTransactionAwareSessionFactoryProxy, isExposeTransactionAwareSessionFactory, isSingleton, setExposeTransactionAwareSessionFactory, setJdbcExceptionTranslator, translateExceptionIfPossible, wrapSessionFactoryIfNecessary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Fields inherited from class org.springframework.orm.hibernate3.AbstractSessionFactoryBean
`logger`

Constructor Summary
`LocalSessionFactoryBean()`

Method Summary
`protected void`	`afterSessionFactoryCreation()` Executes schema update if requested.
`protected SessionFactory`	`buildSessionFactory()` Build the underlying Hibernate SessionFactory.
`void`	`createDatabaseSchema()` Execute schema creation script, determined by the Configuration object used for creating the SessionFactory.
`void`	`destroy()` Allows for schema export on shutdown.
`void`	`dropDatabaseSchema()` Execute schema drop script, determined by the Configuration object used for creating the SessionFactory.
`protected void`	`executeSchemaScript(Connection con, String[] sql)` Execute the given schema script on the given JDBC Connection.
`protected void`	`executeSchemaStatement(Statement stmt, String sql)` Execute the given schema SQL on the given JDBC Statement.
`static DataSource`	`getConfigTimeDataSource()` Return the DataSource for the currently configured Hibernate SessionFactory, to be used by LocalDataSourceConnectionProvoder.
`static LobHandler`	`getConfigTimeLobHandler()` Return the LobHandler for the currently configured Hibernate SessionFactory, to be used by UserType implementations like ClobStringType.
`static TransactionManager`	`getConfigTimeTransactionManager()` Return the JTA TransactionManager for the currently configured Hibernate SessionFactory, to be used by LocalTransactionManagerLookup.
`Configuration`	`getConfiguration()` Return the Configuration object used to build the SessionFactory.
`Properties`	`getHibernateProperties()` Return the Hibernate properties, if any.
`protected Configuration`	`newConfiguration()` Subclasses can override this method to perform custom initialization of the Configuration instance used for SessionFactory creation.
`protected SessionFactory`	`newSessionFactory(Configuration config)` 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.
`protected void`	`postProcessConfiguration(Configuration config)` To be implemented by subclasses that want to to perform custom post-processing of the Configuration object after this FactoryBean performed its default initialization.
`void`	`setCacheableMappingLocations(Resource[] cacheableMappingLocations)` Set locations of cacheable Hibernate mapping files, for example as web app resource "/WEB-INF/mapping/example.hbm.xml".
`void`	`setCollectionCacheStrategies(Properties collectionCacheStrategies)` Specify the cache strategies for persistent collections (with specific roles).
`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`	`setConfigurationClass(Class configurationClass)` Specify the Hibernate Configuration class to use.
`void`	`setDataSource(DataSource dataSource)` Set the DataSource to be used by the SessionFactory.
`void`	`setEntityCacheStrategies(Properties entityCacheStrategies)` Specify the cache strategies for entities (persistent classes or named entities).
`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`	`setEventListeners(Map eventListeners)` Specify the Hibernate event listeners to register, with listener types as keys and listener objects as values.
`void`	`setFilterDefinitions(FilterDefinition[] filterDefinitions)` Specify the Hibernate FilterDefinitions to register with the SessionFactory.
`void`	`setHibernateProperties(Properties hibernateProperties)` Set Hibernate properties, such as "hibernate.dialect".
`void`	`setJtaTransactionManager(TransactionManager jtaTransactionManager)` Set the JTA TransactionManager to be used for Hibernate's TransactionManagerLookup.
`void`	`setLobHandler(LobHandler lobHandler)` Set the LobHandler to be used by the SessionFactory.
`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`	`setSchemaUpdate(boolean schemaUpdate)` Set whether to execute a schema update after SessionFactory initialization.
`void`	`setTypeDefinitions(TypeDefinitionBean[] typeDefinitions)` Specify the Hibernate type definitions to register with the SessionFactory, as Spring TypeDefinitionBean instances.
`void`	`setUseTransactionAwareDataSource(boolean useTransactionAwareDataSource)` Set whether to use a transaction-aware DataSource for the SessionFactory, i.e. whether to automatically wrap the passed-in DataSource with Spring's TransactionAwareDataSourceProxy.
`void`	`updateDatabaseSchema()` Execute schema update script, determined by the Configuration object used for creating the SessionFactory.

Methods inherited from class org.springframework.orm.hibernate3.AbstractSessionFactoryBean
`afterPropertiesSet, beforeSessionFactoryDestruction, convertHibernateAccessException, getObject, getObjectType, getSessionFactory, getTransactionAwareSessionFactoryProxy, isExposeTransactionAwareSessionFactory, isSingleton, setExposeTransactionAwareSessionFactory, setJdbcExceptionTranslator, translateExceptionIfPossible, wrapSessionFactoryIfNecessary`

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

getConfigTimeDataSource

public static DataSource getConfigTimeDataSource()

Return the DataSource for the currently configured Hibernate SessionFactory, to be used by LocalDataSourceConnectionProvoder.

This instance will be set before initialization of the corresponding SessionFactory, and reset immediately afterwards. It is thus only available during configuration.

See Also:: setDataSource(javax.sql.DataSource), LocalDataSourceConnectionProvider

getConfigTimeTransactionManager

public static TransactionManager getConfigTimeTransactionManager()

Return the JTA TransactionManager for the currently configured Hibernate SessionFactory, to be used by LocalTransactionManagerLookup.

This instance will be set before initialization of the corresponding SessionFactory, and reset immediately afterwards. It is thus only available during configuration.

See Also:: setJtaTransactionManager(javax.transaction.TransactionManager), LocalTransactionManagerLookup

getConfigTimeLobHandler

public static LobHandler getConfigTimeLobHandler()

Return the LobHandler for the currently configured Hibernate SessionFactory, to be used by UserType implementations like ClobStringType.

This instance will be set before initialization of the corresponding SessionFactory, and reset immediately afterwards. It is thus only available during configuration.

See Also:: setLobHandler(org.springframework.jdbc.support.lob.LobHandler), ClobStringType, BlobByteArrayType, BlobSerializableType

setConfigurationClass

public void setConfigurationClass(Class configurationClass)

Specify the Hibernate Configuration class to use. Default is "org.hibernate.cfg.Configuration"; any subclass of this default Hibernate Configuration class can be specified.

Can be set to "org.hibernate.cfg.AnnotationConfiguration" for using Hibernate3 annotation support (initially only available as alpha download separate from the main Hibernate3 distribution).

Annotated packages and annotated classes can be specified via the corresponding tags in "hibernate.cfg.xml" then, so this will usually be combined with a "configLocation" property that points at such a standard Hibernate configuration file.

See Also:: setConfigLocation(org.springframework.core.io.Resource), Configuration, AnnotationConfiguration

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.