public class

OpenEntityManagerInViewInterceptor

extends EntityManagerFactoryAccessor
implements WebRequestInterceptor
java.lang.Object
   ↳ org.springframework.orm.jpa.EntityManagerFactoryAccessor
     ↳ org.springframework.orm.jpa.support.OpenEntityManagerInViewInterceptor

Class Overview

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 or JtaTransactionManager 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. It inherits common JPA configuration properties from JpaAccessor, to be configured in a bean definition.

Summary

Constants
String PARTICIPATE_SUFFIX Suffix that gets appended to the EntityManagerFactory toString representation for the "participate in existing entity manager handling" request attribute.
[Expand]
Inherited Fields
From class org.springframework.orm.jpa.EntityManagerFactoryAccessor
Public Constructors
OpenEntityManagerInViewInterceptor()
Public Methods
void afterCompletion(WebRequest request, Exception ex)
Callback after completion of request processing, that is, after rendering the view.
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.
Protected Methods
String getParticipateAttributeName()
Return the name of the request attribute that identifies that a request is already filtered.
[Expand]
Inherited Methods
From class org.springframework.orm.jpa.EntityManagerFactoryAccessor
From class java.lang.Object
From interface org.springframework.web.context.request.WebRequestInterceptor

Constants

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.

Constant Value: ".PARTICIPATE"

Public Constructors

public OpenEntityManagerInViewInterceptor ()

Public Methods

public void afterCompletion (WebRequest request, Exception ex)

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!

Parameters
request the current web request
ex exception thrown on handler execution, if any

public void postHandle (WebRequest request, ModelMap model)

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).

Parameters
request the current web request
model 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 preHandle (WebRequest request)

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.

Parameters
request the current web request

Protected Methods

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".