Spring Object/Relational Mapping 6.1.4 · org.springframework.orm.hibernate5.support.HibernateDaoSupport

Convenient superclass for Hibernate-based data access objects.

Requires a SessionFactory to be set, providing a org.springframework.orm.hibernate5.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 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.

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.

Field Summary

Modifier and Type	Field and Description
private HibernateTemplate	hibernateTemplate

Inherited from org.springframework.dao.support.DaoSupport:: logger

Constructor Summary

Access	Constructor and Description
public	HibernateDaoSupport()

Method Summary

Modifier and Type	Method and Description
protected final void	checkDaoConfig() Implements abstract org.springframework.dao.support.DaoSupport.checkDaoConfig. Abstract subclasses must override this to check their configuration.
protected HibernateTemplate	Returns: the new HibernateTemplate instance createHibernateTemplate(SessionFactory the Hibernate SessionFactory to create a HibernateTemplate for sessionFactory) Deprecated as a consequence of `SessionFactory` being deprecated. Create a HibernateTemplate for the given SessionFactory.
protected final Session	Returns: the Hibernate Session currentSession() Deprecated as a consequence of `Session` being deprecated. Conveniently obtain the current Hibernate Session.
public final HibernateTemplate	getHibernateTemplate() Return the HibernateTemplate for this DAO, pre-initialized with the SessionFactory or set explicitly.
public final SessionFactory	getSessionFactory() Deprecated as a consequence of `SessionFactory` being deprecated. Return the Hibernate SessionFactory used by this DAO.
public final void	setHibernateTemplate(HibernateTemplate hibernateTemplate) Set the HibernateTemplate for this DAO explicitly, as an alternative to specifying a SessionFactory.
public final void	setSessionFactory(SessionFactory sessionFactory) Deprecated as a consequence of `SessionFactory` being deprecated. Set the Hibernate SessionFactory to be used by this DAO.

Inherited from org.springframework.dao.support.DaoSupport:: afterPropertiesSet initDao

Field Detail

hibernateTemplate	back to summary
private HibernateTemplate hibernateTemplate Annotations @Nullable

Constructor Detail

HibernateDaoSupport	back to summary
public HibernateDaoSupport()

Method Detail

checkDaoConfig back to summary

checkDaoConfig	back to summary
protected final void checkDaoConfig() Implements abstract org.springframework.dao.support.DaoSupport.checkDaoConfig. Doc from org.springframework.dao.support.DaoSupport.checkDaoConfig. Abstract subclasses must override this to check their configuration. Implementors should be marked as `final` if concrete subclasses are not supposed to override this template method themselves. Annotations @Override

protected final void checkDaoConfig()

Implements abstract org.springframework.dao.support.DaoSupport.checkDaoConfig.

Doc from org.springframework.dao.support.DaoSupport.checkDaoConfig.

Abstract subclasses must override this to check their configuration.

Implementors should be marked as final if concrete subclasses are not supposed to override this template method themselves.

Annotations

@Override

createHibernateTemplate back to summary

createHibernateTemplate	back to summary
protected HibernateTemplate createHibernateTemplate(SessionFactory sessionFactory) Deprecated as a consequence of `SessionFactory` being deprecated. See corresponding docs for further information. Create a HibernateTemplate for the given SessionFactory. Only invoked if populating the DAO with a SessionFactory reference! Can be overridden in subclasses to provide a HibernateTemplate instance with different configuration, or a custom HibernateTemplate subclass. Parameters sessionFactory:SessionFactory the Hibernate SessionFactory to create a HibernateTemplate for Returns:HibernateTemplate the new HibernateTemplate instance See Also `setSessionFactory`

protected HibernateTemplate createHibernateTemplate(SessionFactory sessionFactory)

Deprecated

as a consequence of SessionFactory being deprecated. See corresponding docs for further information.

Create a HibernateTemplate for the given SessionFactory. Only invoked if populating the DAO with a SessionFactory reference!

Can be overridden in subclasses to provide a HibernateTemplate instance with different configuration, or a custom HibernateTemplate subclass.

Parameters

sessionFactory:SessionFactory: the Hibernate SessionFactory to create a HibernateTemplate for

Returns:HibernateTemplate

the new HibernateTemplate instance

See Also

setSessionFactory

currentSession back to summary

currentSession	back to summary
protected final Session currentSession() throws DataAccessResourceFailureException Deprecated as a consequence of `Session` being deprecated. See corresponding docs for further information. Conveniently obtain the current Hibernate Session. Returns:Session the Hibernate Session Exceptions DataAccessResourceFailureException: if the Session couldn't be created See Also `SessionFactory#getCurrentSession()`

protected final Session currentSession() throws DataAccessResourceFailureException

Deprecated

as a consequence of Session being deprecated. See corresponding docs for further information.

Conveniently obtain the current Hibernate Session.

Returns:Session

the Hibernate Session

Exceptions

DataAccessResourceFailureException:: if the Session couldn't be created

See Also

SessionFactory#getCurrentSession()

getHibernateTemplate back to summary

getHibernateTemplate	back to summary
public final HibernateTemplate getHibernateTemplate() Return the HibernateTemplate for this DAO, pre-initialized with the SessionFactory or set explicitly. Note: The returned HibernateTemplate is a shared instance. You may introspect its configuration, but not modify the configuration (other than from within an `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. Annotations @Nullable

public final HibernateTemplate getHibernateTemplate()

Return the HibernateTemplate for this DAO, pre-initialized with the SessionFactory or set explicitly.

Note: The returned HibernateTemplate is a shared instance. You may introspect its configuration, but not modify the configuration (other than from within an 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.

Annotations

@Nullable

getSessionFactory back to summary

getSessionFactory	back to summary
public final SessionFactory getSessionFactory() Deprecated as a consequence of `SessionFactory` being deprecated. See corresponding docs for further information. Return the Hibernate SessionFactory used by this DAO. Annotations @Nullable

public final SessionFactory getSessionFactory()

Deprecated

as a consequence of SessionFactory being deprecated. See corresponding docs for further information.

Return the Hibernate SessionFactory used by this DAO.

Annotations

@Nullable

setHibernateTemplate back to summary

setHibernateTemplate	back to summary
public final void setHibernateTemplate(HibernateTemplate hibernateTemplate) Set the HibernateTemplate for this DAO explicitly, as an alternative to specifying a SessionFactory. See Also `setSessionFactory`

public final void setHibernateTemplate(HibernateTemplate hibernateTemplate)

Set the HibernateTemplate for this DAO explicitly, as an alternative to specifying a SessionFactory.

See Also: setSessionFactory

setSessionFactory back to summary

setSessionFactory	back to summary
public final void setSessionFactory(SessionFactory sessionFactory) Deprecated as a consequence of `SessionFactory` being deprecated. See corresponding docs for further information. Set the Hibernate SessionFactory to be used by this DAO. Will automatically create a HibernateTemplate for the given SessionFactory. See Also `createHibernateTemplate`, `setHibernateTemplate`

public final void setSessionFactory(SessionFactory sessionFactory)

Deprecated

as a consequence of SessionFactory being deprecated. See corresponding docs for further information.

Set the Hibernate SessionFactory to be used by this DAO. Will automatically create a HibernateTemplate for the given SessionFactory.

See Also: createHibernateTemplate, setHibernateTemplate

public abstract Class HibernateDaoSupport

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail