public class

HibernateTemplate

extends HibernateAccessor
implements HibernateOperations

java.lang.Object
↳	org.springframework.orm.hibernate3.HibernateAccessor
	↳	org.springframework.orm.hibernate3.HibernateTemplate

Class Overview

Helper class that simplifies Hibernate data access code. Automatically converts HibernateExceptions into DataAccessExceptions, following the org.springframework.dao exception hierarchy.

The central method is execute, supporting Hibernate access code implementing the HibernateCallback interface. It provides Hibernate Session handling such that neither the HibernateCallback implementation nor the calling code needs to explicitly care about retrieving/closing Hibernate Sessions, or handling Session lifecycle exceptions. For typical single step actions, there are various convenience methods (find, load, saveOrUpdate, delete).

Can be used within a service implementation via direct instantiation with a SessionFactory reference, or get prepared in an application context and given to services as bean reference. Note: The SessionFactory should always be configured as bean in the application context, in the first case given to the service directly, in the second case to the prepared template.

NOTE: As of Hibernate 3.0.1, transactional Hibernate access code can also be coded in plain Hibernate style. Hence, for newly started projects, consider adopting the standard Hibernate3 style of coding data access objects instead, based on org.hibernate.SessionFactory#getCurrentSession().

This class can be considered as direct alternative to working with the raw Hibernate3 Session API (through SessionFactory.getCurrentSession()). The major advantage is its automatic conversion to DataAccessExceptions as well as its capability to fall back to 'auto-commit' style behavior when used outside of transactions. Note that HibernateTemplate will perform its own Session management, not participating in a custom Hibernate CurrentSessionContext unless you explicitly switch "allowCreate" to "false".

LocalSessionFactoryBean is the preferred way of obtaining a reference to a specific Hibernate SessionFactory, at least in a non-EJB environment. The Spring application context will manage its lifecycle, initializing and shutting down the factory as part of the application.

Note that operations that return an Iterator (i.e. iterate) are supposed to be used within Spring-driven or JTA-driven transactions (with HibernateTransactionManager, JtaTransactionManager, or EJB CMT). Else, the Iterator won't be able to read results from its ResultSet anymore, as the underlying Hibernate Session will already have been closed.

Lazy loading will also just work with an open Hibernate Session, either within a transaction or within OpenSessionInViewFilter/Interceptor. Furthermore, some operations just make sense within transactions, for example: contains, evict, lock, flush, clear.

Summary

[Expand]

Inherited Constants

From class org.springframework.orm.hibernate3.HibernateAccessor

[Expand]

Inherited Fields

From class org.springframework.orm.hibernate3.HibernateAccessor

Public Constructors
	HibernateTemplate() Create a new HibernateTemplate instance.
	HibernateTemplate(SessionFactory sessionFactory) Create a new HibernateTemplate instance.
	HibernateTemplate(SessionFactory sessionFactory, boolean allowCreate) Create a new HibernateTemplate instance.

Public Methods
int	bulkUpdate(String queryString) Update/delete all objects according to the given query.
int	bulkUpdate(String queryString, Object value) Update/delete all objects according to the given query, binding one value to a "?" parameter in the query string.
int	bulkUpdate(String queryString, Object... values) Update/delete all objects according to the given query, binding a number of values to "?" parameters in the query string.
void	clear() Remove all objects from the org.hibernate.Session cache, and cancel all pending saves, updates and deletes.
void	closeIterator(Iterator it) Immediately close an Iterator created by any of the various `iterate(..)` operations, instead of waiting until the session is closed or disconnected.
boolean	contains(Object entity) Check whether the given object is in the Session cache.
void	delete(String entityName, Object entity) Delete the given persistent instance.
void	delete(Object entity) Delete the given persistent instance.
void	delete(Object entity, LockMode lockMode) Delete the given persistent instance.
void	delete(String entityName, Object entity, LockMode lockMode) Delete the given persistent instance.
void	deleteAll(Collection entities) Delete all given persistent instances.
Filter	enableFilter(String filterName) Return an enabled Hibernate Filter for the given filter name.
void	evict(Object entity) Remove the given object from the org.hibernate.Session cache.
<T> T	execute(HibernateCallback<T> action) Execute the action specified by the given action object within a org.hibernate.Session.
List	executeFind(HibernateCallback<?> action) Execute the specified action assuming that the result object is a `List`.
<T> T	executeWithNativeSession(HibernateCallback<T> action) Execute the action specified by the given action object within a native org.hibernate.Session.
<T> T	executeWithNewSession(HibernateCallback<T> action) Execute the action specified by the given action object within a new org.hibernate.Session.
List	find(String queryString, Object... values) Execute an HQL query, binding a number of values to "?" parameters in the query string.
List	find(String queryString) Execute an HQL query.
List	find(String queryString, Object value) Execute an HQL query, binding one value to a "?" parameter in the query string.
List	findByCriteria(DetachedCriteria criteria, int firstResult, int maxResults) Execute a query based on the given Hibernate criteria object.
List	findByCriteria(DetachedCriteria criteria) Execute a query based on a given Hibernate criteria object.
List	findByExample(Object exampleEntity) Execute a query based on the given example entity object.
List	findByExample(Object exampleEntity, int firstResult, int maxResults) Execute a query based on a given example entity object.
List	findByExample(String entityName, Object exampleEntity, int firstResult, int maxResults) Execute a query based on a given example entity object.
List	findByExample(String entityName, Object exampleEntity) Execute a query based on the given example entity object.
List	findByNamedParam(String queryString, String paramName, Object value) Execute an HQL query, binding one value to a ":" named parameter in the query string.
List	findByNamedParam(String queryString, String[] paramNames, Object[] values) Execute an HQL query, binding a number of values to ":" named parameters in the query string.
List	findByNamedQuery(String queryName, Object... values) Execute a named query binding a number of values to "?" parameters in the query string.
List	findByNamedQuery(String queryName) Execute a named query.
List	findByNamedQuery(String queryName, Object value) Execute a named query, binding one value to a "?" parameter in the query string.
List	findByNamedQueryAndNamedParam(String queryName, String paramName, Object value) Execute a named query, binding one value to a ":" named parameter in the query string.
List	findByNamedQueryAndNamedParam(String queryName, String[] paramNames, Object[] values) Execute a named query, binding a number of values to ":" named parameters in the query string.
List	findByNamedQueryAndValueBean(String queryName, Object valueBean) Execute a named query, binding the properties of the given bean to ":" named parameters in the query string.
List	findByValueBean(String queryString, Object valueBean) Execute an HQL query, binding the properties of the given bean to named parameters in the query string.
void	flush() Flush all pending saves, updates and deletes to the database.
<T> T	get(Class<T> entityClass, Serializable id, LockMode lockMode) Return the persistent instance of the given entity class with the given identifier, or `null` if not found.
Object	get(String entityName, Serializable id, LockMode lockMode) Return the persistent instance of the given entity class with the given identifier, or `null` if not found.
Object	get(String entityName, Serializable id) Return the persistent instance of the given entity class with the given identifier, or `null` if not found.
<T> T	get(Class<T> entityClass, Serializable id) Return the persistent instance of the given entity class with the given identifier, or `null` if not found.
int	getFetchSize() Return the fetch size specified for this HibernateTemplate.
int	getMaxResults() Return the maximum number of rows specified for this HibernateTemplate.
String	getQueryCacheRegion() Return the name of the cache region for queries executed by this template.
void	initialize(Object proxy) Force initialization of a Hibernate proxy or persistent collection.
boolean	isAllowCreate() Return if a new Session should be created if no thread-bound found.
boolean	isAlwaysUseNewSession() Return whether to always use a new Hibernate Session for this template.
boolean	isCacheQueries() Return whether to cache all queries executed by this template.
boolean	isCheckWriteOperations() Return whether to check that the Hibernate Session is not in read-only mode in case of write operations (save/update/delete).
boolean	isExposeNativeSession() Return whether to expose the native Hibernate Session to HibernateCallback code, or rather a Session proxy.
Iterator	iterate(String queryString, Object value) Execute a query for persistent instances, binding one value to a "?" parameter in the query string.
Iterator	iterate(String queryString) Execute a query for persistent instances.
Iterator	iterate(String queryString, Object... values) Execute a query for persistent instances, binding a number of values to "?" parameters in the query string.
void	load(Object entity, Serializable id) Load the persistent instance with the given identifier into the given object, throwing an exception if not found.
Object	load(String entityName, Serializable id, LockMode lockMode) Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.
<T> T	load(Class<T> entityClass, Serializable id, LockMode lockMode) Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.
Object	load(String entityName, Serializable id) Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.
<T> T	load(Class<T> entityClass, Serializable id) Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.
<T> List<T>	loadAll(Class<T> entityClass) Return all persistent instances of the given entity class.
void	lock(String entityName, Object entity, LockMode lockMode) Obtain the specified lock level upon the given object, implicitly checking whether the corresponding database entry still exists.
void	lock(Object entity, LockMode lockMode) Obtain the specified lock level upon the given object, implicitly checking whether the corresponding database entry still exists.
<T> T	merge(String entityName, T entity) Copy the state of the given object onto the persistent object with the same identifier.
<T> T	merge(T entity) Copy the state of the given object onto the persistent object with the same identifier.
void	persist(Object entity) Persist the given transient instance.
void	persist(String entityName, Object entity) Persist the given transient instance.
void	refresh(Object entity, LockMode lockMode) Re-read the state of the given persistent instance.
void	refresh(Object entity) Re-read the state of the given persistent instance.
void	replicate(Object entity, ReplicationMode replicationMode) Persist the state of the given detached instance according to the given replication mode, reusing the current identifier value.
void	replicate(String entityName, Object entity, ReplicationMode replicationMode) Persist the state of the given detached instance according to the given replication mode, reusing the current identifier value.
Serializable	save(String entityName, Object entity) Persist the given transient instance.
Serializable	save(Object entity) Persist the given transient instance.
void	saveOrUpdate(Object entity) Save or update the given persistent instance, according to its id (matching the configured "unsaved-value"?).
void	saveOrUpdate(String entityName, Object entity) Save or update the given persistent instance, according to its id (matching the configured "unsaved-value"?).
void	saveOrUpdateAll(Collection entities) Save or update all given persistent instances, according to its id (matching the configured "unsaved-value"?).
void	setAllowCreate(boolean allowCreate) Set if a new Session should be created when no transactional `Session` can be found for the current thread.
void	setAlwaysUseNewSession(boolean alwaysUseNewSession) Set whether to always use a new Hibernate Session for this template.
void	setCacheQueries(boolean cacheQueries) Set whether to cache all queries executed by this template.
void	setCheckWriteOperations(boolean checkWriteOperations) Set whether to check that the Hibernate Session is not in read-only mode in case of write operations (save/update/delete).
void	setExposeNativeSession(boolean exposeNativeSession) Set whether to expose the native Hibernate Session to HibernateCallback code.
void	setFetchSize(int fetchSize) Set the fetch size for this HibernateTemplate.
void	setMaxResults(int maxResults) Set the maximum number of rows for this HibernateTemplate.
void	setQueryCacheRegion(String queryCacheRegion) Set the name of the cache region for queries executed by this template.
void	update(Object entity, LockMode lockMode) Update the given persistent instance, associating it with the current Hibernate org.hibernate.Session.
void	update(Object entity) Update the given persistent instance, associating it with the current Hibernate org.hibernate.Session.
void	update(String entityName, Object entity, LockMode lockMode) Update the given persistent instance, associating it with the current Hibernate org.hibernate.Session.
void	update(String entityName, Object entity) Update the given persistent instance, associating it with the current Hibernate org.hibernate.Session.

Protected Methods
void	applyNamedParameterToQuery(Query queryObject, String paramName, Object value) Apply the given name parameter to the given Query object.
void	checkWriteOperationAllowed(Session session) Check whether write operations are allowed on the given Session.
Session	createSessionProxy(Session session) Create a close-suppressing proxy for the given Hibernate Session.
<T> T	doExecute(HibernateCallback<T> action, boolean enforceNewSession, boolean enforceNativeSession) Execute the action specified by the given action object within a Session.
Session	getSession() Return a Session for use by this template.
void	prepareCriteria(Criteria criteria) Prepare the given Criteria object, applying cache settings and/or a transaction timeout.
void	prepareQuery(Query queryObject) Prepare the given Query object, applying cache settings and/or a transaction timeout.

[Expand]

Inherited Methods

From class org.springframework.orm.hibernate3.HibernateAccessor

void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
FlushMode	applyFlushMode(Session session, boolean existingTransaction) Apply the flush mode that's been specified for this accessor to the given Session.
DataAccessException	convertHibernateAccessException(HibernateException ex) Convert the given HibernateException to an appropriate exception from the `org.springframework.dao` hierarchy.
DataAccessException	convertJdbcAccessException(SQLException ex) Convert the given SQLException to an appropriate exception from the `org.springframework.dao` hierarchy.
DataAccessException	convertJdbcAccessException(JDBCException ex, SQLExceptionTranslator translator) Convert the given Hibernate JDBCException to an appropriate exception from the `org.springframework.dao` hierarchy, using the given SQLExceptionTranslator.
void	disableFilters(Session session) Disable the specified filters on the given Session.
void	enableFilters(Session session) Enable the specified filters on the given Session.
void	flushIfNecessary(Session session, boolean existingTransaction) Flush the given Hibernate Session if necessary.
synchronized SQLExceptionTranslator	getDefaultJdbcExceptionTranslator() Obtain a default SQLExceptionTranslator, lazily creating it if necessary.
Interceptor	getEntityInterceptor() Return the current Hibernate entity interceptor, or `null` if none.
String[]	getFilterNames() Return the names of Hibernate filters to be activated, if any.
int	getFlushMode() Return if a flush should be forced after executing the callback code.
SQLExceptionTranslator	getJdbcExceptionTranslator() Return the JDBC exception translator for this instance, if any.
SessionFactory	getSessionFactory() Return the Hibernate SessionFactory that should be used to create Hibernate Sessions.
void	setBeanFactory(BeanFactory beanFactory) The bean factory just needs to be known for resolving entity interceptor bean names.
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	setEntityInterceptorBeanName(String entityInterceptorBeanName) Set the bean name of a Hibernate entity interceptor that allows to inspect and change property values before writing to and reading from the database.
void	setFilterName(String filter) Set the name of a Hibernate filter to be activated for all Sessions that this accessor works with.
void	setFilterNames(String[] filterNames) Set one or more names of Hibernate filters to be activated for all Sessions that this accessor works with.
void	setFlushMode(int flushMode) Set the flush behavior to one of the constants in this class.
void	setFlushModeName(String constantName) Set the flush behavior by the name of the respective constant in this class, e.g.
void	setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator) Set the JDBC exception translator for this instance.
void	setSessionFactory(SessionFactory sessionFactory) Set the Hibernate SessionFactory that should be used to create Hibernate Sessions.

From class java.lang.Object

From interface org.springframework.beans.factory.BeanFactoryAware

From interface org.springframework.beans.factory.InitializingBean

From interface org.springframework.orm.hibernate3.HibernateOperations

abstract int	bulkUpdate(String queryString) Update/delete all objects according to the given query.
abstract int	bulkUpdate(String queryString, Object value) Update/delete all objects according to the given query, binding one value to a "?" parameter in the query string.
abstract int	bulkUpdate(String queryString, Object... values) Update/delete all objects according to the given query, binding a number of values to "?" parameters in the query string.
abstract void	clear() Remove all objects from the org.hibernate.Session cache, and cancel all pending saves, updates and deletes.
abstract void	closeIterator(Iterator it) Immediately close an Iterator created by any of the various `iterate(..)` operations, instead of waiting until the session is closed or disconnected.
abstract boolean	contains(Object entity) Check whether the given object is in the Session cache.
abstract void	delete(String entityName, Object entity) Delete the given persistent instance.
abstract void	delete(Object entity) Delete the given persistent instance.
abstract void	delete(Object entity, LockMode lockMode) Delete the given persistent instance.
abstract void	delete(String entityName, Object entity, LockMode lockMode) Delete the given persistent instance.
abstract void	deleteAll(Collection entities) Delete all given persistent instances.
abstract Filter	enableFilter(String filterName) Return an enabled Hibernate Filter for the given filter name.
abstract void	evict(Object entity) Remove the given object from the org.hibernate.Session cache.
abstract <T> T	execute(HibernateCallback<T> action) Execute the action specified by the given action object within a org.hibernate.Session.
abstract List	executeFind(HibernateCallback<?> action) Execute the specified action assuming that the result object is a `List`.
abstract List	find(String queryString, Object... values) Execute an HQL query, binding a number of values to "?" parameters in the query string.
abstract List	find(String queryString) Execute an HQL query.
abstract List	find(String queryString, Object value) Execute an HQL query, binding one value to a "?" parameter in the query string.
abstract List	findByCriteria(DetachedCriteria criteria, int firstResult, int maxResults) Execute a query based on the given Hibernate criteria object.
abstract List	findByCriteria(DetachedCriteria criteria) Execute a query based on a given Hibernate criteria object.
abstract List	findByExample(Object exampleEntity) Execute a query based on the given example entity object.
abstract List	findByExample(Object exampleEntity, int firstResult, int maxResults) Execute a query based on a given example entity object.
abstract List	findByExample(String entityName, Object exampleEntity, int firstResult, int maxResults) Execute a query based on a given example entity object.
abstract List	findByExample(String entityName, Object exampleEntity) Execute a query based on the given example entity object.
abstract List	findByNamedParam(String queryString, String paramName, Object value) Execute an HQL query, binding one value to a ":" named parameter in the query string.
abstract List	findByNamedParam(String queryString, String[] paramNames, Object[] values) Execute an HQL query, binding a number of values to ":" named parameters in the query string.
abstract List	findByNamedQuery(String queryName, Object... values) Execute a named query binding a number of values to "?" parameters in the query string.
abstract List	findByNamedQuery(String queryName) Execute a named query.
abstract List	findByNamedQuery(String queryName, Object value) Execute a named query, binding one value to a "?" parameter in the query string.
abstract List	findByNamedQueryAndNamedParam(String queryName, String paramName, Object value) Execute a named query, binding one value to a ":" named parameter in the query string.
abstract List	findByNamedQueryAndNamedParam(String queryName, String[] paramNames, Object[] values) Execute a named query, binding a number of values to ":" named parameters in the query string.
abstract List	findByNamedQueryAndValueBean(String queryName, Object valueBean) Execute a named query, binding the properties of the given bean to ":" named parameters in the query string.
abstract List	findByValueBean(String queryString, Object valueBean) Execute an HQL query, binding the properties of the given bean to named parameters in the query string.
abstract void	flush() Flush all pending saves, updates and deletes to the database.
abstract <T> T	get(Class<T> entityClass, Serializable id, LockMode lockMode) Return the persistent instance of the given entity class with the given identifier, or `null` if not found.
abstract Object	get(String entityName, Serializable id, LockMode lockMode) Return the persistent instance of the given entity class with the given identifier, or `null` if not found.
abstract Object	get(String entityName, Serializable id) Return the persistent instance of the given entity class with the given identifier, or `null` if not found.
abstract <T> T	get(Class<T> entityClass, Serializable id) Return the persistent instance of the given entity class with the given identifier, or `null` if not found.
abstract void	initialize(Object proxy) Force initialization of a Hibernate proxy or persistent collection.
abstract Iterator	iterate(String queryString, Object value) Execute a query for persistent instances, binding one value to a "?" parameter in the query string.
abstract Iterator	iterate(String queryString) Execute a query for persistent instances.
abstract Iterator	iterate(String queryString, Object... values) Execute a query for persistent instances, binding a number of values to "?" parameters in the query string.
abstract void	load(Object entity, Serializable id) Load the persistent instance with the given identifier into the given object, throwing an exception if not found.
abstract Object	load(String entityName, Serializable id, LockMode lockMode) Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.
abstract <T> T	load(Class<T> entityClass, Serializable id, LockMode lockMode) Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.
abstract Object	load(String entityName, Serializable id) Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.
abstract <T> T	load(Class<T> entityClass, Serializable id) Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.
abstract <T> List<T>	loadAll(Class<T> entityClass) Return all persistent instances of the given entity class.
abstract void	lock(String entityName, Object entity, LockMode lockMode) Obtain the specified lock level upon the given object, implicitly checking whether the corresponding database entry still exists.
abstract void	lock(Object entity, LockMode lockMode) Obtain the specified lock level upon the given object, implicitly checking whether the corresponding database entry still exists.
abstract <T> T	merge(String entityName, T entity) Copy the state of the given object onto the persistent object with the same identifier.
abstract <T> T	merge(T entity) Copy the state of the given object onto the persistent object with the same identifier.
abstract void	persist(Object entity) Persist the given transient instance.
abstract void	persist(String entityName, Object entity) Persist the given transient instance.
abstract void	refresh(Object entity, LockMode lockMode) Re-read the state of the given persistent instance.
abstract void	refresh(Object entity) Re-read the state of the given persistent instance.
abstract void	replicate(Object entity, ReplicationMode replicationMode) Persist the state of the given detached instance according to the given replication mode, reusing the current identifier value.
abstract void	replicate(String entityName, Object entity, ReplicationMode replicationMode) Persist the state of the given detached instance according to the given replication mode, reusing the current identifier value.
abstract Serializable	save(String entityName, Object entity) Persist the given transient instance.
abstract Serializable	save(Object entity) Persist the given transient instance.
abstract void	saveOrUpdate(Object entity) Save or update the given persistent instance, according to its id (matching the configured "unsaved-value"?).
abstract void	saveOrUpdate(String entityName, Object entity) Save or update the given persistent instance, according to its id (matching the configured "unsaved-value"?).
abstract void	saveOrUpdateAll(Collection entities) This method is deprecated. as of Spring 2.5, in favor of individual `saveOrUpdate` or `merge` usage
abstract void	update(Object entity, LockMode lockMode) Update the given persistent instance, associating it with the current Hibernate org.hibernate.Session.
abstract void	update(Object entity) Update the given persistent instance, associating it with the current Hibernate org.hibernate.Session.
abstract void	update(String entityName, Object entity, LockMode lockMode) Update the given persistent instance, associating it with the current Hibernate org.hibernate.Session.
abstract void	update(String entityName, Object entity) Update the given persistent instance, associating it with the current Hibernate org.hibernate.Session.

Public Constructors

public HibernateTemplate ()

Create a new HibernateTemplate instance.

public HibernateTemplate (SessionFactory sessionFactory)

Create a new HibernateTemplate instance.

Parameters

sessionFactory	SessionFactory to create Sessions

public HibernateTemplate (SessionFactory sessionFactory, boolean allowCreate)

Create a new HibernateTemplate instance.

Parameters

sessionFactory	SessionFactory to create Sessions
allowCreate	if a non-transactional Session should be created when no transactional Session can be found for the current thread

Public Methods

public int bulkUpdate (String queryString)

Update/delete all objects according to the given query.

Parameters

queryString	an update/delete query expressed in Hibernate's query language

Returns

the number of instances updated/deleted

Throws

DataAccessException

public int bulkUpdate (String queryString, Object value)

Update/delete all objects according to the given query, binding one value to a "?" parameter in the query string.

Parameters

queryString	an update/delete query expressed in Hibernate's query language
value	the value of the parameter

Returns

the number of instances updated/deleted

Throws

DataAccessException

public int bulkUpdate (String queryString, Object... values)

Update/delete all objects according to the given query, binding a number of values to "?" parameters in the query string.

Parameters

queryString	an update/delete query expressed in Hibernate's query language
values	the values of the parameters

Returns

the number of instances updated/deleted

Throws

DataAccessException

public void clear ()

Remove all objects from the org.hibernate.Session cache, and cancel all pending saves, updates and deletes.

Throws

DataAccessException

public void closeIterator (Iterator it)

Immediately close an Iterator created by any of the various iterate(..) operations, instead of waiting until the session is closed or disconnected.

Parameters

it	the `Iterator` to close

Throws

DataAccessException

public boolean contains (Object entity)

Check whether the given object is in the Session cache.

Parameters

entity	the persistence instance to check

Returns

whether the given object is in the Session cache

Throws

DataAccessException

public void delete (String entityName, Object entity)

Delete the given persistent instance.

Parameters

entityName	the name of the persistent entity
entity	the persistent instance to delete

Throws

DataAccessException

public void delete (Object entity)

Delete the given persistent instance.

Parameters

entity	the persistent instance to delete

Throws

DataAccessException

public void delete (Object entity, LockMode lockMode)

Delete the given persistent instance.

Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.

Parameters

entity	the persistent instance to delete
lockMode	the lock mode to obtain

Throws

DataAccessException

public void delete (String entityName, Object entity, LockMode lockMode)

Delete the given persistent instance.

Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.

Parameters

entityName	the name of the persistent entity
entity	the persistent instance to delete
lockMode	the lock mode to obtain

Throws

DataAccessException

public void deleteAll (Collection entities)

Delete all given persistent instances.

This can be combined with any of the find methods to delete by query in two lines of code.

Parameters

entities	the persistent instances to delete

Throws

DataAccessException

public Filter enableFilter (String filterName)

Return an enabled Hibernate Filter for the given filter name. The returned Filter instance can be used to set filter parameters.

Parameters

filterName	the name of the filter

Returns

the enabled Hibernate Filter (either already enabled or enabled on the fly by this operation)

Throws

IllegalStateException

public void evict (Object entity)

Remove the given object from the org.hibernate.Session cache.

Parameters

entity	the persistent instance to evict

Throws

DataAccessException

public T execute (HibernateCallback<T> action)

Execute the action specified by the given action object within a org.hibernate.Session.

Application exceptions thrown by the action object get propagated to the caller (can only be unchecked). Hibernate exceptions are transformed into appropriate DAO ones. Allows for returning a result object, that is a domain object or a collection of domain objects.

Note: Callback code is not supposed to handle transactions itself! Use an appropriate transaction manager like HibernateTransactionManager. Generally, callback code must not touch any Session lifecycle methods, like close, disconnect, or reconnect, to let the template do its work.

Parameters

action	callback object that specifies the Hibernate action

Returns

a result object returned by the action, or null

Throws

DataAccessException

public List executeFind (HibernateCallback<?> action)

Execute the specified action assuming that the result object is a List.

This is a convenience method for executing Hibernate find calls or queries within an action.

Parameters

action	calback object that specifies the Hibernate action

Returns

a List result returned by the action, or null

Throws

DataAccessException

public T executeWithNativeSession (HibernateCallback<T> action)

Execute the action specified by the given action object within a native org.hibernate.Session.

This execute variant overrides the template-wide "exposeNativeSession" setting.

Parameters

action	callback object that specifies the Hibernate action

Returns

a result object returned by the action, or null

Throws

DataAccessException	in case of Hibernate errors

public T executeWithNewSession (HibernateCallback<T> action)

Execute the action specified by the given action object within a new org.hibernate.Session.

This execute variant overrides the template-wide "alwaysUseNewSession" setting.

Parameters

action	callback object that specifies the Hibernate action

Returns

a result object returned by the action, or null

Throws

DataAccessException	in case of Hibernate errors

public List find (String queryString, Object... values)

Execute an HQL query, binding a number of values to "?" parameters in the query string.

Parameters

queryString	a query expressed in Hibernate's query language
values	the values of the parameters

Returns

a List containing the results of the query execution

Throws

DataAccessException

public List find (String queryString)

Execute an HQL query.

Parameters

queryString	a query expressed in Hibernate's query language

Returns

a List containing the results of the query execution

Throws

DataAccessException

public List find (String queryString, Object value)

Execute an HQL query, binding one value to a "?" parameter in the query string.

Parameters

queryString	a query expressed in Hibernate's query language
value	the value of the parameter

Returns

a List containing the results of the query execution

Throws

DataAccessException

public List findByCriteria (DetachedCriteria criteria, int firstResult, int maxResults)

Execute a query based on the given Hibernate criteria object.

Parameters

criteria	the detached Hibernate criteria object. Note: Do not reuse criteria objects! They need to recreated per execution, due to the suboptimal design of Hibernate's criteria facility.
firstResult	the index of the first result object to be retrieved (numbered from 0)
maxResults	the maximum number of result objects to retrieve (or <=0 for no limit)

Returns

a List containing 0 or more persistent instances

Throws

DataAccessException

public List findByCriteria (DetachedCriteria criteria)

Execute a query based on a given Hibernate criteria object.

Parameters

criteria	the detached Hibernate criteria object. Note: Do not reuse criteria objects! They need to recreated per execution, due to the suboptimal design of Hibernate's criteria facility.

Returns

a List containing 0 or more persistent instances

Throws

DataAccessException

public List findByExample (Object exampleEntity)

Execute a query based on the given example entity object.

Parameters

exampleEntity	an instance of the desired entity, serving as example for "query-by-example"

Returns

a List containing 0 or more persistent instances

Throws

DataAccessException

public List findByExample (Object exampleEntity, int firstResult, int maxResults)

Execute a query based on a given example entity object.

Parameters

exampleEntity	an instance of the desired entity, serving as example for "query-by-example"
firstResult	the index of the first result object to be retrieved (numbered from 0)
maxResults	the maximum number of result objects to retrieve (or <=0 for no limit)

Returns

a List containing 0 or more persistent instances

Throws

DataAccessException

public List findByExample (String entityName, Object exampleEntity, int firstResult, int maxResults)

Execute a query based on a given example entity object.

Parameters

entityName	the name of the persistent entity
exampleEntity	an instance of the desired entity, serving as example for "query-by-example"
firstResult	the index of the first result object to be retrieved (numbered from 0)
maxResults	the maximum number of result objects to retrieve (or <=0 for no limit)

Returns

a List containing 0 or more persistent instances

Throws

DataAccessException

public List findByExample (String entityName, Object exampleEntity)

Execute a query based on the given example entity object.

Parameters

entityName	the name of the persistent entity
exampleEntity	an instance of the desired entity, serving as example for "query-by-example"

Returns

a List containing 0 or more persistent instances

Throws

DataAccessException

public List findByNamedParam (String queryString, String paramName, Object value)

Execute an HQL query, binding one value to a ":" named parameter in the query string.

Parameters

queryString	a query expressed in Hibernate's query language
paramName	the name of the parameter
value	the value of the parameter

Returns

a List containing the results of the query execution

Throws

DataAccessException

public List findByNamedParam (String queryString, String[] paramNames, Object[] values)

Execute an HQL query, binding a number of values to ":" named parameters in the query string.

Parameters

queryString	a query expressed in Hibernate's query language
paramNames	the names of the parameters
values	the values of the parameters

Returns

a List containing the results of the query execution

Throws

DataAccessException

public List findByNamedQuery (String queryName, Object... values)

Execute a named query binding a number of values to "?" parameters in the query string.

A named query is defined in a Hibernate mapping file.

Parameters

queryName	the name of a Hibernate query in a mapping file
values	the values of the parameters

Returns

a List containing the results of the query execution

Throws

DataAccessException

public List findByNamedQuery (String queryName)

Execute a named query.

A named query is defined in a Hibernate mapping file.

Parameters

queryName	the name of a Hibernate query in a mapping file

Returns

a List containing the results of the query execution

Throws

DataAccessException

public List findByNamedQuery (String queryName, Object value)

Execute a named query, binding one value to a "?" parameter in the query string.

A named query is defined in a Hibernate mapping file.

Parameters

queryName	the name of a Hibernate query in a mapping file
value	the value of the parameter

Returns

a List containing the results of the query execution

Throws

DataAccessException

public List findByNamedQueryAndNamedParam (String queryName, String paramName, Object value)

Execute a named query, binding one value to a ":" named parameter in the query string.

A named query is defined in a Hibernate mapping file.

Parameters

queryName	the name of a Hibernate query in a mapping file
paramName	the name of parameter
value	the value of the parameter

Returns

a List containing the results of the query execution

Throws

DataAccessException

public List findByNamedQueryAndNamedParam (String queryName, String[] paramNames, Object[] values)

Execute a named query, binding a number of values to ":" named parameters in the query string.

A named query is defined in a Hibernate mapping file.

Parameters

queryName	the name of a Hibernate query in a mapping file
paramNames	the names of the parameters
values	the values of the parameters

Returns

a List containing the results of the query execution

Throws

DataAccessException

public List findByNamedQueryAndValueBean (String queryName, Object valueBean)

Execute a named query, binding the properties of the given bean to ":" named parameters in the query string.

A named query is defined in a Hibernate mapping file.

Parameters

queryName	the name of a Hibernate query in a mapping file
valueBean	the values of the parameters

Returns

a List containing the results of the query execution

Throws

DataAccessException

public List findByValueBean (String queryString, Object valueBean)

Execute an HQL query, binding the properties of the given bean to named parameters in the query string.

Parameters

queryString	a query expressed in Hibernate's query language
valueBean	the values of the parameters

Returns

a List containing the results of the query execution

Throws

DataAccessException

public void flush ()

Flush all pending saves, updates and deletes to the database.

Only invoke this for selective eager flushing, for example when JDBC code needs to see certain changes within the same transaction. Else, it is preferable to rely on auto-flushing at transaction completion.

Throws

DataAccessException

public T get (Class<T> entityClass, Serializable id, LockMode lockMode)

Return the persistent instance of the given entity class with the given identifier, or null if not found.

Obtains the specified lock mode if the instance exists.

This method is a thin wrapper around org.hibernate.Session#get(Class, java.io.Serializable, LockMode) for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.

Parameters

entityClass	a persistent class
id	the identifier of the persistent instance
lockMode	the lock mode to obtain

Returns

the persistent instance, or null if not found

Throws

DataAccessException

public Object get (String entityName, Serializable id, LockMode lockMode)

Return the persistent instance of the given entity class with the given identifier, or null if not found. Obtains the specified lock mode if the instance exists.

This method is a thin wrapper around org.hibernate.Session#get(String, java.io.Serializable, LockMode) for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.

Parameters

entityName	the name of the persistent entity
id	the identifier of the persistent instance
lockMode	the lock mode to obtain

Returns

the persistent instance, or null if not found

Throws

DataAccessException

public Object get (String entityName, Serializable id)

Return the persistent instance of the given entity class with the given identifier, or null if not found.

This method is a thin wrapper around org.hibernate.Session#get(String, java.io.Serializable) for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.

Parameters

entityName	the name of the persistent entity
id	the identifier of the persistent instance

Returns

the persistent instance, or null if not found

Throws

DataAccessException

public T get (Class<T> entityClass, Serializable id)

Return the persistent instance of the given entity class with the given identifier, or null if not found.

This method is a thin wrapper around org.hibernate.Session#get(Class, java.io.Serializable) for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.

Parameters

entityClass	a persistent class
id	the identifier of the persistent instance

Returns

the persistent instance, or null if not found

Throws

DataAccessException

public int getFetchSize ()

Return the fetch size specified for this HibernateTemplate.

public int getMaxResults ()

Return the maximum number of rows specified for this HibernateTemplate.

public String getQueryCacheRegion ()

Return the name of the cache region for queries executed by this template.

public void initialize (Object proxy)

Force initialization of a Hibernate proxy or persistent collection.

Parameters

proxy	a proxy for a persistent object or a persistent collection

Throws

DataAccessException

public boolean isAllowCreate ()

Return if a new Session should be created if no thread-bound found.

public boolean isAlwaysUseNewSession ()

Return whether to always use a new Hibernate Session for this template.

public boolean isCacheQueries ()

Return whether to cache all queries executed by this template.

public boolean isCheckWriteOperations ()

Return whether to check that the Hibernate Session is not in read-only mode in case of write operations (save/update/delete).

public boolean isExposeNativeSession ()

Return whether to expose the native Hibernate Session to HibernateCallback code, or rather a Session proxy.

public Iterator iterate (String queryString, Object value)

Execute a query for persistent instances, binding one value to a "?" parameter in the query string.

Returns the results as an Iterator. Entities returned are initialized on demand. See the Hibernate API documentation for details.

Parameters

queryString	a query expressed in Hibernate's query language
value	the value of the parameter

Returns

an Iterator containing 0 or more persistent instances

Throws

DataAccessException

public Iterator iterate (String queryString)

Execute a query for persistent instances.

Returns the results as an Iterator. Entities returned are initialized on demand. See the Hibernate API documentation for details.

Parameters

queryString	a query expressed in Hibernate's query language

Returns

an Iterator containing 0 or more persistent instances

Throws

DataAccessException

public Iterator iterate (String queryString, Object... values)

Execute a query for persistent instances, binding a number of values to "?" parameters in the query string.

Returns the results as an Iterator. Entities returned are initialized on demand. See the Hibernate API documentation for details.

Parameters

queryString	a query expressed in Hibernate's query language
values	the values of the parameters

Returns

an Iterator containing 0 or more persistent instances

Throws

DataAccessException

public void load (Object entity, Serializable id)

Load the persistent instance with the given identifier into the given object, throwing an exception if not found.

This method is a thin wrapper around org.hibernate.Session#load(Object, java.io.Serializable) for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.

Parameters

entity	the object (of the target class) to load into
id	the identifier of the persistent instance

Throws

DataAccessException

public Object load (String entityName, Serializable id, LockMode lockMode)

Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.

Obtains the specified lock mode if the instance exists.

This method is a thin wrapper around org.hibernate.Session#load(String, java.io.Serializable, LockMode) for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.

Parameters

entityName	the name of the persistent entity
id	the identifier of the persistent instance
lockMode	the lock mode to obtain

Returns

the persistent instance

Throws

DataAccessException

public T load (Class<T> entityClass, Serializable id, LockMode lockMode)

Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found. Obtains the specified lock mode if the instance exists.

This method is a thin wrapper around org.hibernate.Session#load(Class, java.io.Serializable, LockMode) for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.

Parameters

entityClass	a persistent class
id	the identifier of the persistent instance
lockMode	the lock mode to obtain

Returns

the persistent instance

Throws

DataAccessException

public Object load (String entityName, Serializable id)

Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.

This method is a thin wrapper around org.hibernate.Session#load(String, java.io.Serializable) for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.

Parameters

entityName	the name of the persistent entity
id	the identifier of the persistent instance

Returns

the persistent instance

Throws

DataAccessException

public T load (Class<T> entityClass, Serializable id)

Return the persistent instance of the given entity class with the given identifier, throwing an exception if not found.

This method is a thin wrapper around org.hibernate.Session#load(Class, java.io.Serializable) for convenience. For an explanation of the exact semantics of this method, please do refer to the Hibernate API documentation in the first instance.

Parameters

entityClass	a persistent class
id	the identifier of the persistent instance

Returns

the persistent instance

Throws

DataAccessException

public List<T> loadAll (Class<T> entityClass)

Return all persistent instances of the given entity class. Note: Use queries or criteria for retrieving a specific subset.

Parameters

entityClass	a persistent class

Returns

a List containing 0 or more persistent instances

Throws

DataAccessException

public void lock (String entityName, Object entity, LockMode lockMode)

Obtain the specified lock level upon the given object, implicitly checking whether the corresponding database entry still exists.

Parameters

entityName	the name of the persistent entity
entity	the persistent instance to lock
lockMode	the lock mode to obtain

Throws

DataAccessException

public void lock (Object entity, LockMode lockMode)

Obtain the specified lock level upon the given object, implicitly checking whether the corresponding database entry still exists.

Parameters

entity	the persistent instance to lock
lockMode	the lock mode to obtain

Throws

DataAccessException

public T merge (String entityName, T entity)

Copy the state of the given object onto the persistent object with the same identifier. Follows JSR-220 semantics.

Similar to saveOrUpdate, but never associates the given object with the current Hibernate org.hibernate.Session. In the case of a new entity, the state will be copied over as well.

Note that merge will not update the identifiers in the passed-in object graph (in contrast to TopLink)! Consider registering Spring's IdTransferringMergeEventListener if you would like to have newly assigned ids transferred to the original object graph too.

Parameters

entityName	the name of the persistent entity
entity	the object to merge with the corresponding persistence instance

Returns

the updated, registered persistent instance

Throws

DataAccessException

public T merge (T entity)

Copy the state of the given object onto the persistent object with the same identifier. Follows JSR-220 semantics.

Similar to saveOrUpdate, but never associates the given object with the current Hibernate Session. In case of a new entity, the state will be copied over as well.

Note that merge will not update the identifiers in the passed-in object graph (in contrast to TopLink)! Consider registering Spring's IdTransferringMergeEventListener if you would like to have newly assigned ids transferred to the original object graph too.

Parameters

entity	the object to merge with the corresponding persistence instance

Returns

the updated, registered persistent instance

Throws

DataAccessException

public void persist (Object entity)

Persist the given transient instance. Follows JSR-220 semantics.

Similar to save, associating the given object with the current Hibernate org.hibernate.Session.

Parameters

entity	the persistent instance to persist

Throws

DataAccessException

public void persist (String entityName, Object entity)

Persist the given transient instance. Follows JSR-220 semantics.

Similar to save, associating the given object with the current Hibernate org.hibernate.Session.

Parameters

entityName	the name of the persistent entity
entity	the persistent instance to persist

Throws

DataAccessException

public void refresh (Object entity, LockMode lockMode)

Re-read the state of the given persistent instance. Obtains the specified lock mode for the instance.

Parameters

entity	the persistent instance to re-read
lockMode	the lock mode to obtain

Throws

DataAccessException

public void refresh (Object entity)

Re-read the state of the given persistent instance.

Parameters

entity	the persistent instance to re-read

Throws

DataAccessException

public void replicate (Object entity, ReplicationMode replicationMode)

Persist the state of the given detached instance according to the given replication mode, reusing the current identifier value.

Parameters

entity	the persistent object to replicate
replicationMode	the Hibernate ReplicationMode

Throws

DataAccessException

public void replicate (String entityName, Object entity, ReplicationMode replicationMode)

Persist the state of the given detached instance according to the given replication mode, reusing the current identifier value.

Parameters

entityName	the name of the persistent entity
entity	the persistent object to replicate
replicationMode	the Hibernate ReplicationMode

Throws

DataAccessException

public Serializable save (String entityName, Object entity)

Persist the given transient instance.

Parameters

entityName	the name of the persistent entity
entity	the transient instance to persist

Returns

the generated identifier

Throws

DataAccessException

public Serializable save (Object entity)

Persist the given transient instance.

Parameters

entity	the transient instance to persist

Returns

the generated identifier

Throws

DataAccessException

public void saveOrUpdate (Object entity)

Save or update the given persistent instance, according to its id (matching the configured "unsaved-value"?). Associates the instance with the current Hibernate org.hibernate.Session.

Parameters

entity	the persistent instance to save or update (to be associated with the Hibernate `Session`)

Throws

DataAccessException

public void saveOrUpdate (String entityName, Object entity)

Save or update the given persistent instance, according to its id (matching the configured "unsaved-value"?). Associates the instance with the current Hibernate Session.

Parameters

entityName	the name of the persistent entity
entity	the persistent instance to save or update (to be associated with the Hibernate `Session`)

Throws

DataAccessException

public void saveOrUpdateAll (Collection entities)

Save or update all given persistent instances, according to its id (matching the configured "unsaved-value"?). Associates the instances with the current Hibernate Session.

Parameters

entities	the persistent instances to save or update (to be associated with the Hibernate `Session`)

Throws

DataAccessException

public void setAllowCreate (boolean allowCreate)

Set if a new Session should be created when no transactional Session can be found for the current thread. The default value is true.

HibernateTemplate is aware of a corresponding Session bound to the current thread, for example when using HibernateTransactionManager. If allowCreate is true, a new non-transactional Session will be created if none is found, which needs to be closed at the end of the operation. If false, an IllegalStateException will get thrown in this case.

NOTE: As of Spring 2.5, switching allowCreate to false will delegate to Hibernate's org.hibernate.SessionFactory#getCurrentSession() method, which - with Spring-based setup - will by default delegate to Spring's SessionFactoryUtils.getSession(sessionFactory, false). This mode also allows for custom Hibernate CurrentSessionContext strategies to be plugged in, whereas allowCreate set to true will always use a Spring-managed Hibernate Session.

public void setAlwaysUseNewSession (boolean alwaysUseNewSession)

Set whether to always use a new Hibernate Session for this template. Default is "false"; if activated, all operations on this template will work on a new Hibernate Session even in case of a pre-bound Session (for example, within a transaction or OpenSessionInViewFilter).

Within a transaction, a new Hibernate Session used by this template will participate in the transaction through using the same JDBC Connection. In such a scenario, multiple Sessions will participate in the same database transaction.

Turn this on for operations that are supposed to always execute independently, without side effects caused by a shared Hibernate Session.

public void setCacheQueries (boolean cacheQueries)

Set whether to cache all queries executed by this template.

If this is "true", all Query and Criteria objects created by this template will be marked as cacheable (including all queries through find methods).

To specify the query region to be used for queries cached by this template, set the "queryCacheRegion" property.

public void setCheckWriteOperations (boolean checkWriteOperations)

Set whether to check that the Hibernate Session is not in read-only mode in case of write operations (save/update/delete).

Default is "true", for fail-fast behavior when attempting write operations within a read-only transaction. Turn this off to allow save/update/delete on a Session with flush mode NEVER.

public void setExposeNativeSession (boolean exposeNativeSession)

Set whether to expose the native Hibernate Session to HibernateCallback code.

Default is "false": a Session proxy will be returned, suppressing close calls and automatically applying query cache settings and transaction timeouts.

public void setFetchSize (int fetchSize)

Set the fetch size for this HibernateTemplate. This is important for processing large result sets: Setting this higher than the default value will increase processing speed at the cost of memory consumption; setting this lower can avoid transferring row data that will never be read by the application.

Default is 0, indicating to use the JDBC driver's default.

public void setMaxResults (int maxResults)

Set the maximum number of rows for this HibernateTemplate. This is important for processing subsets of large result sets, avoiding to read and hold the entire result set in the database or in the JDBC driver if we're never interested in the entire result in the first place (for example, when performing searches that might return a large number of matches).

Default is 0, indicating to use the JDBC driver's default.

public void setQueryCacheRegion (String queryCacheRegion)

Set the name of the cache region for queries executed by this template.

If this is specified, it will be applied to all Query and Criteria objects created by this template (including all queries through find methods).

The cache region will not take effect unless queries created by this template are configured to be cached via the "cacheQueries" property.

public void update (Object entity, LockMode lockMode)

Update the given persistent instance, associating it with the current Hibernate org.hibernate.Session.

Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.

Parameters

entity	the persistent instance to update
lockMode	the lock mode to obtain

Throws

DataAccessException

public void update (Object entity)

Update the given persistent instance, associating it with the current Hibernate org.hibernate.Session.

Parameters

entity	the persistent instance to update

Throws

DataAccessException

public void update (String entityName, Object entity, LockMode lockMode)

Update the given persistent instance, associating it with the current Hibernate org.hibernate.Session.

Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.

Parameters

entityName	the name of the persistent entity
entity	the persistent instance to update
lockMode	the lock mode to obtain

Throws

DataAccessException

public void update (String entityName, Object entity)

Update the given persistent instance, associating it with the current Hibernate org.hibernate.Session.

Parameters

entityName	the name of the persistent entity
entity	the persistent instance to update

Throws

DataAccessException

Protected Methods

protected void applyNamedParameterToQuery (Query queryObject, String paramName, Object value)

Apply the given name parameter to the given Query object.

Parameters

queryObject	the Query object
paramName	the name of the parameter
value	the value of the parameter

Throws

	if thrown by the Query object
HibernateException

protected void checkWriteOperationAllowed (Session session)

Check whether write operations are allowed on the given Session.

Default implementation throws an InvalidDataAccessApiUsageException in case of FlushMode.MANUAL. Can be overridden in subclasses.

Parameters

session	current Hibernate Session

Throws

InvalidDataAccessApiUsageException	if write operations are not allowed

protected Session createSessionProxy (Session session)

Create a close-suppressing proxy for the given Hibernate Session. The proxy also prepares returned Query and Criteria objects.

Parameters

session	the Hibernate Session to create a proxy for

Returns

the Session proxy

protected T doExecute (HibernateCallback<T> action, boolean enforceNewSession, boolean enforceNativeSession)

Execute the action specified by the given action object within a Session.

Parameters

action	callback object that specifies the Hibernate action
enforceNewSession	whether to enforce a new Session for this template even if there is a pre-bound transactional Session
enforceNativeSession	whether to enforce exposure of the native Hibernate Session to callback code

Returns

a result object returned by the action, or null

Throws

DataAccessException	in case of Hibernate errors

protected Session getSession ()

Return a Session for use by this template.

Returns a new Session in case of "alwaysUseNewSession" (using the same JDBC Connection as a transactional Session, if applicable), a pre-bound Session in case of "allowCreate" turned off, and a pre-bound or new Session otherwise (new only if no transactional or otherwise pre-bound Session exists).

Returns

the Session to use (never null)

protected void prepareCriteria (Criteria criteria)

Prepare the given Criteria object, applying cache settings and/or a transaction timeout.

Parameters

criteria	the Criteria object to prepare

protected void prepareQuery (Query queryObject)

Prepare the given Query object, applying cache settings and/or a transaction timeout.

Parameters

queryObject	the Query object to prepare

Interfaces

Classes

Exceptions

HibernateTemplate

Class Overview

See Also

Summary

Public Constructors

public HibernateTemplate ()

public HibernateTemplate (SessionFactory sessionFactory)

Parameters

public HibernateTemplate (SessionFactory sessionFactory, boolean allowCreate)

Parameters

Public Methods

public int bulkUpdate (String queryString)

Parameters

Returns

Throws

public int bulkUpdate (String queryString, Object value)

Parameters

Returns

Throws

public int bulkUpdate (String queryString, Object... values)

Parameters

Returns

Throws

public void clear ()

Throws

public void closeIterator (Iterator it)

Parameters

Throws

public boolean contains (Object entity)

Parameters

Returns

Throws

public void delete (String entityName, Object entity)

Parameters

Throws

public void delete (Object entity)

Parameters

Throws

public void delete (Object entity, LockMode lockMode)

Parameters

Throws

public void delete (String entityName, Object entity, LockMode lockMode)

Parameters

Throws

public void deleteAll (Collection entities)

Parameters

Throws

public Filter enableFilter (String filterName)

Parameters

Returns

Throws

public void evict (Object entity)

Parameters

Throws

public T execute (HibernateCallback<T> action)

Parameters

Returns

Throws

public List executeFind (HibernateCallback<?> action)

Parameters

Returns

Throws

public T executeWithNativeSession (HibernateCallback<T> action)

Parameters

Returns

Throws

public T executeWithNewSession (HibernateCallback<T> action)

Parameters

Returns

Throws

public List find (String queryString, Object... values)

Parameters

Returns

Throws

public List find (String queryString)

Parameters

Returns