|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.orm.hibernate3.AbstractSessionFactoryBean
org.springframework.orm.hibernate3.LocalSessionFactoryBean
public class LocalSessionFactoryBean
FactoryBean that creates a local Hibernate SessionFactory instance. Behaves like a SessionFactory instance when used as bean reference, e.g. for HibernateTemplate's "sessionFactory" property.
The typical usage will be to register this as singleton factory (for a certain underlying JDBC DataSource) in an application context, and give bean references to application services that need it.
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, the latter only being necessary for transactions that 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/Interceptor.
Requires Hibernate 3.0.3 or later. Note that this factory will always use "on_close" as default Hibernate connection release mode, 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").
HibernateAccessor.setSessionFactory(org.hibernate.SessionFactory)
,
HibernateTransactionManager.setSessionFactory(org.hibernate.SessionFactory)
,
AbstractSessionFactoryBean.setExposeTransactionAwareSessionFactory(boolean)
,
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 |
Constructor Detail |
---|
public LocalSessionFactoryBean()
Method Detail |
---|
public static DataSource getConfigTimeDataSource()
This instance will be set before initialization of the corresponding SessionFactory, and reset immediately afterwards. It is thus only available during configuration.
setDataSource(javax.sql.DataSource)
,
LocalDataSourceConnectionProvider
public static TransactionManager getConfigTimeTransactionManager()
This instance will be set before initialization of the corresponding SessionFactory, and reset immediately afterwards. It is thus only available during configuration.
setJtaTransactionManager(javax.transaction.TransactionManager)
,
LocalTransactionManagerLookup
public static LobHandler getConfigTimeLobHandler()
This instance will be set before initialization of the corresponding SessionFactory, and reset immediately afterwards. It is thus only available during configuration.
setLobHandler(org.springframework.jdbc.support.lob.LobHandler)
,
ClobStringType
,
BlobByteArrayType
,
BlobSerializableType
public void setConfigurationClass(Class configurationClass)
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(org.springframework.core.io.Resource)
,
Configuration
,
AnnotationConfiguration
public void setConfigLocation(Resource configLocation)
Note: Can be omitted when all necessary properties and mapping resources are specified locally via this bean.
Configuration.configure(java.net.URL)
public void setConfigLocations(Resource[] configLocations)
Note: Can be omitted when all necessary properties and mapping resources are specified locally via this bean.
Configuration.configure(java.net.URL)
public void setMappingResources(String[] mappingResources)
Can be used to add to mappings from a Hibernate XML config file, or to specify all mappings locally.
setMappingLocations(org.springframework.core.io.Resource[])
,
Configuration.addResource(java.lang.String, java.lang.ClassLoader)
public void setMappingLocations(Resource[] mappingLocations)
Can be used to add to mappings from a Hibernate XML config file, or to specify all mappings locally.
Configuration.addInputStream(java.io.InputStream)
public void setCacheableMappingLocations(Resource[] cacheableMappingLocations)
Can be used to add to mappings from a Hibernate XML config file, or to specify all mappings locally.
Configuration.addCacheableFile(java.io.File)
public void setMappingJarLocations(Resource[] mappingJarLocations)
Can be used to add to mappings from a Hibernate XML config file, or to specify all mappings locally.
Configuration.addJar(java.io.File)
public void setMappingDirectoryLocations(Resource[] mappingDirectoryLocations)
Can be used to add to mappings from a Hibernate XML config file, or to specify all mappings locally.
Configuration.addDirectory(java.io.File)
public void setHibernateProperties(Properties hibernateProperties)
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.
setDataSource(javax.sql.DataSource)
public Properties getHibernateProperties()
public void setDataSource(DataSource dataSource)
If this is set, the Hibernate settings should not define a connection provider to avoid meaningless double configuration.
If using HibernateTransactionManager as transaction strategy, consider proxying your target DataSource with a LazyConnectionDataSourceProxy. This defers fetching of an actual JDBC Connection until the first JDBC Statement gets executed, even within JDBC transactions (as performed by HibernateTransactionManager). Such lazy fetching is particularly beneficial for read-only operations, in particular if the chances of resolving the result in the second-level cache are high.
As JTA and transactional JNDI DataSources already provide lazy enlistment of JDBC Connections, LazyConnectionDataSourceProxy does not add value with JTA (i.e. Spring's JtaTransactionManager) as transaction strategy.
setUseTransactionAwareDataSource(boolean)
,
LocalDataSourceConnectionProvider
,
HibernateTransactionManager
,
JtaTransactionManager
,
LazyConnectionDataSourceProxy
public void setUseTransactionAwareDataSource(boolean useTransactionAwareDataSource)
Default is "false": LocalSessionFactoryBean is usually used with Spring's HibernateTransactionManager or JtaTransactionManager, both of which work nicely on a plain JDBC DataSource. Hibernate Sessions and their JDBC Connections are fully managed by the Hibernate/JTA transaction infrastructure in such a scenario.
If you switch this flag to "true", Spring's Hibernate access will be able to participate in JDBC-based transactions managed outside of Hibernate (for example, by Spring's DataSourceTransactionManager). This can be convenient if you need a different local transaction strategy for another O/R mapping tool, for example, but still want Hibernate access to join into those transactions.
A further benefit of this option is that plain Sessions opened directly
via the SessionFactory, outside of Spring's Hibernate support, will still
participate in active Spring-managed transactions. However, consider using
Hibernate's getCurrentSession()
method instead (see javadoc of
"exposeTransactionAwareSessionFactory" property).
As a further effect, using a transaction-aware DataSource will apply remaining transaction timeouts to all created JDBC Statements. This means that all operations performed by the SessionFactory will automatically participate in Spring-managed transaction timeouts, not just queries. This adds value even for HibernateTransactionManager, but only on Hibernate 3.0, as there is a direct transaction timeout facility in Hibernate 3.1.
WARNING: When using a transaction-aware JDBC DataSource in combination with OpenSessionInViewFilter/Interceptor, whether participating in JTA or external JDBC-based transactions, it is strongly recommended to set Hibernate's Connection release mode to "after_transaction" or "after_statement", which guarantees proper Connection handling in such a scenario. In contrast to that, HibernateTransactionManager generally requires release mode "on_close".
Note: If you want to use Hibernate's Connection release mode "after_statement" with a DataSource specified on this LocalSessionFactoryBean (for example, a JTA-aware DataSource fetched from JNDI), switch this setting to "true". Else, the ConnectionProvider used underneath will vote against aggressive release and thus silently switch to release mode "after_transaction".
setDataSource(javax.sql.DataSource)
,
AbstractSessionFactoryBean.setExposeTransactionAwareSessionFactory(boolean)
,
TransactionAwareDataSourceProxy
,
DataSourceTransactionManager
,
OpenSessionInViewFilter
,
OpenSessionInViewInterceptor
,
HibernateTransactionManager
,
JtaTransactionManager
public void setJtaTransactionManager(TransactionManager jtaTransactionManager)
Note: If this is set, the Hibernate settings should not define a transaction manager lookup to avoid meaningless double configuration.
LocalTransactionManagerLookup
public void setLobHandler(LobHandler lobHandler)
getConfigTimeLobHandler()
,
UserType
,
ClobStringType
,
BlobByteArrayType
,
BlobSerializableType
public void setEntityInterceptor(Interceptor entityInterceptor)
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.
HibernateAccessor.setEntityInterceptor(org.hibernate.Interceptor)
,
HibernateAccessor.setEntityInterceptor(org.hibernate.Interceptor)
,
HibernateTransactionManager.setEntityInterceptor(org.hibernate.Interceptor)
,
Configuration.setInterceptor(org.hibernate.Interceptor)
public void setNamingStrategy(NamingStrategy namingStrategy)
Configuration.setNamingStrategy(org.hibernate.cfg.NamingStrategy)
public void setTypeDefinitions(TypeDefinitionBean[] typeDefinitions)
Unfortunately, Hibernate itself does not define a complete object that represents a type definition, hence the need for Spring's TypeDefinitionBean.
TypeDefinitionBean
,
Mappings.addTypeDef(String, String, java.util.Properties)
public void setFilterDefinitions(FilterDefinition[] filterDefinitions)
Typically, the passed-in FilterDefinition objects will have been defined as Spring FilterDefinitionFactoryBeans, probably as inner beans within the LocalSessionFactoryBean definition.
FilterDefinitionFactoryBean
,
Configuration.addFilterDefinition(org.hibernate.engine.FilterDefinition)
public void setEntityCacheStrategies(Properties entityCacheStrategies)
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>Note that appending a cache region name (with a comma separator) is only supported on Hibernate 3.1, where this functionality is publically available.
entityCacheStrategies
- properties that define entity cache strategies,
with class names as keys and cache concurrency strategies as valuesConfiguration.setCacheConcurrencyStrategy(String, String)
public void setCollectionCacheStrategies(Properties collectionCacheStrategies)
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>Note that appending a cache region name (with a comma separator) is only supported on Hibernate 3.1, where this functionality is publically available.
collectionCacheStrategies
- properties that define collection cache strategies,
with collection roles as keys and cache concurrency strategies as valuesConfiguration.setCollectionCacheConcurrencyStrategy(String, String)
public void setEventListeners(Map eventListeners)
Instead of a single listener object, you can also pass in a list or set of listeners objects as value. However, this is only supported on Hibernate 3.1.
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 valuesConfiguration.setListener(String, Object)
public void setSchemaUpdate(boolean schemaUpdate)
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.
Configuration.generateSchemaUpdateScript(org.hibernate.dialect.Dialect, org.hibernate.tool.hbm2ddl.DatabaseMetadata)
,
SchemaUpdate
protected SessionFactory buildSessionFactory() throws Exception
AbstractSessionFactoryBean
buildSessionFactory
in class AbstractSessionFactoryBean
Exception
- in case of initialization failureprotected Configuration newConfiguration() throws HibernateException
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.
HibernateException
- in case of Hibernate initialization errorsConfiguration.Configuration()
protected void postProcessConfiguration(Configuration config) throws HibernateException
config
- the current Configuration object
HibernateException
- in case of Hibernate initialization errorsprotected SessionFactory newSessionFactory(Configuration config) throws HibernateException
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
HibernateException
- in case of Hibernate initialization errorsConfiguration.buildSessionFactory()
public final Configuration getConfiguration()
IllegalStateException
- if the Configuration object has not been initialized yetprotected void afterSessionFactoryCreation() throws Exception
afterSessionFactoryCreation
in class AbstractSessionFactoryBean
Exception
setSchemaUpdate(boolean)
,
updateDatabaseSchema()
public void destroy() throws HibernateException
destroy
in interface DisposableBean
destroy
in class AbstractSessionFactoryBean
HibernateException
public void dropDatabaseSchema() throws DataAccessException
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 errorsConfiguration.generateDropSchemaScript(org.hibernate.dialect.Dialect)
,
SchemaExport.drop(boolean, boolean)
public void createDatabaseSchema() throws DataAccessException
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 errorsConfiguration.generateSchemaCreationScript(org.hibernate.dialect.Dialect)
,
SchemaExport.create(boolean, boolean)
public void updateDatabaseSchema() throws DataAccessException
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 errorssetSchemaUpdate(boolean)
,
Configuration.generateSchemaUpdateScript(org.hibernate.dialect.Dialect, org.hibernate.tool.hbm2ddl.DatabaseMetadata)
,
SchemaUpdate
protected void executeSchemaScript(Connection con, String[] sql) throws SQLException
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 onsql
- the SQL statements to execute
SQLException
- if thrown by JDBC methodsexecuteSchemaStatement(java.sql.Statement, java.lang.String)
protected void executeSchemaStatement(Statement stmt, String sql) throws SQLException
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 onsql
- the SQL statement to execute
SQLException
- if thrown by JDBC methods (and considered fatal)
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |