Class OpenSessionInViewInterceptor
- All Implemented Interfaces:
org.springframework.web.context.request.AsyncWebRequestInterceptor
,org.springframework.web.context.request.WebRequestInterceptor
Session
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 Hibernate Session
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
Modifier and TypeFieldDescriptionprotected final org.apache.commons.logging.Log
static final String
Suffix that gets appended to theSessionFactory
toString()
representation for the "participate in existing session handling" request attribute. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
afterCompletion
(org.springframework.web.context.request.WebRequest request, Exception ex) Unbind the HibernateSession
from the thread and close it.void
afterConcurrentHandlingStarted
(org.springframework.web.context.request.WebRequest request) protected String
Return the name of the request attribute that identifies that a request is already intercepted.Return the Hibernate SessionFactory that should be used to create Hibernate Sessions.protected Session
Open a Session for the SessionFactory that this interceptor uses.void
postHandle
(org.springframework.web.context.request.WebRequest request, org.springframework.ui.ModelMap model) void
preHandle
(org.springframework.web.context.request.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 Details
-
PARTICIPATE_SUFFIX
Suffix that gets appended to theSessionFactory
toString()
representation for the "participate in existing session handling" request attribute. -
logger
protected final org.apache.commons.logging.Log logger
-
-
Constructor Details
-
OpenSessionInViewInterceptor
public OpenSessionInViewInterceptor()
-
-
Method Details
-
setSessionFactory
Set the Hibernate SessionFactory that should be used to create Hibernate Sessions. -
getSessionFactory
Return the Hibernate SessionFactory that should be used to create Hibernate Sessions. -
preHandle
public void preHandle(org.springframework.web.context.request.WebRequest request) throws org.springframework.dao.DataAccessException Open a new HibernateSession
according and bind it to the thread via theTransactionSynchronizationManager
.- Specified by:
preHandle
in interfaceorg.springframework.web.context.request.WebRequestInterceptor
- Throws:
org.springframework.dao.DataAccessException
-
postHandle
public void postHandle(org.springframework.web.context.request.WebRequest request, @Nullable org.springframework.ui.ModelMap model) - Specified by:
postHandle
in interfaceorg.springframework.web.context.request.WebRequestInterceptor
-
afterCompletion
public void afterCompletion(org.springframework.web.context.request.WebRequest request, @Nullable Exception ex) throws org.springframework.dao.DataAccessException Unbind the HibernateSession
from the thread and close it.- Specified by:
afterCompletion
in interfaceorg.springframework.web.context.request.WebRequestInterceptor
- Throws:
org.springframework.dao.DataAccessException
- See Also:
-
TransactionSynchronizationManager
-
afterConcurrentHandlingStarted
public void afterConcurrentHandlingStarted(org.springframework.web.context.request.WebRequest request) - Specified by:
afterConcurrentHandlingStarted
in interfaceorg.springframework.web.context.request.AsyncWebRequestInterceptor
-
openSession
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:
org.springframework.dao.DataAccessResourceFailureException
- if the Session could not be created- See Also:
-
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
.
-