Class OpenEntityManagerInViewInterceptor
- java.lang.Object
- org.springframework.orm.jpa.EntityManagerFactoryAccessor
- org.springframework.orm.jpa.support.OpenEntityManagerInViewInterceptor
- All Implemented Interfaces:
Aware
,BeanFactoryAware
,AsyncWebRequestInterceptor
,WebRequestInterceptor
public class OpenEntityManagerInViewInterceptor extends EntityManagerFactoryAccessor implements AsyncWebRequestInterceptor
Spring web request interceptor that binds a JPA EntityManager to the thread for the entire processing of the request. Intended for the "Open EntityManager in View" pattern, i.e. to allow for lazy loading in web views despite the original transactions already being completed.This interceptor makes JPA EntityManagers available via the current thread, which will be autodetected by transaction managers. It is suitable for service layer transactions via
JpaTransactionManager
orJtaTransactionManager
as well as for non-transactional read-only execution.In contrast to
OpenEntityManagerInViewFilter
, this interceptor is set up in a Spring application context and can thus take advantage of bean wiring.- Since:
- 2.0
- Author:
- Juergen Hoeller
- See Also:
OpenEntityManagerInViewFilter
,JpaTransactionManager
,SharedEntityManagerCreator
,TransactionSynchronizationManager
Field Summary
Fields Modifier and Type Field Description static String
PARTICIPATE_SUFFIX
Suffix that gets appended to the EntityManagerFactory toString representation for the "participate in existing entity manager handling" request attribute.Fields inherited from class org.springframework.orm.jpa.EntityManagerFactoryAccessor
logger
Constructor Summary
Constructors Constructor Description OpenEntityManagerInViewInterceptor()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
afterCompletion(WebRequest request, Exception ex)
Callback after completion of request processing, that is, after rendering the view.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 filtered.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)
Intercept the execution of a request handler before its invocation.Methods inherited from class org.springframework.orm.jpa.EntityManagerFactoryAccessor
createEntityManager, getEntityManagerFactory, getJpaPropertyMap, getPersistenceUnitName, getTransactionalEntityManager, setBeanFactory, setEntityManagerFactory, setJpaProperties, setJpaPropertyMap, setPersistenceUnitName
Field Detail
PARTICIPATE_SUFFIX
public static final String PARTICIPATE_SUFFIX
Suffix that gets appended to the EntityManagerFactory toString representation for the "participate in existing entity manager handling" request attribute.
Constructor Detail
OpenEntityManagerInViewInterceptor
public OpenEntityManagerInViewInterceptor()
Method Detail
preHandle
public void preHandle(WebRequest request) throws DataAccessException
Description copied from interface:WebRequestInterceptor
Intercept the execution of a request handler before its invocation.Allows for preparing context resources (such as a Hibernate Session) and expose them as request attributes or as thread-local objects.
- 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
Description copied from interface:WebRequestInterceptor
Callback after completion of request processing, that is, after rendering the view. Will be called on any outcome of handler execution, thus allows for proper resource cleanup.Note: Will only be called if this interceptor's
preHandle
method has successfully completed!- Specified by:
afterCompletion
in interfaceWebRequestInterceptor
- Parameters:
request
- the current web requestex
- exception thrown on handler execution, if any- Throws:
DataAccessException
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
getParticipateAttributeName
protected String getParticipateAttributeName()
Return the name of the request attribute that identifies that a request is already filtered. Default implementation takes the toString representation of the EntityManagerFactory instance and appends ".FILTERED".- See Also:
PARTICIPATE_SUFFIX