|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.dao.support.DaoSupport org.springframework.orm.hibernate3.support.HibernateDaoSupport
public abstract class HibernateDaoSupport
Convenient super class for Hibernate-based data access objects.
Requires a SessionFactory
to be set, providing a
HibernateTemplate
based on it to
subclasses through the getHibernateTemplate()
method.
Can alternatively be initialized directly with a HibernateTemplate,
in order to reuse the latter's settings such as the SessionFactory,
exception translator, flush mode, etc.
This base class is mainly intended for HibernateTemplate usage but can
also be used when working with a Hibernate Session directly, for example
when relying on transactional Sessions. Convenience getSession()
and releaseSession(org.hibernate.Session)
methods are provided for that usage style.
This class will create its own HibernateTemplate instance if a SessionFactory
is passed in. The "allowCreate" flag on that HibernateTemplate will be "true"
by default. A custom HibernateTemplate instance can be used through overriding
createHibernateTemplate(org.hibernate.SessionFactory)
.
setSessionFactory(org.hibernate.SessionFactory)
,
getHibernateTemplate()
,
HibernateTemplate
Field Summary |
---|
Fields inherited from class org.springframework.dao.support.DaoSupport |
---|
logger |
Constructor Summary | |
---|---|
HibernateDaoSupport()
|
Method Summary | |
---|---|
protected void |
checkDaoConfig()
Abstract subclasses must override this to check their configuration. |
protected DataAccessException |
convertHibernateAccessException(HibernateException ex)
Convert the given HibernateException to an appropriate exception from the org.springframework.dao hierarchy. |
protected HibernateTemplate |
createHibernateTemplate(SessionFactory sessionFactory)
Create a HibernateTemplate for the given SessionFactory. |
HibernateTemplate |
getHibernateTemplate()
Return the HibernateTemplate for this DAO, pre-initialized with the SessionFactory or set explicitly. |
protected Session |
getSession()
Obtain a Hibernate Session, either from the current transaction or a new one. |
protected Session |
getSession(boolean allowCreate)
Obtain a Hibernate Session, either from the current transaction or a new one. |
SessionFactory |
getSessionFactory()
Return the Hibernate SessionFactory used by this DAO. |
protected void |
releaseSession(Session session)
Close the given Hibernate Session, created via this DAO's SessionFactory, if it isn't bound to the thread (i.e. isn't a transactional Session). |
void |
setHibernateTemplate(HibernateTemplate hibernateTemplate)
Set the HibernateTemplate for this DAO explicitly, as an alternative to specifying a SessionFactory. |
void |
setSessionFactory(SessionFactory sessionFactory)
Set the Hibernate SessionFactory to be used by this DAO. |
Methods inherited from class org.springframework.dao.support.DaoSupport |
---|
afterPropertiesSet, initDao |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HibernateDaoSupport()
Method Detail |
---|
public final void setSessionFactory(SessionFactory sessionFactory)
protected HibernateTemplate createHibernateTemplate(SessionFactory sessionFactory)
Can be overridden in subclasses to provide a HibernateTemplate instance with different configuration, or a custom HibernateTemplate subclass.
sessionFactory
- the Hibernate SessionFactory to create a HibernateTemplate for
setSessionFactory(org.hibernate.SessionFactory)
public final SessionFactory getSessionFactory()
public final void setHibernateTemplate(HibernateTemplate hibernateTemplate)
public final HibernateTemplate getHibernateTemplate()
Note: The returned HibernateTemplate is a shared instance.
You may introspect its configuration, but not modify the configuration
(other than from within an DaoSupport.initDao()
implementation).
Consider creating a custom HibernateTemplate instance via
new HibernateTemplate(getSessionFactory())
, in which
case you're allowed to customize the settings on the resulting instance.
protected final void checkDaoConfig()
DaoSupport
Implementors should be marked as final
checkDaoConfig
in class DaoSupport
protected final Session getSession() throws DataAccessResourceFailureException, IllegalStateException
"allowCreate"
setting of this bean's HibernateTemplate
is "true".
Note that this is not meant to be invoked from HibernateTemplate code
but rather just in plain Hibernate code. Either rely on a thread-bound
Session or use it in combination with releaseSession(org.hibernate.Session)
.
In general, it is recommended to use HibernateTemplate, either with the provided convenience operations or with a custom HibernateCallback that provides you with a Session to work on. HibernateTemplate will care for all resource management and for proper exception conversion.
DataAccessResourceFailureException
- if the Session couldn't be created
IllegalStateException
- if no thread-bound Session found and allowCreate=falseSessionFactoryUtils.getSession(SessionFactory, boolean)
protected final Session getSession(boolean allowCreate) throws DataAccessResourceFailureException, IllegalStateException
Note that this is not meant to be invoked from HibernateTemplate code
but rather just in plain Hibernate code. Either rely on a thread-bound
Session or use it in combination with releaseSession(org.hibernate.Session)
.
In general, it is recommended to use
HibernateTemplate
, either with
the provided convenience operations or with a custom
HibernateCallback
that
provides you with a Session to work on. HibernateTemplate will care
for all resource management and for proper exception conversion.
allowCreate
- if a non-transactional Session should be created when no
transactional Session can be found for the current thread
DataAccessResourceFailureException
- if the Session couldn't be created
IllegalStateException
- if no thread-bound Session found and allowCreate=falseSessionFactoryUtils.getSession(SessionFactory, boolean)
protected final DataAccessException convertHibernateAccessException(HibernateException ex)
org.springframework.dao
hierarchy. Will automatically detect
wrapped SQLExceptions and convert them accordingly.
Delegates to the
HibernateAccessor.convertHibernateAccessException(org.hibernate.HibernateException)
method of this DAO's HibernateTemplate.
Typically used in plain Hibernate code, in combination with
getSession()
and releaseSession(org.hibernate.Session)
.
ex
- HibernateException that occured
SessionFactoryUtils.convertHibernateAccessException(org.hibernate.HibernateException)
protected final void releaseSession(Session session)
Typically used in plain Hibernate code, in combination with
getSession()
and convertHibernateAccessException(org.hibernate.HibernateException)
.
session
- the Session to closeSessionFactoryUtils.releaseSession(org.hibernate.Session, org.hibernate.SessionFactory)
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |