java.lang.Object | ||
↳ | org.springframework.orm.hibernate3.AbstractSessionFactoryBean | |
↳ | org.springframework.orm.hibernate3.LocalSessionFactoryBean |
Known Direct Subclasses |
FactoryBean
that creates a
Hibernate org.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.2 or later; tested with 3.3, 3.5 and 3.6. 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).
setSessionFactory(SessionFactory)
setSessionFactory(SessionFactory)
setExposeTransactionAwareSessionFactory(boolean)
setJtaTransactionManager(TransactionManager)
HibernateTransactionManager
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.springframework.orm.hibernate3.AbstractSessionFactoryBean
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Execute schema creation script, determined by the Configuration object
used for creating the SessionFactory.
| |||||||||||
Allows for schema export on shutdown.
| |||||||||||
Execute schema drop script, determined by the Configuration object
used for creating the SessionFactory.
| |||||||||||
Return the CacheProvider for the currently configured Hibernate SessionFactory,
to be used by LocalCacheProviderProxy.
| |||||||||||
Return the DataSource for the currently configured Hibernate SessionFactory,
to be used by LocalDataSourceConnectionProvoder.
| |||||||||||
Return the LobHandler for the currently configured Hibernate SessionFactory,
to be used by UserType implementations like ClobStringType.
| |||||||||||
Return the JTA TransactionManager for the currently configured Hibernate
SessionFactory, to be used by LocalTransactionManagerLookup.
| |||||||||||
Return the Configuration object used to build the SessionFactory.
| |||||||||||
Return the Hibernate properties, if any.
| |||||||||||
Callback that supplies the bean
class loader to
a bean instance. | |||||||||||
This method is deprecated.
as of Spring 3.0, following Hibernate 3.3's deprecation
of the CacheProvider SPI
| |||||||||||
Set the Hibernate RegionFactory to use for the SessionFactory.
| |||||||||||
Set locations of cacheable Hibernate mapping files, for example as web app
resource "/WEB-INF/mapping/example.hbm.xml".
| |||||||||||
Specify the cache strategies for persistent collections (with specific roles).
| |||||||||||
Set the location of a single Hibernate XML config file, for example as
classpath resource "classpath:hibernate.cfg.xml".
| |||||||||||
Set the locations of multiple Hibernate XML config files, for example as
classpath resources "classpath:hibernate.cfg.xml,classpath:extension.cfg.xml".
| |||||||||||
Specify the Hibernate Configuration class to use.
| |||||||||||
Specify the cache strategies for entities (persistent classes or named entities).
| |||||||||||
Set a Hibernate entity interceptor that allows to inspect and change
property values before writing to and reading from the database.
| |||||||||||
Specify the Hibernate event listeners to register, with listener types
as keys and listener objects as values.
| |||||||||||
Specify the Hibernate FilterDefinitions to register with the SessionFactory.
| |||||||||||
Set Hibernate properties, such as "hibernate.dialect".
| |||||||||||
Set the JTA TransactionManager to be used for Hibernate's
TransactionManagerLookup.
| |||||||||||
Set the LobHandler to be used by the SessionFactory.
| |||||||||||
Set locations of directories that contain Hibernate mapping resources,
like "WEB-INF/mappings".
| |||||||||||
Set locations of jar files that contain Hibernate mapping resources,
like "WEB-INF/lib/example.hbm.jar".
| |||||||||||
Set locations of Hibernate mapping files, for example as classpath
resource "classpath:example.hbm.xml".
| |||||||||||
Set Hibernate mapping resources to be found in the class path,
like "example.hbm.xml" or "mypackage/example.hbm.xml".
| |||||||||||
Set a Hibernate NamingStrategy for the SessionFactory, determining the
physical column and table names given the info in the mapping document.
| |||||||||||
Set whether to execute a schema update after SessionFactory initialization.
| |||||||||||
Specify the Hibernate type definitions to register with the SessionFactory,
as Spring TypeDefinitionBean instances.
| |||||||||||
Execute schema update script, determined by the Configuration object
used for creating the SessionFactory.
| |||||||||||
Execute schema creation script, determined by the Configuration object
used for creating the SessionFactory.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Executes schema update if requested.
| |||||||||||
Build the underlying Hibernate SessionFactory.
| |||||||||||
Execute the given schema script on the given JDBC Connection.
| |||||||||||
Execute the given schema SQL on the given JDBC Statement.
| |||||||||||
Subclasses can override this method to perform custom initialization
of the Configuration instance used for SessionFactory creation.
| |||||||||||
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.
| |||||||||||
To be implemented by subclasses that want to to perform custom
post-processing of the Configuration object after this FactoryBean
performed its default initialization.
| |||||||||||
To be implemented by subclasses that want to to register further mappings
on the Configuration object after this FactoryBean registered its specified
mappings.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.springframework.orm.hibernate3.AbstractSessionFactoryBean
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
org.springframework.beans.factory.BeanClassLoaderAware
| |||||||||||
From interface
org.springframework.beans.factory.DisposableBean
| |||||||||||
From interface
org.springframework.beans.factory.FactoryBean
| |||||||||||
From interface
org.springframework.beans.factory.InitializingBean
| |||||||||||
From interface
org.springframework.dao.support.PersistenceExceptionTranslator
|
Execute schema creation script, determined by the Configuration object used for creating the SessionFactory. A replacement for Hibernate's SchemaExport class, to be invoked on application setup.
Fetch the LocalSessionFactoryBean itself rather than the exposed
SessionFactory to be able to invoke this method, e.g. via
LocalSessionFactoryBean lsfb = (LocalSessionFactoryBean) ctx.getBean("&mySessionFactory");
.
Uses the SessionFactory that this bean generates for accessing a JDBC connection to perform the script.
DataAccessException | in case of script execution errors |
---|
Allows for schema export on shutdown.
HibernateException |
---|
Execute schema drop script, determined by the Configuration object used for creating the SessionFactory. A replacement for Hibernate's SchemaExport class, to be invoked on application setup.
Fetch the LocalSessionFactoryBean itself rather than the exposed
SessionFactory to be able to invoke this method, e.g. via
LocalSessionFactoryBean lsfb = (LocalSessionFactoryBean) ctx.getBean("&mySessionFactory");
.
Uses the SessionFactory that this bean generates for accessing a JDBC connection to perform the script.
DataAccessException | in case of script execution errors |
---|
Return the CacheProvider for the currently configured Hibernate SessionFactory, to be used by LocalCacheProviderProxy.
This instance will be set before initialization of the corresponding SessionFactory, and reset immediately afterwards. It is thus only available during configuration.
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.
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.
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.
Return the Configuration object used to build the SessionFactory. Allows access to configuration metadata stored there (rarely needed).
IllegalStateException | if the Configuration object has not been initialized yet |
---|
Return the Hibernate properties, if any. Mainly available for configuration through property paths that specify individual keys.
Callback that supplies the bean class loader
to
a bean instance.
Invoked after the population of normal bean properties but
before an initialization callback such as
InitializingBean's
afterPropertiesSet()
method or a custom init-method.
beanClassLoader | the owning class loader; may be null in
which case a default ClassLoader must be used, for example
the ClassLoader obtained via
getDefaultClassLoader()
|
---|
This method is deprecated.
as of Spring 3.0, following Hibernate 3.3's deprecation
of the CacheProvider SPI
Set the Hibernate CacheProvider to use for the SessionFactory. Allows for using a Spring-managed CacheProvider instance.
Note: If this is set, the Hibernate settings should not define a cache provider to avoid meaningless double configuration.
Set the Hibernate RegionFactory to use for the SessionFactory. Allows for using a Spring-managed RegionFactory instance.
As of Hibernate 3.3, this is the preferred mechanism for configuring
caches, superseding the CacheProvider SPI
.
For Hibernate 3.2 compatibility purposes, the accepted reference is of type
Object: the actual type is org.hibernate.cache.RegionFactory
.
Note: If this is set, the Hibernate settings should not define a cache provider to avoid meaningless double configuration.
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.
Specify the cache strategies for persistent collections (with specific roles). This configuration setting corresponds to the <collection-cache> entry in the "hibernate.cfg.xml" configuration format.
For example:
<property name="collectionCacheStrategies"> <props> <prop key="com.mycompany.Order.items">read-write</prop> <prop key="com.mycompany.Product.categories">read-only,myRegion</prop> </props> </property>
collectionCacheStrategies | properties that define collection cache strategies, with collection roles as keys and cache concurrency strategies as values |
---|
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.
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.
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.
setConfigLocation(Resource)
Specify the cache strategies for entities (persistent classes or named entities). This configuration setting corresponds to the <class-cache> entry in the "hibernate.cfg.xml" configuration format.
For example:
<property name="entityCacheStrategies"> <props> <prop key="com.mycompany.Customer">read-write</prop> <prop key="com.mycompany.Product">read-only,myRegion</prop> </props> </property>
entityCacheStrategies | properties that define entity cache strategies, with class names as keys and cache concurrency strategies as values |
---|
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.
Such an interceptor can either be set at the SessionFactory level, i.e. on LocalSessionFactoryBean, or at the Session level, i.e. on HibernateTemplate, HibernateInterceptor, and HibernateTransactionManager. It's preferable to set it on LocalSessionFactoryBean or HibernateTransactionManager to avoid repeated configuration and guarantee consistent behavior in transactions.
setEntityInterceptor(Interceptor)
setEntityInterceptor(Interceptor)
setEntityInterceptor(Interceptor)
Specify the Hibernate event listeners to register, with listener types as keys and listener objects as values. Instead of a single listener object, you can also pass in a list or set of listeners objects as value.
See the Hibernate documentation for further details on listener types and associated listener interfaces.
eventListeners | Map with listener type Strings as keys and listener objects as values |
---|
Specify the Hibernate FilterDefinitions to register with the SessionFactory. This is an alternative to specifying <<filter-def> elements in Hibernate mapping files.
Typically, the passed-in FilterDefinition objects will have been defined as Spring FilterDefinitionFactoryBeans, probably as inner beans within the LocalSessionFactoryBean definition.
FilterDefinitionFactoryBean
Set Hibernate properties, such as "hibernate.dialect".
Can be used to override values in a Hibernate XML config file, or to specify all necessary properties locally.
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.
Set the JTA TransactionManager to be used for Hibernate's TransactionManagerLookup. Allows for using a Spring-managed JTA TransactionManager for Hibernate's cache synchronization.
Note: If this is set, the Hibernate settings should not define a transaction manager lookup to avoid meaningless double configuration.
Set the LobHandler to be used by the SessionFactory. Will be exposed at config time for UserType implementations.
getConfigTimeLobHandler()
ClobStringType
BlobByteArrayType
BlobSerializableType
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.
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.
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.
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.
setMappingLocations(Resource[])
Set a Hibernate NamingStrategy for the SessionFactory, determining the physical column and table names given the info in the mapping document.
Set whether to execute a schema update after SessionFactory initialization.
For details on how to make schema update scripts work, see the Hibernate documentation, as this class leverages the same schema update script support in org.hibernate.cfg.Configuration as Hibernate's own SchemaUpdate tool.
Specify the Hibernate type definitions to register with the SessionFactory, as Spring TypeDefinitionBean instances. This is an alternative to specifying <<typedef> elements in Hibernate mapping files.
Unfortunately, Hibernate itself does not define a complete object that represents a type definition, hence the need for Spring's TypeDefinitionBean.
TypeDefinitionBean
Execute schema update script, determined by the Configuration object used for creating the SessionFactory. A replacement for Hibernate's SchemaUpdate class, for automatically executing schema update scripts on application startup. Can also be invoked manually.
Fetch the LocalSessionFactoryBean itself rather than the exposed
SessionFactory to be able to invoke this method, e.g. via
LocalSessionFactoryBean lsfb = (LocalSessionFactoryBean) ctx.getBean("&mySessionFactory");
.
Uses the SessionFactory that this bean generates for accessing a JDBC connection to perform the script.
DataAccessException | in case of script execution errors |
---|
setSchemaUpdate(boolean)
Execute schema creation script, determined by the Configuration object used for creating the SessionFactory. A replacement for Hibernate's SchemaValidator class, to be invoked after application startup.
Fetch the LocalSessionFactoryBean itself rather than the exposed
SessionFactory to be able to invoke this method, e.g. via
LocalSessionFactoryBean lsfb = (LocalSessionFactoryBean) ctx.getBean("&mySessionFactory");
.
Uses the SessionFactory that this bean generates for accessing a JDBC connection to perform the script.
DataAccessException | in case of script execution errors |
---|
Build the underlying Hibernate SessionFactory.
Exception |
---|
Execute the given schema script on the given JDBC Connection.
Note that the default implementation will log unsuccessful statements
and continue to execute. Override the executeSchemaStatement
method to treat failures differently.
con | the JDBC Connection to execute the script on |
---|---|
sql | the SQL statements to execute |
SQLException | if thrown by JDBC methods |
---|
Execute the given schema SQL on the given JDBC Statement.
Note that the default implementation will log unsuccessful statements and continue to execute. Override this method to treat failures differently.
stmt | the JDBC Statement to execute the SQL on |
---|---|
sql | the SQL statement to execute |
SQLException | if thrown by JDBC methods (and considered fatal) |
---|
Subclasses can override this method to perform custom initialization of the Configuration instance used for SessionFactory creation. The properties of this LocalSessionFactoryBean will be applied to the Configuration object that gets returned here.
The default implementation creates a new Configuration instance. A custom implementation could prepare the instance in a specific way, or use a custom Configuration subclass.
in case of Hibernate initialization errors | |
HibernateException |
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 Configuration's buildSessionFactory. A custom implementation could prepare the instance in a specific way, or use a custom SessionFactoryImpl subclass.
config | Configuration prepared by this LocalSessionFactoryBean |
---|
in case of Hibernate initialization errors | |
HibernateException |
To be implemented by subclasses that want to to perform custom post-processing of the Configuration object after this FactoryBean performed its default initialization.
Invoked after the Configuration.buildMappings()
call,
so that it can operate on the completed and fully parsed mapping information.
config | the current Configuration object |
---|
in case of Hibernate initialization errors | |
HibernateException |
To be implemented by subclasses that want to to register further mappings on the Configuration object after this FactoryBean registered its specified mappings.
Invoked before the Configuration.buildMappings()
call,
so that it can still extend and modify the mapping information.
config | the current Configuration object |
---|
in case of Hibernate initialization errors | |
HibernateException |