public class OpenEntityManagerInViewFilter extends OncePerRequestFilter
This filter 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.
Looks up the EntityManagerFactory in Spring's root web application context.
Supports an "entityManagerFactoryBeanName" filter init-param in web.xml
;
the default bean name is "entityManagerFactory". As an alternative, the
"persistenceUnitName" init-param allows for retrieval by logical unit name
(as specified in persistence.xml
).
OpenEntityManagerInViewInterceptor
,
JpaTransactionManager
,
SharedEntityManagerCreator
,
TransactionSynchronizationManager
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_ENTITY_MANAGER_FACTORY_BEAN_NAME
Default EntityManagerFactory bean name: "entityManagerFactory".
|
ALREADY_FILTERED_SUFFIX
logger
Constructor and Description |
---|
OpenEntityManagerInViewFilter() |
Modifier and Type | Method and Description |
---|---|
protected EntityManager |
createEntityManager(EntityManagerFactory emf)
Create a JPA EntityManager to be bound to a request.
|
protected void |
doFilterInternal(HttpServletRequest request,
HttpServletResponse response,
FilterChain filterChain)
Same contract as for
doFilter , but guaranteed to be
just invoked once per request within a single request thread. |
protected String |
getEntityManagerFactoryBeanName()
Return the bean name of the EntityManagerFactory to fetch from Spring's
root application context.
|
protected String |
getPersistenceUnitName()
Return the name of the persistence unit to access the EntityManagerFactory for, if any.
|
protected EntityManagerFactory |
lookupEntityManagerFactory()
Look up the EntityManagerFactory that this filter should use.
|
protected EntityManagerFactory |
lookupEntityManagerFactory(HttpServletRequest request)
Look up the EntityManagerFactory that this filter should use,
taking the current HTTP request as argument.
|
void |
setEntityManagerFactoryBeanName(String entityManagerFactoryBeanName)
Set the bean name of the EntityManagerFactory to fetch from Spring's
root application context.
|
void |
setPersistenceUnitName(String persistenceUnitName)
Set the name of the persistence unit to access the EntityManagerFactory for.
|
protected boolean |
shouldNotFilterAsyncDispatch()
Returns "false" so that the filter may re-bind the opened
EntityManager
to each asynchronously dispatched thread and postpone closing it until the very
last asynchronous dispatch. |
protected boolean |
shouldNotFilterErrorDispatch()
Returns "false" so that the filter may provide an
EntityManager
to each error dispatches. |
doFilter, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter
addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext
public static final String DEFAULT_ENTITY_MANAGER_FACTORY_BEAN_NAME
public void setEntityManagerFactoryBeanName(String entityManagerFactoryBeanName)
Default is "entityManagerFactory". Note that this default only applies when no "persistenceUnitName" param has been specified.
protected String getEntityManagerFactoryBeanName()
public void setPersistenceUnitName(String persistenceUnitName)
This is an alternative to specifying the EntityManagerFactory by bean name, resolving it by its persistence unit name instead. If no bean name and no persistence unit name have been specified, we'll check whether a bean exists for the default bean name "entityManagerFactory"; if not, a default EntityManagerFactory will be retrieved through finding a single unique bean of type EntityManagerFactory.
protected String getPersistenceUnitName()
protected boolean shouldNotFilterAsyncDispatch()
EntityManager
to each asynchronously dispatched thread and postpone closing it until the very
last asynchronous dispatch.shouldNotFilterAsyncDispatch
in class OncePerRequestFilter
protected boolean shouldNotFilterErrorDispatch()
EntityManager
to each error dispatches.shouldNotFilterErrorDispatch
in class OncePerRequestFilter
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException
OncePerRequestFilter
doFilter
, but guaranteed to be
just invoked once per request within a single request thread.
See OncePerRequestFilter.shouldNotFilterAsyncDispatch()
for details.
Provides HttpServletRequest and HttpServletResponse arguments instead of the default ServletRequest and ServletResponse ones.
doFilterInternal
in class OncePerRequestFilter
ServletException
IOException
protected EntityManagerFactory lookupEntityManagerFactory(HttpServletRequest request)
The default implementation delegates to the lookupEntityManagerFactory
without arguments, caching the EntityManagerFactory reference once obtained.
lookupEntityManagerFactory()
protected EntityManagerFactory lookupEntityManagerFactory()
The default implementation looks for a bean with the specified name in Spring's root application context.
getEntityManagerFactoryBeanName()
protected EntityManager createEntityManager(EntityManagerFactory emf)
Can be overridden in subclasses.
emf
- the EntityManagerFactory to useEntityManagerFactory.createEntityManager()