|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.orm.hibernate.HibernateAccessor org.springframework.orm.hibernate.support.OpenSessionInViewInterceptor
public class OpenSessionInViewInterceptor
Spring web HandlerInterceptor that binds a Hibernate Session to the thread for the entire processing of the request. Intended for the "Open Session in View" pattern, that is, to allow for lazy loading in web views despite the original transactions already being completed.
This interceptor works similar to the AOP HibernateInterceptor: It just makes Hibernate Sessions available via the thread. It is suitable for non-transactional execution but also for service layer transactions via HibernateTransactionManager or JtaTransactionManager. In the latter case, Sessions pre-bound by this interceptor will automatically be used for the transactions and flushed accordingly.
In contrast to OpenSessionInViewFilter, this interceptor is set up in a Spring application context and can thus take advantage of bean wiring. It derives from HibernateAccessor to inherit common Hibernate configuration properties.
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 will 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 (like without Open Session in View). Each of those sessions will be registered for deferred close, though, actually processed at request completion.
A single session per request allows for 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).
NOTE: This interceptor will by default not flush the Hibernate Session, as it assumes to be used in combination with service layer transactions that care for the flushing, or HibernateAccessors with "flushMode" FLUSH_EAGER. If you want this interceptor to flush after the handler has been invoked but before view rendering, set the "flushMode" of this interceptor to FLUSH_AUTO in such a scenario. Note that the "flushMode" of this interceptor will just apply in single session mode!
setSingleSession(boolean)
,
HibernateAccessor.setFlushMode(int)
,
OpenSessionInViewFilter
,
HibernateInterceptor
,
HibernateTransactionManager
,
SessionFactoryUtils.getSession(net.sf.hibernate.SessionFactory, boolean)
,
TransactionSynchronizationManager
Field Summary | |
---|---|
static String |
PARTICIPATE_SUFFIX
Suffix that gets appended to the SessionFactory toString representation for the "participate in existing session handling" request attribute. |
Fields inherited from class org.springframework.orm.hibernate.HibernateAccessor |
---|
FLUSH_AUTO, FLUSH_COMMIT, FLUSH_EAGER, FLUSH_NEVER, logger |
Constructor Summary | |
---|---|
OpenSessionInViewInterceptor()
Create a new OpenSessionInViewInterceptor, turning the default flushMode to FLUSH_NEVER. |
Method Summary | |
---|---|
void |
afterCompletion(WebRequest request,
Exception ex)
Unbind the Hibernate Session from the thread and closes it (in single session mode), or process deferred close for all sessions that have been opened during the current request (in deferred close mode). |
protected String |
getParticipateAttributeName()
Return the name of the request attribute that identifies that a request is already filtered. |
protected boolean |
isSingleSession()
Return whether to use a single session for each request. |
void |
postHandle(WebRequest request,
ModelMap model)
Flush the Hibernate Session before view rendering, if necessary. |
void |
preHandle(WebRequest request)
Open a new Hibernate Session according to the settings of this HibernateAccessor and binds in to the thread via TransactionSynchronizationManager. |
void |
setSingleSession(boolean singleSession)
Set whether to use a single session for each request. |
Methods inherited from class org.springframework.orm.hibernate.HibernateAccessor |
---|
afterPropertiesSet, applyFlushMode, convertHibernateAccessException, convertJdbcAccessException, convertJdbcAccessException, flushIfNecessary, getEntityInterceptor, getFlushMode, getJdbcExceptionTranslator, getSessionFactory, setBeanFactory, setEntityInterceptor, setEntityInterceptorBeanName, setFlushMode, setFlushModeName, setJdbcExceptionTranslator, setSessionFactory |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String PARTICIPATE_SUFFIX
getParticipateAttributeName()
,
Constant Field ValuesConstructor Detail |
---|
public OpenSessionInViewInterceptor()
HibernateAccessor.setFlushMode(int)
Method Detail |
---|
public void setSingleSession(boolean singleSession)
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.
SessionFactoryUtils.initDeferredClose(net.sf.hibernate.SessionFactory)
,
SessionFactoryUtils.processDeferredClose(net.sf.hibernate.SessionFactory)
protected boolean isSingleSession()
public void preHandle(WebRequest request) throws DataAccessException
preHandle
in interface WebRequestInterceptor
request
- the current web request
DataAccessException
SessionFactoryUtils.getSession(net.sf.hibernate.SessionFactory, boolean)
,
TransactionSynchronizationManager
public void postHandle(WebRequest request, ModelMap model) throws DataAccessException
The default is FLUSH_NEVER to avoid this extra flushing, assuming that service layer transactions have flushed their changes on commit.
postHandle
in interface WebRequestInterceptor
request
- 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.
DataAccessException
HibernateAccessor.setFlushMode(int)
public void afterCompletion(WebRequest request, Exception ex) throws DataAccessException
afterCompletion
in interface WebRequestInterceptor
request
- the current web requestex
- exception thrown on handler execution, if any
DataAccessException
TransactionSynchronizationManager
protected String getParticipateAttributeName()
PARTICIPATE_SUFFIX
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |