Class OpenSessionInViewInterceptor
- java.lang.Object
- org.springframework.orm.hibernate3.HibernateAccessor
- org.springframework.orm.hibernate3.support.OpenSessionInViewInterceptor
- All Implemented Interfaces:
Aware
,BeanFactoryAware
,InitializingBean
,AsyncWebRequestInterceptor
,WebRequestInterceptor
@Deprecated public class OpenSessionInViewInterceptor extends HibernateAccessor implements AsyncWebRequestInterceptor
Deprecated.as of Spring 4.3, in favor of Hibernate 4.x/5.xSpring web request interceptor that binds a HibernateSession
to the thread for the entire processing of the request.This class is a concrete expression of the "Open Session in View" pattern, which is a pattern that allows for the lazy loading of associations in web views despite the original transactions already being completed.
This interceptor makes Hibernate
Sessions
available via the current thread, which will be autodetected by transaction managers. It is suitable for service layer transactions viaHibernateTransactionManager
orJtaTransactionManager
as well as for non-transactional execution (if configured appropriately).NOTE: This interceptor will by default not flush the Hibernate
Session
, with the flush mode being set toFlushMode.NEVER
. It assumes that it will be used in combination with service layer transactions that handle the flushing: the active transaction manager will temporarily change the flush mode toFlushMode.AUTO
during a read-write transaction, with the flush mode reset toFlushMode.NEVER
at the end of each transaction. If you intend to use this interceptor without transactions, consider changing the default flush mode (through the"flushMode"
property).In contrast to
OpenSessionInViewFilter
, this interceptor is configured in a Spring application context and can thus take advantage of bean wiring. It inherits common Hibernate configuration properties fromHibernateAccessor
, to be configured in a bean definition.WARNING: Applying this interceptor to existing logic can cause issues that have not appeared before, through the use of a single Hibernate
Session
for the processing of an entire request. In particular, the reassociation of persistent objects with a HibernateSession
has to occur at the very beginning of request processing, to avoid clashes with already loaded instances of the same objects.Alternatively, turn this interceptor into deferred close mode, by specifying "singleSession"="false": It will not use a single session per request then, but rather let each data access operation or transaction use its own session (as would be the case without Open Session in View). Each of those sessions will be registered for deferred close though, which will actually be processed at request completion.
A single session per request allows for the most efficient first-level caching, but can cause side effects, for example on
saveOrUpdate
or when continuing after a rolled-back transaction. The deferred close strategy is as safe as no Open Session in View in that respect, while still allowing for lazy loading in views (but not providing a first-level cache for the entire request).- Since:
- 1.2
- Author:
- Juergen Hoeller
- See Also:
setSingleSession(boolean)
,HibernateAccessor.setFlushMode(int)
,OpenSessionInViewFilter
,OpenSessionInterceptor
,HibernateTransactionManager
,SessionFactoryUtils.getSession(org.hibernate.SessionFactory, boolean)
,TransactionSynchronizationManager
,SessionFactory.getCurrentSession()
Field Summary
Fields Modifier and Type Field Description static String
PARTICIPATE_SUFFIX
Deprecated.Suffix that gets appended to theSessionFactory
toString()
representation for the "participate in existing session handling" request attribute.Fields inherited from class org.springframework.orm.hibernate3.HibernateAccessor
FLUSH_ALWAYS, FLUSH_AUTO, FLUSH_COMMIT, FLUSH_EAGER, FLUSH_NEVER, logger
Constructor Summary
Constructors Constructor Description OpenSessionInViewInterceptor()
Deprecated.Create a newOpenSessionInViewInterceptor
, turning the default flushMode toFLUSH_NEVER
.
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
afterCompletion(WebRequest request, Exception ex)
Deprecated.Unbind the HibernateSession
from the thread and close it (in single session mode), or process deferred close for all sessions that have been opened during the current request (in deferred close mode).void
afterConcurrentHandlingStarted(WebRequest request)
Deprecated.Called instead ofpostHandle
andafterCompletion
, when the the handler started handling the request concurrently.protected String
getParticipateAttributeName()
Deprecated.Return the name of the request attribute that identifies that a request is already intercepted.protected boolean
isSingleSession()
Deprecated.Return whether to use a single session for each request.void
postHandle(WebRequest request, ModelMap model)
Deprecated.Flush the HibernateSession
before view rendering, if necessary.void
preHandle(WebRequest request)
Deprecated.Open a new HibernateSession
according to the settings of thisHibernateAccessor
and bind it to the thread via theTransactionSynchronizationManager
.void
setSingleSession(boolean singleSession)
Deprecated.Set whether to use a single session for each request.Methods inherited from class org.springframework.orm.hibernate3.HibernateAccessor
afterPropertiesSet, applyFlushMode, convertHibernateAccessException, convertJdbcAccessException, convertJdbcAccessException, disableFilters, enableFilters, flushIfNecessary, getDefaultJdbcExceptionTranslator, getEntityInterceptor, getFilterNames, getFlushMode, getJdbcExceptionTranslator, getSessionFactory, setBeanFactory, setEntityInterceptor, setEntityInterceptorBeanName, setFilterName, setFilterNames, setFlushMode, setFlushModeName, setJdbcExceptionTranslator, setSessionFactory
Field Detail
PARTICIPATE_SUFFIX
public static final String PARTICIPATE_SUFFIX
Deprecated.Suffix that gets appended to theSessionFactory
toString()
representation for the "participate in existing session handling" request attribute.
Constructor Detail
OpenSessionInViewInterceptor
public OpenSessionInViewInterceptor()
Deprecated.Create a newOpenSessionInViewInterceptor
, turning the default flushMode toFLUSH_NEVER
.- See Also:
HibernateAccessor.setFlushMode(int)
Method Detail
setSingleSession
public void setSingleSession(boolean singleSession)
Deprecated.Set whether to use a single session for each request. Default is "true".If set to false, each data access operation or transaction will use its own session (like without Open Session in View). Each of those sessions will be registered for deferred close, though, actually processed at request completion.
isSingleSession
protected boolean isSingleSession()
Deprecated.Return whether to use a single session for each request.
preHandle
public void preHandle(WebRequest request) throws DataAccessException
Deprecated.Open a new HibernateSession
according to the settings of thisHibernateAccessor
and bind it to the thread via theTransactionSynchronizationManager
.- Specified by:
preHandle
in interfaceWebRequestInterceptor
- Parameters:
request
- the current web request- Throws:
DataAccessException
- See Also:
SessionFactoryUtils.getSession(org.hibernate.SessionFactory, boolean)
postHandle
public void postHandle(WebRequest request, ModelMap model) throws DataAccessException
Deprecated.Flush the HibernateSession
before view rendering, if necessary.Note that this just applies in
single session mode
!The default is
FLUSH_NEVER
to avoid this extra flushing, assuming that service layer transactions have flushed their changes on commit.- Specified by:
postHandle
in interfaceWebRequestInterceptor
- Parameters:
request
- the current web requestmodel
- the map of model objects that will be exposed to the view (may benull
). Can be used to analyze the exposed model and/or to add further model attributes, if desired.- Throws:
DataAccessException
- See Also:
HibernateAccessor.setFlushMode(int)
afterCompletion
public void afterCompletion(WebRequest request, Exception ex) throws DataAccessException
Deprecated.Unbind the HibernateSession
from the thread and close it (in single session mode), or process deferred close for all sessions that have been opened during the current request (in deferred close mode).- Specified by:
afterCompletion
in interfaceWebRequestInterceptor
- Parameters:
request
- the current web requestex
- exception thrown on handler execution, if any- Throws:
DataAccessException
- See Also:
TransactionSynchronizationManager
afterConcurrentHandlingStarted
public void afterConcurrentHandlingStarted(WebRequest request)
Deprecated.Description copied from interface:AsyncWebRequestInterceptor
Called instead ofpostHandle
andafterCompletion
, when the the handler started handling the request concurrently.- Specified by:
afterConcurrentHandlingStarted
in interfaceAsyncWebRequestInterceptor
- Parameters:
request
- the current request
getParticipateAttributeName
protected String getParticipateAttributeName()
Deprecated.Return the name of the request attribute that identifies that a request is already intercepted.The default implementation takes the
toString()
representation of theSessionFactory
instance and appendsPARTICIPATE_SUFFIX
.