public class

AnnotationSessionFactoryBean

extends LocalSessionFactoryBean
implements ResourceLoaderAware

java.lang.Object
↳	org.springframework.orm.hibernate3.AbstractSessionFactoryBean
	↳	org.springframework.orm.hibernate3.LocalSessionFactoryBean
		↳	org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean

Class Overview

Subclass of Spring's standard LocalSessionFactoryBean for Hibernate, supporting JDK 1.5+ annotation metadata for mappings.

Note: This class requires Hibernate 3.2 or later, with the Java Persistence API and the Hibernate Annotations add-on present.

Example for an AnnotationSessionFactoryBean bean definition:

 <bean id="sessionFactory" class="org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean">
   <property name="dataSource" ref="dataSource"/>
   <property name="annotatedClasses">
     <list>
       <value>test.package.Foo</value>
       <value>test.package.Bar</value>
     </list>
   </property>
 </bean>

Or when using classpath scanning for autodetection of entity classes:

 <bean id="sessionFactory" class="org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean">
   <property name="dataSource" ref="dataSource"/>
   <property name="packagesToScan" value="test.package"/>
 </bean>

Summary

[Expand]

Inherited Fields

From class org.springframework.orm.hibernate3.AbstractSessionFactoryBean

Public Constructors
	AnnotationSessionFactoryBean()

Public Methods
void	setAnnotatedClasses(Class[] annotatedClasses) Specify annotated classes, for which mappings will be read from class-level JDK 1.5+ annotation metadata.
void	setAnnotatedPackages(String[] annotatedPackages) Specify the names of annotated packages, for which package-level JDK 1.5+ annotation metadata will be read.
void	setConfigurationClass(Class configurationClass) Specify the Hibernate Configuration class to use.
void	setEntityTypeFilters(TypeFilter[] entityTypeFilters) Specify custom type filters for Spring-based scanning for entity classes.
void	setPackagesToScan(String[] packagesToScan) Set whether to use Spring-based scanning for entity classes in the classpath instead of listing annotated classes explicitly.
void	setResourceLoader(ResourceLoader resourceLoader) Set the ResourceLoader that this object runs in.

Protected Methods
void	postProcessAnnotationConfiguration(AnnotationConfiguration config) To be implemented by subclasses which want to to perform custom post-processing of the AnnotationConfiguration object after this FactoryBean performed its default initialization.
void	postProcessConfiguration(Configuration config) This default implementation delegates to `postProcessAnnotationConfiguration(AnnotationConfiguration)`.
void	postProcessMappings(Configuration config) Reads metadata from annotated classes and packages into the AnnotationConfiguration instance.
void	scanPackages(AnnotationConfiguration config) Perform Spring-based scanning for entity classes.

[Expand]

Inherited Methods

From class org.springframework.orm.hibernate3.LocalSessionFactoryBean

void	afterSessionFactoryCreation() Executes schema update if requested.
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.
void	executeSchemaScript(Connection con, String[] sql) Execute the given schema script on the given JDBC Connection.
void	executeSchemaStatement(Statement stmt, String sql) Execute the given schema SQL on the given JDBC Statement.
static CacheProvider	getConfigTimeCacheProvider() Return the CacheProvider for the currently configured Hibernate SessionFactory, to be used by LocalCacheProviderProxy.
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.
final Configuration	getConfiguration() Return the Configuration object used to build the SessionFactory.
Properties	getHibernateProperties() Return the Hibernate properties, if any.
Configuration	newConfiguration() Subclasses can override this method to perform custom initialization of the Configuration instance used for SessionFactory creation.
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.
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	postProcessMappings(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(ClassLoader beanClassLoader) Callback that supplies the bean `class loader` to a bean instance.
void	setCacheProvider(CacheProvider cacheProvider) This method is deprecated. as of Spring 3.0, following Hibernate 3.3's deprecation of the CacheProvider SPI
void	setCacheRegionFactory(Object cacheRegionFactory) Set the Hibernate RegionFactory to use for the SessionFactory.
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	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<String, Object> 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	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.

From class org.springframework.orm.hibernate3.AbstractSessionFactoryBean

void	afterPropertiesSet() Build and expose the SessionFactory.
void	afterSessionFactoryCreation() Hook that allows post-processing after the SessionFactory has been successfully created.
void	beforeSessionFactoryDestruction() Hook that allows shutdown processing before the SessionFactory will be closed.
abstract SessionFactory	buildSessionFactory() Build the underlying Hibernate SessionFactory.
DataAccessException	convertHibernateAccessException(HibernateException ex) Convert the given HibernateException to an appropriate exception from the `org.springframework.dao` hierarchy.
void	destroy() Close the SessionFactory on bean factory shutdown.
DataSource	getDataSource() Return the DataSource to be used by the SessionFactory.
SessionFactory	getObject() Return the singleton SessionFactory.
Class<? extends SessionFactory>	getObjectType() Return the type of object that this FactoryBean creates, or `null` if not known in advance.
final SessionFactory	getSessionFactory() Return the exposed SessionFactory.
boolean	isExposeTransactionAwareSessionFactory() Return whether to expose a transaction-aware proxy for the SessionFactory.
boolean	isSingleton() Is the object managed by this factory a singleton? That is, will `getObject()` always return the same object (a reference that can be cached)? NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from `getObject()` might get cached by the owning BeanFactory.
boolean	isUseTransactionAwareDataSource() Return whether to use a transaction-aware DataSource for the SessionFactory.
void	setDataSource(DataSource dataSource) Set the DataSource to be used by the SessionFactory.
void	setExposeTransactionAwareSessionFactory(boolean exposeTransactionAwareSessionFactory) Set whether to expose a transaction-aware current Session from the SessionFactory's `getCurrentSession()` method, returning the Session that's associated with the current Spring-managed transaction, if any.
void	setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator) Set the JDBC exception translator for the SessionFactory, exposed via the PersistenceExceptionTranslator interface.
void	setUseTransactionAwareDataSource(boolean useTransactionAwareDataSource) Set whether to use a transaction-aware DataSource for the SessionFactory, i.e.
DataAccessException	translateExceptionIfPossible(RuntimeException ex) Implementation of the PersistenceExceptionTranslator interface, as autodetected by Spring's PersistenceExceptionTranslationPostProcessor.
SessionFactory	wrapSessionFactoryIfNecessary(SessionFactory rawSf) Wrap the given SessionFactory with a proxy, if demanded.

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.context.ResourceLoaderAware

From interface org.springframework.dao.support.PersistenceExceptionTranslator

Public Constructors

public AnnotationSessionFactoryBean ()

Public Methods

public void setAnnotatedClasses (Class[] annotatedClasses)

Specify annotated classes, for which mappings will be read from class-level JDK 1.5+ annotation metadata.

public void setAnnotatedPackages (String[] annotatedPackages)

Specify the names of annotated packages, for which package-level JDK 1.5+ annotation metadata will be read.

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.

public void setEntityTypeFilters (TypeFilter[] entityTypeFilters)

Specify custom type filters for Spring-based scanning for entity classes.

Default is to search all specified packages for classes annotated with @javax.persistence.Entity, @javax.persistence.Embeddable or @javax.persistence.MappedSuperclass, as well as for Hibernate's special @org.hibernate.annotations.Entity.

public void setPackagesToScan (String[] packagesToScan)

Set whether to use Spring-based scanning for entity classes in the classpath instead of listing annotated classes explicitly.

Default is none. Specify packages to search for autodetection of your entity classes in the classpath. This is analogous to Spring's component-scan feature (ClassPathBeanDefinitionScanner).

public void setResourceLoader (ResourceLoader resourceLoader)

Set the ResourceLoader that this object runs in.

This might be a ResourcePatternResolver, which can be checked through instanceof ResourcePatternResolver. See also the ResourcePatternUtils.getResourcePatternResolver method.

Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked before ApplicationContextAware's setApplicationContext.

Parameters

resourceLoader	ResourceLoader object to be used by this object

Protected Methods

protected void postProcessAnnotationConfiguration (AnnotationConfiguration config)

To be implemented by subclasses which want to to perform custom post-processing of the AnnotationConfiguration object after this FactoryBean performed its default initialization.

Note: As of Hibernate 3.6, AnnotationConfiguration's features have been rolled into Configuration itself. Simply overriding #postProcessConfiguration(org.hibernate.cfg.Configuration) becomes an option as well then.

Parameters

config	the current AnnotationConfiguration object

Throws

	in case of Hibernate initialization errors
HibernateException

protected void postProcessConfiguration (Configuration config)

This default implementation delegates to postProcessAnnotationConfiguration(AnnotationConfiguration).

Parameters

config	the current Configuration object

Throws

HibernateException

protected void postProcessMappings (Configuration config)

Reads metadata from annotated classes and packages into the AnnotationConfiguration instance.

Parameters

config	the current Configuration object

Throws

HibernateException

protected void scanPackages (AnnotationConfiguration config)

Perform Spring-based scanning for entity classes.

Classes

AnnotationSessionFactoryBean

Class Overview

See Also

Summary

Public Constructors

public AnnotationSessionFactoryBean ()

Public Methods

public void setAnnotatedClasses (Class[] annotatedClasses)

See Also

public void setAnnotatedPackages (String[] annotatedPackages)

See Also

public void setConfigurationClass (Class configurationClass)

public void setEntityTypeFilters (TypeFilter[] entityTypeFilters)

See Also

public void setPackagesToScan (String[] packagesToScan)

public void setResourceLoader (ResourceLoader resourceLoader)

Parameters

Protected Methods

protected void postProcessAnnotationConfiguration (AnnotationConfiguration config)

Parameters

Throws

protected void postProcessConfiguration (Configuration config)

Parameters

Throws

protected void postProcessMappings (Configuration config)

Parameters

Throws

protected void scanPackages (AnnotationConfiguration config)

See Also