Spring Framework

org.springframework.orm.hibernate3
Class LocalSessionFactoryBean

java.lang.Object
  extended by org.springframework.orm.hibernate3.HibernateExceptionTranslator
      extended by org.springframework.orm.hibernate3.AbstractSessionFactoryBean
          extended by org.springframework.orm.hibernate3.LocalSessionFactoryBean
All Implemented Interfaces:
Aware, BeanClassLoaderAware, DisposableBean, FactoryBean<org.hibernate.SessionFactory>, InitializingBean, PersistenceExceptionTranslator
Direct Known Subclasses:
AnnotationSessionFactoryBean

public class LocalSessionFactoryBean
extends AbstractSessionFactoryBean
implements BeanClassLoaderAware

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.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).

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  org.hibernate.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(java.sql.Connection con, java.lang.String[] sql)
          Execute the given schema script on the given JDBC Connection.
protected  void executeSchemaStatement(java.sql.Statement stmt, java.lang.String sql)
          Execute the given schema SQL on the given JDBC Statement.
static org.hibernate.cache.CacheProvider getConfigTimeCacheProvider()
          Return the CacheProvider for the currently configured Hibernate SessionFactory, to be used by LocalCacheProviderProxy.
static javax.sql.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 javax.transaction.TransactionManager getConfigTimeTransactionManager()
          Return the JTA TransactionManager for the currently configured Hibernate SessionFactory, to be used by LocalTransactionManagerLookup.
 org.hibernate.cfg.Configuration getConfiguration()
          Return the Configuration object used to build the SessionFactory.
 java.util.Properties getHibernateProperties()
          Return the Hibernate properties, if any.
protected  org.hibernate.cfg.Configuration newConfiguration()
          Subclasses can override this method to perform custom initialization of the Configuration instance used for SessionFactory creation.
protected  org.hibernate.SessionFactory newSessionFactory(org.hibernate.cfg.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(org.hibernate.cfg.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.
protected  void postProcessMappings(org.hibernate.cfg.Configuration config)
          To be implemented by subclasses that want to to register further mappings on the Configuration object after this FactoryBean registered its specified mappings.
 void setBeanClassLoader(java.lang.ClassLoader beanClassLoader)
          Callback that supplies the bean class loader to a bean instance.
 void setCacheableMappingLocations(Resource[] cacheableMappingLocations)
          Set locations of cacheable Hibernate mapping files, for example as web app resource "/WEB-INF/mapping/example.hbm.xml".
 void setCacheProvider(org.hibernate.cache.CacheProvider cacheProvider)
          Deprecated. as of Spring 3.0, following Hibernate 3.3's deprecation of the CacheProvider SPI
 void setCacheRegionFactory(java.lang.Object cacheRegionFactory)
          Set the Hibernate RegionFactory to use for the SessionFactory.
 void setCollectionCacheStrategies(java.util.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(java.lang.Class<?> configurationClass)
          Specify the Hibernate Configuration class to use.
 void setEntityCacheStrategies(java.util.Properties entityCacheStrategies)
          Specify the cache strategies for entities (persistent classes or named entities).
 void setEntityInterceptor(org.hibernate.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(java.util.Map<java.lang.String,java.lang.Object> eventListeners)
          Specify the Hibernate event listeners to register, with listener types as keys and listener objects as values.
 void setFilterDefinitions(org.hibernate.engine.FilterDefinition[] filterDefinitions)
          Specify the Hibernate FilterDefinitions to register with the SessionFactory.
 void setHibernateProperties(java.util.Properties hibernateProperties)
          Set Hibernate properties, such as "hibernate.dialect".
 void setJtaTransactionManager(javax.transaction.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(java.lang.String[] mappingResources)
          Set Hibernate mapping resources to be found in the class path, like "example.hbm.xml" or "mypackage/example.hbm.xml".
 void setNamingStrategy(org.hibernate.cfg.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 updateDatabaseSchema()
          Execute schema update script, determined by the Configuration object used for creating the SessionFactory.
 void validateDatabaseSchema()
          Execute schema creation script, determined by the Configuration object used for creating the SessionFactory.
 
Methods inherited from class org.springframework.orm.hibernate3.AbstractSessionFactoryBean
afterPropertiesSet, beforeSessionFactoryDestruction, getDataSource, getObject, getObjectType, getSessionFactory, isExposeTransactionAwareSessionFactory, isSingleton, isUseTransactionAwareDataSource, setDataSource, setExposeTransactionAwareSessionFactory, setUseTransactionAwareDataSource, wrapSessionFactoryIfNecessary
 
Methods inherited from class org.springframework.orm.hibernate3.HibernateExceptionTranslator
convertHibernateAccessException, setJdbcExceptionTranslator, 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

getConfigTimeDataSource

public static javax.sql.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:
AbstractSessionFactoryBean.setDataSource(javax.sql.DataSource), LocalDataSourceConnectionProvider

getConfigTimeTransactionManager

public static javax.transaction.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

getConfigTimeCacheProvider

public static org.hibernate.cache.CacheProvider getConfigTimeCacheProvider()
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.

See Also:
setCacheProvider(org.hibernate.cache.CacheProvider)

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(java.lang.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(java.lang.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(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(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(java.io.File)

setMappingJarLocations

public void setMappingJarLocations(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(java.io.File)

setMappingDirectoryLocations

public void setMappingDirectoryLocations(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(java.io.File)

setHibernateProperties

public void setHibernateProperties(java.util.Properties hibernateProperties)
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.

See Also:
AbstractSessionFactoryBean.setDataSource(javax.sql.DataSource)

getHibernateProperties

public java.util.Properties getHibernateProperties()
Return the Hibernate properties, if any. Mainly available for configuration through property paths that specify individual keys.


setJtaTransactionManager

public void setJtaTransactionManager(javax.transaction.TransactionManager jtaTransactionManager)
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.

See Also:
LocalTransactionManagerLookup

setCacheRegionFactory

public void setCacheRegionFactory(java.lang.Object cacheRegionFactory)
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.

See Also:
RegionFactory

setCacheProvider

@Deprecated
public void setCacheProvider(org.hibernate.cache.CacheProvider cacheProvider)
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.

See Also:
setCacheRegionFactory(java.lang.Object)

setLobHandler

public void setLobHandler(LobHandler lobHandler)
Set the LobHandler to be used by the SessionFactory. Will be exposed at config time for UserType implementations.

See Also:
getConfigTimeLobHandler(), UserType, ClobStringType, BlobByteArrayType, BlobSerializableType

setEntityInterceptor

public void setEntityInterceptor(org.hibernate.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.

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.

See Also:
HibernateAccessor.setEntityInterceptor(org.hibernate.Interceptor), HibernateAccessor.setEntityInterceptor(org.hibernate.Interceptor), HibernateTransactionManager.setEntityInterceptor(org.hibernate.Interceptor), Configuration.setInterceptor(org.hibernate.Interceptor)

setNamingStrategy

public void setNamingStrategy(org.hibernate.cfg.NamingStrategy namingStrategy)
Set a Hibernate NamingStrategy for the SessionFactory, determining the physical column and table names given the info in the mapping document.

See Also:
Configuration.setNamingStrategy(org.hibernate.cfg.NamingStrategy)

setTypeDefinitions

public void setTypeDefinitions(TypeDefinitionBean[] typeDefinitions)
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.

See Also:
TypeDefinitionBean, Mappings.addTypeDef(String, String, java.util.Properties)

setFilterDefinitions

public void setFilterDefinitions(org.hibernate.engine.FilterDefinition[] filterDefinitions)
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.

See Also:
FilterDefinitionFactoryBean, Configuration.addFilterDefinition(org.hibernate.engine.FilterDefinition)

setEntityCacheStrategies

public void setEntityCacheStrategies(java.util.Properties entityCacheStrategies)
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>

Parameters:
entityCacheStrategies - properties that define entity cache strategies, with class names as keys and cache concurrency strategies as values
See Also:
Configuration.setCacheConcurrencyStrategy(String, String)

setCollectionCacheStrategies

public void setCollectionCacheStrategies(java.util.Properties collectionCacheStrategies)
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>

Parameters:
collectionCacheStrategies - properties that define collection cache strategies, with collection roles as keys and cache concurrency strategies as values
See Also:
Configuration.setCollectionCacheConcurrencyStrategy(String, String)

setEventListeners

public void setEventListeners(java.util.Map<java.lang.String,java.lang.Object> eventListeners)
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.

Parameters:
eventListeners - Map with listener type Strings as keys and listener objects as values
See Also:
Configuration.setListener(String, Object)

setSchemaUpdate

public void setSchemaUpdate(boolean schemaUpdate)
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.

See Also:
Configuration.generateSchemaUpdateScript(org.hibernate.dialect.Dialect, org.hibernate.tool.hbm2ddl.DatabaseMetadata), SchemaUpdate

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader beanClassLoader)
Description copied from interface: BeanClassLoaderAware
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 InitializingBean.afterPropertiesSet() method or a custom init-method.

Specified by:
setBeanClassLoader in interface BeanClassLoaderAware
Parameters:
beanClassLoader - the owning class loader; may be null in which case a default ClassLoader must be used, for example the ClassLoader obtained via ClassUtils.getDefaultClassLoader()

buildSessionFactory

protected org.hibernate.SessionFactory buildSessionFactory()
                                                    throws java.lang.Exception
Description copied from class: AbstractSessionFactoryBean
Build the underlying Hibernate SessionFactory.

Specified by:
buildSessionFactory in class AbstractSessionFactoryBean
Returns:
the raw SessionFactory (potentially to be wrapped with a transaction-aware proxy before it is exposed to the application)
Throws:
java.lang.Exception - in case of initialization failure

newConfiguration

protected org.hibernate.cfg.Configuration newConfiguration()
                                                    throws org.hibernate.HibernateException
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.

Returns:
the Configuration instance
Throws:
org.hibernate.HibernateException - in case of Hibernate initialization errors
See Also:
Configuration.Configuration()

postProcessMappings

protected void postProcessMappings(org.hibernate.cfg.Configuration config)
                            throws org.hibernate.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.

Parameters:
config - the current Configuration object
Throws:
org.hibernate.HibernateException - in case of Hibernate initialization errors
See Also:
Configuration.buildMappings()

postProcessConfiguration

protected void postProcessConfiguration(org.hibernate.cfg.Configuration config)
                                 throws org.hibernate.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.

Parameters:
config - the current Configuration object
Throws:
org.hibernate.HibernateException - in case of Hibernate initialization errors
See Also:
Configuration.buildMappings()

newSessionFactory

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

Parameters:
config - Configuration prepared by this LocalSessionFactoryBean
Returns:
the SessionFactory instance
Throws:
org.hibernate.HibernateException - in case of Hibernate initialization errors
See Also:
Configuration.buildSessionFactory()

getConfiguration

public final org.hibernate.cfg.Configuration getConfiguration()
Return the Configuration object used to build the SessionFactory. Allows for access to configuration metadata stored there (rarely needed).

Throws:
java.lang.IllegalStateException - if the Configuration object has not been initialized yet

afterSessionFactoryCreation

protected void afterSessionFactoryCreation()
                                    throws java.lang.Exception
Executes schema update if requested.

Overrides:
afterSessionFactoryCreation in class AbstractSessionFactoryBean
Throws:
java.lang.Exception - in case of initialization failure
See Also:
setSchemaUpdate(boolean), updateDatabaseSchema()

destroy

public void destroy()
             throws org.hibernate.HibernateException
Allows for schema export on shutdown.

Specified by:
destroy in interface DisposableBean
Overrides:
destroy in class AbstractSessionFactoryBean
Throws:
org.hibernate.HibernateException

updateDatabaseSchema

public void updateDatabaseSchema()
                          throws DataAccessException
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.

Throws:
DataAccessException - in case of script execution errors
See Also:
setSchemaUpdate(boolean), Configuration.generateSchemaUpdateScript(org.hibernate.dialect.Dialect, org.hibernate.tool.hbm2ddl.DatabaseMetadata), SchemaUpdate

validateDatabaseSchema

public void validateDatabaseSchema()
                            throws DataAccessException
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.

Throws:
DataAccessException - in case of script execution errors
See Also:
Configuration.validateSchema(org.hibernate.dialect.Dialect, org.hibernate.tool.hbm2ddl.DatabaseMetadata), SchemaValidator

dropDatabaseSchema

public void dropDatabaseSchema()
                        throws DataAccessException
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.

Throws:
DataAccessException - in case of script execution errors
See Also:
Configuration.generateDropSchemaScript(org.hibernate.dialect.Dialect), SchemaExport.drop(boolean, boolean)

createDatabaseSchema

public void createDatabaseSchema()
                          throws DataAccessException
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.

Throws:
DataAccessException - in case of script execution errors
See Also:
Configuration.generateSchemaCreationScript(org.hibernate.dialect.Dialect), SchemaExport.create(boolean, boolean)

executeSchemaScript

protected void executeSchemaScript(java.sql.Connection con,
                                   java.lang.String[] sql)
                            throws java.sql.SQLException
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.

Parameters:
con - the JDBC Connection to execute the script on
sql - the SQL statements to execute
Throws:
java.sql.SQLException - if thrown by JDBC methods
See Also:
executeSchemaStatement(java.sql.Statement, java.lang.String)

executeSchemaStatement

protected void executeSchemaStatement(java.sql.Statement stmt,
                                      java.lang.String sql)
                               throws java.sql.SQLException
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.

Parameters:
stmt - the JDBC Statement to execute the SQL on
sql - the SQL statement to execute
Throws:
java.sql.SQLException - if thrown by JDBC methods (and considered fatal)

Spring Framework