Class OpenEntityManagerInViewFilter
- All Implemented Interfaces:
Filter,Aware,BeanNameAware,DisposableBean,InitializingBean,EnvironmentAware,EnvironmentCapable,ServletContextAware
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).
- Since:
- 2.0
- Author:
- Juergen Hoeller
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDefault EntityManagerFactory bean name: "entityManagerFactory".Fields inherited from class org.springframework.web.filter.OncePerRequestFilter
ALREADY_FILTERED_SUFFIXFields inherited from class org.springframework.web.filter.GenericFilterBean
logger -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected EntityManagerCreate a JPA EntityManager to be bound to a request.protected voiddoFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) Same contract as fordoFilter, but guaranteed to be just invoked once per request within a single request thread.protected StringReturn the bean name of the EntityManagerFactory to fetch from Spring's root application context.protected StringReturn the name of the persistence unit to access the EntityManagerFactory for, if any.protected EntityManagerFactoryLook up the EntityManagerFactory that this filter should use.protected EntityManagerFactoryLook up the EntityManagerFactory that this filter should use, taking the current HTTP request as argument.voidsetEntityManagerFactoryBeanName(String entityManagerFactoryBeanName) Set the bean name of the EntityManagerFactory to fetch from Spring's root application context.voidsetPersistenceUnitName(String persistenceUnitName) Set the name of the persistence unit to access the EntityManagerFactory for.protected booleanReturns "false" so that the filter may re-bind the openedEntityManagerto each asynchronously dispatched thread and postpone closing it until the very last asynchronous dispatch.protected booleanReturns "false" so that the filter may provide anEntityManagerto each error dispatches.Methods inherited from class org.springframework.web.filter.OncePerRequestFilter
doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilterMethods inherited from class org.springframework.web.filter.GenericFilterBean
addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext
-
Field Details
-
DEFAULT_ENTITY_MANAGER_FACTORY_BEAN_NAME
Default EntityManagerFactory bean name: "entityManagerFactory". Only applies when no "persistenceUnitName" param has been specified.
-
-
Constructor Details
-
OpenEntityManagerInViewFilter
public OpenEntityManagerInViewFilter()
-
-
Method Details
-
setEntityManagerFactoryBeanName
Set the bean name of the EntityManagerFactory to fetch from Spring's root application context.Default is "entityManagerFactory". Note that this default only applies when no "persistenceUnitName" param has been specified.
-
getEntityManagerFactoryBeanName
Return the bean name of the EntityManagerFactory to fetch from Spring's root application context. -
setPersistenceUnitName
Set the name of the persistence unit to access the EntityManagerFactory for.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.
-
getPersistenceUnitName
Return the name of the persistence unit to access the EntityManagerFactory for, if any. -
shouldNotFilterAsyncDispatch
protected boolean shouldNotFilterAsyncDispatch()Returns "false" so that the filter may re-bind the openedEntityManagerto each asynchronously dispatched thread and postpone closing it until the very last asynchronous dispatch.- Overrides:
shouldNotFilterAsyncDispatchin classOncePerRequestFilter
-
shouldNotFilterErrorDispatch
protected boolean shouldNotFilterErrorDispatch()Returns "false" so that the filter may provide anEntityManagerto each error dispatches.- Overrides:
shouldNotFilterErrorDispatchin classOncePerRequestFilter
-
doFilterInternal
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException Description copied from class:OncePerRequestFilterSame contract as fordoFilter, but guaranteed to be just invoked once per request within a single request thread. SeeOncePerRequestFilter.shouldNotFilterAsyncDispatch()for details.Provides HttpServletRequest and HttpServletResponse arguments instead of the default ServletRequest and ServletResponse ones.
- Specified by:
doFilterInternalin classOncePerRequestFilter- Throws:
ServletExceptionIOException
-
lookupEntityManagerFactory
Look up the EntityManagerFactory that this filter should use, taking the current HTTP request as argument.The default implementation delegates to the
lookupEntityManagerFactorywithout arguments, caching the EntityManagerFactory reference once obtained.- Returns:
- the EntityManagerFactory to use
- See Also:
-
lookupEntityManagerFactory
Look up the EntityManagerFactory that this filter should use.The default implementation looks for a bean with the specified name in Spring's root application context.
- Returns:
- the EntityManagerFactory to use
- See Also:
-
createEntityManager
Create a JPA EntityManager to be bound to a request.Can be overridden in subclasses.
- Parameters:
emf- the EntityManagerFactory to use- See Also:
-