public class HibernateTemplate extends java.lang.Object implements HibernateOperations, InitializingBean
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: Hibernate access code can also be coded in plain Hibernate style.
Hence, for newly started projects, consider adopting the standard Hibernate
style of coding data access objects instead, based on
SessionFactory#getCurrentSession()
.
This HibernateTemplate primarily exists as a migration helper for Hibernate 3
based data access code, to benefit from bug fixes in Hibernate 5.x.
setSessionFactory(SessionFactory)
,
HibernateCallback
,
Session
,
LocalSessionFactoryBean
,
HibernateTransactionManager
,
OpenSessionInViewFilter
,
OpenSessionInViewInterceptor
Modifier and Type | Class and Description |
---|---|
private class |
HibernateTemplate.CloseSuppressingInvocationHandler
Invocation handler that suppresses close calls on Hibernate Sessions.
|
Modifier and Type | Field and Description |
---|---|
private boolean |
cacheQueries |
private boolean |
checkWriteOperations |
private boolean |
exposeNativeSession |
private int |
fetchSize |
private java.lang.String[] |
filterNames |
protected Log |
logger |
private int |
maxResults |
private java.lang.String |
queryCacheRegion |
private SessionFactory |
sessionFactory |
Constructor and Description |
---|
HibernateTemplate()
Create a new HibernateTemplate instance.
|
HibernateTemplate(SessionFactory sessionFactory)
Create a new HibernateTemplate instance.
|
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied
(and satisfied BeanFactoryAware and ApplicationContextAware).
|
protected void |
applyNamedParameterToQuery(Query queryObject,
java.lang.String paramName,
java.lang.Object value)
Apply the given name parameter to the given Query object.
|
int |
bulkUpdate(java.lang.String queryString,
java.lang.Object... values)
Update/delete all objects according to the given query, binding a number of
values to "?" parameters in the query string.
|
protected void |
checkWriteOperationAllowed(Session session)
Check whether write operations are allowed on the given Session.
|
void |
clear()
Remove all objects from the
org.hibernate.Session cache, and
cancel all pending saves, updates and deletes. |
void |
closeIterator(java.util.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(java.lang.Object entity)
Check whether the given object is in the Session cache.
|
protected Session |
createSessionProxy(Session session)
Create a close-suppressing proxy for the given Hibernate Session.
|
void |
delete(java.lang.Object entity)
Delete the given persistent instance.
|
void |
delete(java.lang.Object entity,
LockMode lockMode)
Delete the given persistent instance.
|
void |
delete(java.lang.String entityName,
java.lang.Object entity)
Delete the given persistent instance.
|
void |
delete(java.lang.String entityName,
java.lang.Object entity,
LockMode lockMode)
Delete the given persistent instance.
|
void |
deleteAll(java.util.Collection<?> entities)
Delete all given persistent instances.
|
protected void |
disableFilters(Session session)
Disable the specified filters on the given Session.
|
protected <T> T |
doExecute(HibernateCallback<T> action,
boolean enforceNativeSession)
Execute the action specified by the given action object within a Session.
|
Filter |
enableFilter(java.lang.String filterName)
Return an enabled Hibernate
Filter for the given filter name. |
protected void |
enableFilters(Session session)
Enable the specified filters on the given Session.
|
void |
evict(java.lang.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 . |
<T> T |
executeWithNativeSession(HibernateCallback<T> action)
Execute the action specified by the given action object within a
native
Session . |
java.util.List<?> |
find(java.lang.String queryString,
java.lang.Object... values)
Execute an HQL query, binding a number of values to "?" parameters
in the query string.
|
java.util.List<?> |
findByCriteria(DetachedCriteria criteria)
Execute a query based on a given Hibernate criteria object.
|
java.util.List<?> |
findByCriteria(DetachedCriteria criteria,
int firstResult,
int maxResults)
Execute a query based on the given Hibernate criteria object.
|
<T> java.util.List<T> |
findByExample(java.lang.String entityName,
T exampleEntity)
Execute a query based on the given example entity object.
|
<T> java.util.List<T> |
findByExample(java.lang.String entityName,
T exampleEntity,
int firstResult,
int maxResults)
Execute a query based on a given example entity object.
|
<T> java.util.List<T> |
findByExample(T exampleEntity)
Execute a query based on the given example entity object.
|
<T> java.util.List<T> |
findByExample(T exampleEntity,
int firstResult,
int maxResults)
Execute a query based on a given example entity object.
|
java.util.List<?> |
findByNamedParam(java.lang.String queryString,
java.lang.String[] paramNames,
java.lang.Object[] values)
Execute an HQL query, binding a number of values to ":" named
parameters in the query string.
|
java.util.List<?> |
findByNamedParam(java.lang.String queryString,
java.lang.String paramName,
java.lang.Object value)
Execute an HQL query, binding one value to a ":" named parameter
in the query string.
|
java.util.List<?> |
findByNamedQuery(java.lang.String queryName,
java.lang.Object... values)
Execute a named query binding a number of values to "?" parameters
in the query string.
|
java.util.List<?> |
findByNamedQueryAndNamedParam(java.lang.String queryName,
java.lang.String[] paramNames,
java.lang.Object[] values)
Execute a named query, binding a number of values to ":" named
parameters in the query string.
|
java.util.List<?> |
findByNamedQueryAndNamedParam(java.lang.String queryName,
java.lang.String paramName,
java.lang.Object value)
Execute a named query, binding one value to a ":" named parameter
in the query string.
|
java.util.List<?> |
findByNamedQueryAndValueBean(java.lang.String queryName,
java.lang.Object valueBean)
Execute a named query, binding the properties of the given bean to
":" named parameters in the query string.
|
java.util.List<?> |
findByValueBean(java.lang.String queryString,
java.lang.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(java.lang.Class<T> entityClass,
java.io.Serializable id)
Return the persistent instance of the given entity class
with the given identifier, or
null if not found. |
<T> T |
get(java.lang.Class<T> entityClass,
java.io.Serializable id,
LockMode lockMode)
Return the persistent instance of the given entity class
with the given identifier, or
null if not found. |
java.lang.Object |
get(java.lang.String entityName,
java.io.Serializable id)
Return the persistent instance of the given entity class
with the given identifier, or
null if not found. |
java.lang.Object |
get(java.lang.String entityName,
java.io.Serializable id,
LockMode lockMode)
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.
|
java.lang.String[] |
getFilterNames()
Return the names of Hibernate filters to be activated, if any.
|
int |
getMaxResults()
Return the maximum number of rows specified for this HibernateTemplate.
|
java.lang.String |
getQueryCacheRegion()
Return the name of the cache region for queries executed by this template.
|
SessionFactory |
getSessionFactory()
Return the Hibernate SessionFactory that should be used to create
Hibernate Sessions.
|
void |
initialize(java.lang.Object proxy)
Force initialization of a Hibernate proxy or persistent collection.
|
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.
|
java.util.Iterator<?> |
iterate(java.lang.String queryString,
java.lang.Object... values)
Execute a query for persistent instances, binding a number of
values to "?" parameters in the query string.
|
<T> T |
load(java.lang.Class<T> entityClass,
java.io.Serializable id)
Return the persistent instance of the given entity class
with the given identifier, throwing an exception if not found.
|
<T> T |
load(java.lang.Class<T> entityClass,
java.io.Serializable id,
LockMode lockMode)
Return the persistent instance of the given entity class
with the given identifier, throwing an exception if not found.
|
void |
load(java.lang.Object entity,
java.io.Serializable id)
Load the persistent instance with the given identifier
into the given object, throwing an exception if not found.
|
java.lang.Object |
load(java.lang.String entityName,
java.io.Serializable id)
Return the persistent instance of the given entity class
with the given identifier, throwing an exception if not found.
|
java.lang.Object |
load(java.lang.String entityName,
java.io.Serializable id,
LockMode lockMode)
Return the persistent instance of the given entity class
with the given identifier, throwing an exception if not found.
|
<T> java.util.List<T> |
loadAll(java.lang.Class<T> entityClass)
Return all persistent instances of the given entity class.
|
void |
lock(java.lang.Object entity,
LockMode lockMode)
Obtain the specified lock level upon the given object, implicitly
checking whether the corresponding database entry still exists.
|
void |
lock(java.lang.String entityName,
java.lang.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(java.lang.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(java.lang.Object entity)
Persist the given transient instance.
|
void |
persist(java.lang.String entityName,
java.lang.Object entity)
Persist the given transient instance.
|
protected void |
prepareCriteria(Criteria criteria)
Prepare the given Criteria object, applying cache settings and/or
a transaction timeout.
|
protected void |
prepareQuery(Query queryObject)
Prepare the given Query object, applying cache settings and/or
a transaction timeout.
|
void |
refresh(java.lang.Object entity)
Re-read the state of the given persistent instance.
|
void |
refresh(java.lang.Object entity,
LockMode lockMode)
Re-read the state of the given persistent instance.
|
void |
replicate(java.lang.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(java.lang.String entityName,
java.lang.Object entity,
ReplicationMode replicationMode)
Persist the state of the given detached instance according to the
given replication mode, reusing the current identifier value.
|
java.io.Serializable |
save(java.lang.Object entity)
Persist the given transient instance.
|
java.io.Serializable |
save(java.lang.String entityName,
java.lang.Object entity)
Persist the given transient instance.
|
void |
saveOrUpdate(java.lang.Object entity)
Save or update the given persistent instance,
according to its id (matching the configured "unsaved-value"?).
|
void |
saveOrUpdate(java.lang.String entityName,
java.lang.Object entity)
Save or update the given persistent instance,
according to its id (matching the configured "unsaved-value"?).
|
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 |
setFilterNames(java.lang.String... filterNames)
Set one or more names of Hibernate filters to be activated for all
Sessions that this accessor works with.
|
void |
setMaxResults(int maxResults)
Set the maximum number of rows for this HibernateTemplate.
|
void |
setQueryCacheRegion(java.lang.String queryCacheRegion)
Set the name of the cache region for queries executed by this template.
|
void |
setSessionFactory(SessionFactory sessionFactory)
Set the Hibernate SessionFactory that should be used to create
Hibernate Sessions.
|
void |
update(java.lang.Object entity)
Update the given persistent instance,
associating it with the current Hibernate
org.hibernate.Session . |
void |
update(java.lang.Object entity,
LockMode lockMode)
Update the given persistent instance,
associating it with the current Hibernate
org.hibernate.Session . |
void |
update(java.lang.String entityName,
java.lang.Object entity)
Update the given persistent instance,
associating it with the current Hibernate
org.hibernate.Session . |
void |
update(java.lang.String entityName,
java.lang.Object entity,
LockMode lockMode)
Update the given persistent instance,
associating it with the current Hibernate
org.hibernate.Session . |
protected final Log logger
private SessionFactory sessionFactory
private java.lang.String[] filterNames
private boolean exposeNativeSession
private boolean checkWriteOperations
private boolean cacheQueries
private java.lang.String queryCacheRegion
private int fetchSize
private int maxResults
public HibernateTemplate()
public HibernateTemplate(SessionFactory sessionFactory)
sessionFactory
- the SessionFactory to create Sessions withpublic void setSessionFactory(SessionFactory sessionFactory)
public SessionFactory getSessionFactory()
public void setFilterNames(java.lang.String... filterNames)
Each of those filters will be enabled at the beginning of each operation and correspondingly disabled at the end of the operation. This will work for newly opened Sessions as well as for existing Sessions (for example, within a transaction).
enableFilters(Session)
,
Session#enableFilter(String)
public java.lang.String[] getFilterNames()
public void setExposeNativeSession(boolean exposeNativeSession)
Default is "false": a Session proxy will be returned, suppressing
close
calls and automatically applying query cache
settings and transaction timeouts.
public boolean isExposeNativeSession()
public void setCheckWriteOperations(boolean checkWriteOperations)
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 MANUAL.
public boolean isCheckWriteOperations()
public void setCacheQueries(boolean cacheQueries)
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.
setQueryCacheRegion(java.lang.String)
,
Query#setCacheable
,
Criteria#setCacheable
public boolean isCacheQueries()
public void setQueryCacheRegion(java.lang.String queryCacheRegion)
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.
setCacheQueries(boolean)
,
Query#setCacheRegion
,
Criteria#setCacheRegion
public java.lang.String getQueryCacheRegion()
public void setFetchSize(int fetchSize)
Default is 0, indicating to use the JDBC driver's default.
public int getFetchSize()
public void setMaxResults(int maxResults)
Default is 0, indicating to use the JDBC driver's default.
public int getMaxResults()
public void afterPropertiesSet()
InitializingBean
This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
afterPropertiesSet
in interface InitializingBean
public <T> T execute(HibernateCallback<T> action) throws DataAccessException
HibernateOperations
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.
execute
in interface HibernateOperations
action
- callback object that specifies the Hibernate actionnull
DataAccessException
- in case of Hibernate errorsHibernateTransactionManager
,
org.hibernate.Session
public <T> T executeWithNativeSession(HibernateCallback<T> action)
Session
.
This execute variant overrides the template-wide
"exposeNativeSession"
setting.
action
- callback object that specifies the Hibernate actionnull
DataAccessException
- in case of Hibernate errorsprotected <T> T doExecute(HibernateCallback<T> action, boolean enforceNativeSession) throws DataAccessException
action
- callback object that specifies the Hibernate actionenforceNativeSession
- whether to enforce exposure of the native
Hibernate Session to callback codenull
DataAccessException
- in case of Hibernate errorsprotected Session createSessionProxy(Session session)
session
- the Hibernate Session to create a proxy forSession#close()
,
prepareQuery(Query)
,
prepareCriteria(Criteria)
protected void enableFilters(Session session)
session
- the current Hibernate SessionsetFilterNames(java.lang.String...)
,
Session#enableFilter(String)
protected void disableFilters(Session session)
session
- the current Hibernate SessionsetFilterNames(java.lang.String...)
,
Session#disableFilter(String)
public <T> T get(java.lang.Class<T> entityClass, java.io.Serializable id) throws DataAccessException
HibernateOperations
null
if not found.
This method is a thin wrapper around
org.hibernate.Session#get(Class, 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.
get
in interface HibernateOperations
entityClass
- a persistent classid
- the identifier of the persistent instancenull
if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#get(Class, Serializable)
public <T> T get(java.lang.Class<T> entityClass, java.io.Serializable id, LockMode lockMode) throws DataAccessException
HibernateOperations
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, 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.
get
in interface HibernateOperations
entityClass
- a persistent classid
- the identifier of the persistent instancelockMode
- the lock mode to obtainnull
if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#get(Class, Serializable, LockMode)
public java.lang.Object get(java.lang.String entityName, java.io.Serializable id) throws DataAccessException
HibernateOperations
null
if not found.
This method is a thin wrapper around
org.hibernate.Session#get(String, 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.
get
in interface HibernateOperations
entityName
- the name of the persistent entityid
- the identifier of the persistent instancenull
if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#get(Class, Serializable)
public java.lang.Object get(java.lang.String entityName, java.io.Serializable id, LockMode lockMode) throws DataAccessException
HibernateOperations
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, 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.
get
in interface HibernateOperations
entityName
- the name of the persistent entityid
- the identifier of the persistent instancelockMode
- the lock mode to obtainnull
if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#get(Class, Serializable, LockMode)
public <T> T load(java.lang.Class<T> entityClass, java.io.Serializable id) throws DataAccessException
HibernateOperations
This method is a thin wrapper around
org.hibernate.Session#load(Class, 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.
load
in interface HibernateOperations
entityClass
- a persistent classid
- the identifier of the persistent instanceObjectRetrievalFailureException
- if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#load(Class, Serializable)
public <T> T load(java.lang.Class<T> entityClass, java.io.Serializable id, LockMode lockMode) throws DataAccessException
HibernateOperations
This method is a thin wrapper around
org.hibernate.Session#load(Class, 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.
load
in interface HibernateOperations
entityClass
- a persistent classid
- the identifier of the persistent instancelockMode
- the lock mode to obtainObjectRetrievalFailureException
- if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#load(Class, Serializable)
public java.lang.Object load(java.lang.String entityName, java.io.Serializable id) throws DataAccessException
HibernateOperations
This method is a thin wrapper around
org.hibernate.Session#load(String, 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.
load
in interface HibernateOperations
entityName
- the name of the persistent entityid
- the identifier of the persistent instanceObjectRetrievalFailureException
- if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#load(Class, Serializable)
public java.lang.Object load(java.lang.String entityName, java.io.Serializable id, LockMode lockMode) throws DataAccessException
HibernateOperations
Obtains the specified lock mode if the instance exists.
This method is a thin wrapper around
org.hibernate.Session#load(String, 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.
load
in interface HibernateOperations
entityName
- the name of the persistent entityid
- the identifier of the persistent instancelockMode
- the lock mode to obtainObjectRetrievalFailureException
- if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#load(Class, Serializable)
public <T> java.util.List<T> loadAll(java.lang.Class<T> entityClass) throws DataAccessException
HibernateOperations
loadAll
in interface HibernateOperations
entityClass
- a persistent classList
containing 0 or more persistent instancesDataAccessException
- if there is a Hibernate errororg.hibernate.Session#createCriteria
public void load(java.lang.Object entity, java.io.Serializable id) throws DataAccessException
HibernateOperations
This method is a thin wrapper around
org.hibernate.Session#load(Object, 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.
load
in interface HibernateOperations
entity
- the object (of the target class) to load intoid
- the identifier of the persistent instanceObjectRetrievalFailureException
- if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#load(Object, Serializable)
public void refresh(java.lang.Object entity) throws DataAccessException
HibernateOperations
refresh
in interface HibernateOperations
entity
- the persistent instance to re-readDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#refresh(Object)
public void refresh(java.lang.Object entity, LockMode lockMode) throws DataAccessException
HibernateOperations
refresh
in interface HibernateOperations
entity
- the persistent instance to re-readlockMode
- the lock mode to obtainDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#refresh(Object, LockMode)
public boolean contains(java.lang.Object entity) throws DataAccessException
HibernateOperations
contains
in interface HibernateOperations
entity
- the persistence instance to checkDataAccessException
- if there is a Hibernate errororg.hibernate.Session#contains
public void evict(java.lang.Object entity) throws DataAccessException
HibernateOperations
org.hibernate.Session
cache.evict
in interface HibernateOperations
entity
- the persistent instance to evictDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#evict
public void initialize(java.lang.Object proxy) throws DataAccessException
HibernateOperations
initialize
in interface HibernateOperations
proxy
- a proxy for a persistent object or a persistent collectionDataAccessException
- if we can't initialize the proxy, for example
because it is not associated with an active Sessionorg.hibernate.Hibernate#initialize
public Filter enableFilter(java.lang.String filterName) throws java.lang.IllegalStateException
HibernateOperations
Filter
for the given filter name.
The returned Filter
instance can be used to set filter parameters.enableFilter
in interface HibernateOperations
filterName
- the name of the filterFilter
(either already
enabled or enabled on the fly by this operation)java.lang.IllegalStateException
- if we are not running within a
transactional Session (in which case this operation does not make sense)public void lock(java.lang.Object entity, LockMode lockMode) throws DataAccessException
HibernateOperations
lock
in interface HibernateOperations
entity
- the persistent instance to locklockMode
- the lock mode to obtainObjectOptimisticLockingFailureException
- if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#lock(Object, LockMode)
public void lock(java.lang.String entityName, java.lang.Object entity, LockMode lockMode) throws DataAccessException
HibernateOperations
lock
in interface HibernateOperations
entityName
- the name of the persistent entityentity
- the persistent instance to locklockMode
- the lock mode to obtainObjectOptimisticLockingFailureException
- if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#lock(String, Object, LockMode)
public java.io.Serializable save(java.lang.Object entity) throws DataAccessException
HibernateOperations
save
in interface HibernateOperations
entity
- the transient instance to persistDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#save(Object)
public java.io.Serializable save(java.lang.String entityName, java.lang.Object entity) throws DataAccessException
HibernateOperations
save
in interface HibernateOperations
entityName
- the name of the persistent entityentity
- the transient instance to persistDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#save(String, Object)
public void update(java.lang.Object entity) throws DataAccessException
HibernateOperations
org.hibernate.Session
.update
in interface HibernateOperations
entity
- the persistent instance to updateDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#update(Object)
public void update(java.lang.Object entity, LockMode lockMode) throws DataAccessException
HibernateOperations
org.hibernate.Session
.
Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.
update
in interface HibernateOperations
entity
- the persistent instance to updatelockMode
- the lock mode to obtainObjectOptimisticLockingFailureException
- if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#update(Object)
public void update(java.lang.String entityName, java.lang.Object entity) throws DataAccessException
HibernateOperations
org.hibernate.Session
.update
in interface HibernateOperations
entityName
- the name of the persistent entityentity
- the persistent instance to updateDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#update(String, Object)
public void update(java.lang.String entityName, java.lang.Object entity, LockMode lockMode) throws DataAccessException
HibernateOperations
org.hibernate.Session
.
Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.
update
in interface HibernateOperations
entityName
- the name of the persistent entityentity
- the persistent instance to updatelockMode
- the lock mode to obtainObjectOptimisticLockingFailureException
- if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#update(String, Object)
public void saveOrUpdate(java.lang.Object entity) throws DataAccessException
HibernateOperations
org.hibernate.Session
.saveOrUpdate
in interface HibernateOperations
entity
- the persistent instance to save or update
(to be associated with the Hibernate Session
)DataAccessException
- in case of Hibernate errorsorg.hibernate.Session#saveOrUpdate(Object)
public void saveOrUpdate(java.lang.String entityName, java.lang.Object entity) throws DataAccessException
HibernateOperations
Session
.saveOrUpdate
in interface HibernateOperations
entityName
- the name of the persistent entityentity
- the persistent instance to save or update
(to be associated with the Hibernate Session
)DataAccessException
- in case of Hibernate errorsorg.hibernate.Session#saveOrUpdate(String, Object)
public void replicate(java.lang.Object entity, ReplicationMode replicationMode) throws DataAccessException
HibernateOperations
replicate
in interface HibernateOperations
entity
- the persistent object to replicatereplicationMode
- the Hibernate ReplicationModeDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#replicate(Object, ReplicationMode)
public void replicate(java.lang.String entityName, java.lang.Object entity, ReplicationMode replicationMode) throws DataAccessException
HibernateOperations
replicate
in interface HibernateOperations
entityName
- the name of the persistent entityentity
- the persistent object to replicatereplicationMode
- the Hibernate ReplicationModeDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#replicate(String, Object, ReplicationMode)
public void persist(java.lang.Object entity) throws DataAccessException
HibernateOperations
Similar to save
, associating the given object
with the current Hibernate org.hibernate.Session
.
persist
in interface HibernateOperations
entity
- the persistent instance to persistDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#persist(Object)
,
HibernateOperations.save(java.lang.Object)
public void persist(java.lang.String entityName, java.lang.Object entity) throws DataAccessException
HibernateOperations
Similar to save
, associating the given object
with the current Hibernate org.hibernate.Session
.
persist
in interface HibernateOperations
entityName
- the name of the persistent entityentity
- the persistent instance to persistDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#persist(String, Object)
,
HibernateOperations.save(java.lang.Object)
public <T> T merge(T entity) throws DataAccessException
HibernateOperations
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.
merge
in interface HibernateOperations
entity
- the object to merge with the corresponding persistence instanceDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#merge(Object)
,
HibernateOperations.saveOrUpdate(java.lang.Object)
public <T> T merge(java.lang.String entityName, T entity) throws DataAccessException
HibernateOperations
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.
merge
in interface HibernateOperations
entityName
- the name of the persistent entityentity
- the object to merge with the corresponding persistence instanceDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#merge(String, Object)
,
HibernateOperations.saveOrUpdate(java.lang.Object)
public void delete(java.lang.Object entity) throws DataAccessException
HibernateOperations
delete
in interface HibernateOperations
entity
- the persistent instance to deleteDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#delete(Object)
public void delete(java.lang.Object entity, LockMode lockMode) throws DataAccessException
HibernateOperations
Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.
delete
in interface HibernateOperations
entity
- the persistent instance to deletelockMode
- the lock mode to obtainObjectOptimisticLockingFailureException
- if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#delete(Object)
public void delete(java.lang.String entityName, java.lang.Object entity) throws DataAccessException
HibernateOperations
delete
in interface HibernateOperations
entityName
- the name of the persistent entityentity
- the persistent instance to deleteDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#delete(Object)
public void delete(java.lang.String entityName, java.lang.Object entity, LockMode lockMode) throws DataAccessException
HibernateOperations
Obtains the specified lock mode if the instance exists, implicitly checking whether the corresponding database entry still exists.
delete
in interface HibernateOperations
entityName
- the name of the persistent entityentity
- the persistent instance to deletelockMode
- the lock mode to obtainObjectOptimisticLockingFailureException
- if not foundDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#delete(Object)
public void deleteAll(java.util.Collection<?> entities) throws DataAccessException
HibernateOperations
This can be combined with any of the find methods to delete by query in two lines of code.
deleteAll
in interface HibernateOperations
entities
- the persistent instances to deleteDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#delete(Object)
public void flush() throws DataAccessException
HibernateOperations
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.
flush
in interface HibernateOperations
DataAccessException
- in case of Hibernate errorsorg.hibernate.Session#flush
public void clear() throws DataAccessException
HibernateOperations
org.hibernate.Session
cache, and
cancel all pending saves, updates and deletes.clear
in interface HibernateOperations
DataAccessException
- in case of Hibernate errorsorg.hibernate.Session#clear
public java.util.List<?> find(java.lang.String queryString, java.lang.Object... values) throws DataAccessException
HibernateOperations
find
in interface HibernateOperations
queryString
- a query expressed in Hibernate's query languagevalues
- the values of the parametersList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#createQuery
public java.util.List<?> findByNamedParam(java.lang.String queryString, java.lang.String paramName, java.lang.Object value) throws DataAccessException
HibernateOperations
findByNamedParam
in interface HibernateOperations
queryString
- a query expressed in Hibernate's query languageparamName
- the name of the parametervalue
- the value of the parameterList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#getNamedQuery(String)
public java.util.List<?> findByNamedParam(java.lang.String queryString, java.lang.String[] paramNames, java.lang.Object[] values) throws DataAccessException
HibernateOperations
findByNamedParam
in interface HibernateOperations
queryString
- a query expressed in Hibernate's query languageparamNames
- the names of the parametersvalues
- the values of the parametersList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#getNamedQuery(String)
public java.util.List<?> findByValueBean(java.lang.String queryString, java.lang.Object valueBean) throws DataAccessException
HibernateOperations
findByValueBean
in interface HibernateOperations
queryString
- a query expressed in Hibernate's query languagevalueBean
- the values of the parametersList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsorg.hibernate.Query#setProperties
,
org.hibernate.Session#createQuery
public java.util.List<?> findByNamedQuery(java.lang.String queryName, java.lang.Object... values) throws DataAccessException
HibernateOperations
A named query is defined in a Hibernate mapping file.
findByNamedQuery
in interface HibernateOperations
queryName
- the name of a Hibernate query in a mapping filevalues
- the values of the parametersList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#getNamedQuery(String)
public java.util.List<?> findByNamedQueryAndNamedParam(java.lang.String queryName, java.lang.String paramName, java.lang.Object value) throws DataAccessException
HibernateOperations
A named query is defined in a Hibernate mapping file.
findByNamedQueryAndNamedParam
in interface HibernateOperations
queryName
- the name of a Hibernate query in a mapping fileparamName
- the name of parametervalue
- the value of the parameterList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#getNamedQuery(String)
public java.util.List<?> findByNamedQueryAndNamedParam(java.lang.String queryName, java.lang.String[] paramNames, java.lang.Object[] values) throws DataAccessException
HibernateOperations
A named query is defined in a Hibernate mapping file.
findByNamedQueryAndNamedParam
in interface HibernateOperations
queryName
- the name of a Hibernate query in a mapping fileparamNames
- the names of the parametersvalues
- the values of the parametersList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#getNamedQuery(String)
public java.util.List<?> findByNamedQueryAndValueBean(java.lang.String queryName, java.lang.Object valueBean) throws DataAccessException
HibernateOperations
A named query is defined in a Hibernate mapping file.
findByNamedQueryAndValueBean
in interface HibernateOperations
queryName
- the name of a Hibernate query in a mapping filevalueBean
- the values of the parametersList
containing the results of the query executionDataAccessException
- in case of Hibernate errorsorg.hibernate.Query#setProperties
,
org.hibernate.Session#getNamedQuery(String)
public java.util.List<?> findByCriteria(DetachedCriteria criteria) throws DataAccessException
HibernateOperations
findByCriteria
in interface HibernateOperations
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.List
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsDetachedCriteria#getExecutableCriteria(org.hibernate.Session)
public java.util.List<?> findByCriteria(DetachedCriteria criteria, int firstResult, int maxResults) throws DataAccessException
HibernateOperations
findByCriteria
in interface HibernateOperations
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)List
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsDetachedCriteria#getExecutableCriteria(org.hibernate.Session)
,
org.hibernate.Criteria#setFirstResult(int)
,
org.hibernate.Criteria#setMaxResults(int)
public <T> java.util.List<T> findByExample(T exampleEntity) throws DataAccessException
HibernateOperations
findByExample
in interface HibernateOperations
exampleEntity
- an instance of the desired entity,
serving as example for "query-by-example"List
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsorg.hibernate.criterion.Example#create(Object)
public <T> java.util.List<T> findByExample(java.lang.String entityName, T exampleEntity) throws DataAccessException
HibernateOperations
findByExample
in interface HibernateOperations
entityName
- the name of the persistent entityexampleEntity
- an instance of the desired entity,
serving as example for "query-by-example"List
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsorg.hibernate.criterion.Example#create(Object)
public <T> java.util.List<T> findByExample(T exampleEntity, int firstResult, int maxResults) throws DataAccessException
HibernateOperations
findByExample
in interface HibernateOperations
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)List
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsorg.hibernate.criterion.Example#create(Object)
,
org.hibernate.Criteria#setFirstResult(int)
,
org.hibernate.Criteria#setMaxResults(int)
public <T> java.util.List<T> findByExample(java.lang.String entityName, T exampleEntity, int firstResult, int maxResults) throws DataAccessException
HibernateOperations
findByExample
in interface HibernateOperations
entityName
- the name of the persistent entityexampleEntity
- 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)List
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsorg.hibernate.criterion.Example#create(Object)
,
org.hibernate.Criteria#setFirstResult(int)
,
org.hibernate.Criteria#setMaxResults(int)
public java.util.Iterator<?> iterate(java.lang.String queryString, java.lang.Object... values) throws DataAccessException
HibernateOperations
Returns the results as an Iterator
. Entities returned are
initialized on demand. See the Hibernate API documentation for details.
iterate
in interface HibernateOperations
queryString
- a query expressed in Hibernate's query languagevalues
- the values of the parametersIterator
containing 0 or more persistent instancesDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#createQuery
,
org.hibernate.Query#iterate
public void closeIterator(java.util.Iterator<?> it) throws DataAccessException
HibernateOperations
Iterator
created by any of the various
iterate(..)
operations, instead of waiting until the
session is closed or disconnected.closeIterator
in interface HibernateOperations
it
- the Iterator
to closeDataAccessException
- if the Iterator
could not be closedorg.hibernate.Hibernate#close
public int bulkUpdate(java.lang.String queryString, java.lang.Object... values) throws DataAccessException
HibernateOperations
bulkUpdate
in interface HibernateOperations
queryString
- an update/delete query expressed in Hibernate's query languagevalues
- the values of the parametersDataAccessException
- in case of Hibernate errorsorg.hibernate.Session#createQuery
,
org.hibernate.Query#executeUpdate
protected void checkWriteOperationAllowed(Session session) throws InvalidDataAccessApiUsageException
Default implementation throws an InvalidDataAccessApiUsageException in
case of FlushMode.MANUAL
. Can be overridden in subclasses.
session
- current Hibernate SessionInvalidDataAccessApiUsageException
- if write operations are not allowedsetCheckWriteOperations(boolean)
,
Session#getFlushMode()
,
FlushMode#MANUAL
protected void prepareQuery(Query queryObject)
queryObject
- the Query object to preparesetCacheQueries(boolean)
,
setQueryCacheRegion(java.lang.String)
protected void prepareCriteria(Criteria criteria)
criteria
- the Criteria object to preparesetCacheQueries(boolean)
,
setQueryCacheRegion(java.lang.String)
protected void applyNamedParameterToQuery(Query queryObject, java.lang.String paramName, java.lang.Object value) throws HibernateException
queryObject
- the Query objectparamName
- the name of the parametervalue
- the value of the parameterHibernateException
- if thrown by the Query object