Class OpenSessionInViewInterceptor
- java.lang.Object
- org.springframework.orm.hibernate5.support.OpenSessionInViewInterceptor
- All Implemented Interfaces:
AsyncWebRequestInterceptor
,WebRequestInterceptor
public class OpenSessionInViewInterceptor extends Object implements AsyncWebRequestInterceptor
Spring 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 via
HibernateTransactionManager
as well as for non-transactional execution (if configured appropriately).In contrast to
OpenSessionInViewFilter
, this interceptor is configured in a Spring application context and can thus take advantage of bean wiring.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.- Since:
- 4.2
- Author:
- Juergen Hoeller
- See Also:
OpenSessionInViewFilter
,OpenSessionInterceptor
,HibernateTransactionManager
,TransactionSynchronizationManager
,SessionFactory.getCurrentSession()
Field Summary
Fields Modifier and Type Field Description protected Log
logger
static String
PARTICIPATE_SUFFIX
Suffix that gets appended to theSessionFactory
toString()
representation for the "participate in existing session handling" request attribute.
Constructor Summary
Constructors Constructor Description OpenSessionInViewInterceptor()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
afterCompletion(WebRequest request, Exception ex)
Unbind the HibernateSession
from the thread and close it).void
afterConcurrentHandlingStarted(WebRequest request)
Called instead ofpostHandle
andafterCompletion
, when the the handler started handling the request concurrently.protected String
getParticipateAttributeName()
Return the name of the request attribute that identifies that a request is already intercepted.SessionFactory
getSessionFactory()
Return the Hibernate SessionFactory that should be used to create Hibernate Sessions.protected Session
openSession()
Open a Session for the SessionFactory that this interceptor uses.void
postHandle(WebRequest request, ModelMap model)
Intercept the execution of a request handler after its successful invocation, right before view rendering (if any).void
preHandle(WebRequest request)
Open a new HibernateSession
according and bind it to the thread via theTransactionSynchronizationManager
.void
setSessionFactory(SessionFactory sessionFactory)
Set the Hibernate SessionFactory that should be used to create Hibernate Sessions.
Field Detail
PARTICIPATE_SUFFIX
public static final String PARTICIPATE_SUFFIX
Suffix that gets appended to theSessionFactory
toString()
representation for the "participate in existing session handling" request attribute.
Constructor Detail
OpenSessionInViewInterceptor
public OpenSessionInViewInterceptor()
Method Detail
setSessionFactory
public void setSessionFactory(SessionFactory sessionFactory)
Set the Hibernate SessionFactory that should be used to create Hibernate Sessions.
getSessionFactory
public SessionFactory getSessionFactory()
Return the Hibernate SessionFactory that should be used to create Hibernate Sessions.
preHandle
public void preHandle(WebRequest request) throws DataAccessException
Open a new HibernateSession
according and bind it to the thread via theTransactionSynchronizationManager
.- Specified by:
preHandle
in interfaceWebRequestInterceptor
- Parameters:
request
- the current web request- Throws:
DataAccessException
postHandle
public void postHandle(WebRequest request, ModelMap model)
Description copied from interface:WebRequestInterceptor
Intercept the execution of a request handler after its successful invocation, right before view rendering (if any).Allows for modifying context resources after successful handler execution (for example, flushing a Hibernate Session).
- 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.
afterCompletion
public void afterCompletion(WebRequest request, Exception ex) throws DataAccessException
Unbind the HibernateSession
from the thread and close it).- 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)
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
openSession
protected Session openSession() throws DataAccessResourceFailureException
Open a Session for the SessionFactory that this interceptor uses.The default implementation delegates to the
SessionFactory.openSession()
method and sets theSession
's flush mode to "MANUAL".- Returns:
- the Session to use
- Throws:
DataAccessResourceFailureException
- if the Session could not be created- See Also:
FlushMode.MANUAL
getParticipateAttributeName
protected String getParticipateAttributeName()
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
.