public class OpenSessionInViewInterceptor extends Object implements AsyncWebRequestInterceptor
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.
OpenSessionInViewFilter,
OpenSessionInterceptor,
HibernateTransactionManager,
TransactionSynchronizationManager,
SessionFactory.getCurrentSession()| Modifier and Type | Field and Description |
|---|---|
protected Log |
logger |
static String |
PARTICIPATE_SUFFIX
Suffix that gets appended to the
SessionFactory
toString() representation for the "participate in existing
session handling" request attribute. |
| Constructor and Description |
|---|
OpenSessionInViewInterceptor() |
| Modifier and Type | Method and Description |
|---|---|
void |
afterCompletion(WebRequest request,
Exception ex)
Unbind the Hibernate
Session from the thread and close it). |
void |
afterConcurrentHandlingStarted(WebRequest request)
Called instead of
postHandle and afterCompletion, 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 Hibernate
Session according and bind it to the thread via the
TransactionSynchronizationManager. |
void |
setSessionFactory(SessionFactory sessionFactory)
Set the Hibernate SessionFactory that should be used to create Hibernate Sessions.
|
public static final String PARTICIPATE_SUFFIX
SessionFactory
toString() representation for the "participate in existing
session handling" request attribute.protected final Log logger
public void setSessionFactory(SessionFactory sessionFactory)
public SessionFactory getSessionFactory()
public void preHandle(WebRequest request) throws DataAccessException
Session according and bind it to the thread via the
TransactionSynchronizationManager.preHandle in interface WebRequestInterceptorrequest - the current web requestDataAccessExceptionpublic void postHandle(WebRequest request, ModelMap model)
WebRequestInterceptorAllows for modifying context resources after successful handler execution (for example, flushing a Hibernate Session).
postHandle in interface WebRequestInterceptorrequest - the current web requestmodel - the map of model objects that will be exposed to the view
(may be null). Can be used to analyze the exposed model
and/or to add further model attributes, if desired.public void afterCompletion(WebRequest request, Exception ex) throws DataAccessException
Session from the thread and close it).afterCompletion in interface WebRequestInterceptorrequest - the current web requestex - exception thrown on handler execution, if anyDataAccessExceptionTransactionSynchronizationManagerpublic void afterConcurrentHandlingStarted(WebRequest request)
AsyncWebRequestInterceptorpostHandle and afterCompletion, when the
the handler started handling the request concurrently.afterConcurrentHandlingStarted in interface AsyncWebRequestInterceptorrequest - the current requestprotected Session openSession() throws DataAccessResourceFailureException
The default implementation delegates to the SessionFactory.openSession()
method and sets the Session's flush mode to "MANUAL".
DataAccessResourceFailureException - if the Session could not be createdFlushMode.MANUALprotected String getParticipateAttributeName()
The default implementation takes the toString() representation
of the SessionFactory instance and appends PARTICIPATE_SUFFIX.