Class OpenPersistenceManagerInViewFilter
- java.lang.Object
- org.springframework.web.filter.GenericFilterBean
- org.springframework.web.filter.OncePerRequestFilter
- org.springframework.orm.jdo.support.OpenPersistenceManagerInViewFilter
- All Implemented Interfaces:
Filter
,Aware
,BeanNameAware
,DisposableBean
,InitializingBean
,EnvironmentAware
,EnvironmentCapable
,ServletContextAware
public class OpenPersistenceManagerInViewFilter extends OncePerRequestFilter
Servlet Filter that binds a JDO PersistenceManager to the thread for the entire processing of the request. Intended for the "Open PersistenceManager in View" pattern, i.e. to allow for lazy loading in web views despite the original transactions already being completed.This filter makes JDO PersistenceManagers available via the current thread, which will be autodetected by transaction managers. It is suitable for service layer transactions via
JdoTransactionManager
orJtaTransactionManager
as well as for non-transactional read-only execution.Looks up the PersistenceManagerFactory in Spring's root web application context. Supports a "persistenceManagerFactoryBeanName" filter init-param in
web.xml
; the default bean name is "persistenceManagerFactory".
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_PERSISTENCE_MANAGER_FACTORY_BEAN_NAME
Fields inherited from class org.springframework.web.filter.OncePerRequestFilter
ALREADY_FILTERED_SUFFIX
Fields inherited from class org.springframework.web.filter.GenericFilterBean
logger
Constructor Summary
Constructors Constructor Description OpenPersistenceManagerInViewFilter()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
doFilterInternal(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 String
getPersistenceManagerFactoryBeanName()
Return the bean name of the PersistenceManagerFactory to fetch from Spring's root application context.protected javax.jdo.PersistenceManagerFactory
lookupPersistenceManagerFactory()
Look up the PersistenceManagerFactory that this filter should use.protected javax.jdo.PersistenceManagerFactory
lookupPersistenceManagerFactory(HttpServletRequest request)
Look up the PersistenceManagerFactory that this filter should use, taking the current HTTP request as argument.void
setPersistenceManagerFactoryBeanName(String persistenceManagerFactoryBeanName)
Set the bean name of the PersistenceManagerFactory to fetch from Spring's root application context.protected boolean
shouldNotFilterAsyncDispatch()
Returns "false" so that the filter may re-bind the openedPersistenceManager
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 anPersistenceManager
to each error dispatches.Methods inherited from class org.springframework.web.filter.OncePerRequestFilter
doFilter, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter
Methods inherited from class org.springframework.web.filter.GenericFilterBean
addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext
Field Detail
DEFAULT_PERSISTENCE_MANAGER_FACTORY_BEAN_NAME
public static final String DEFAULT_PERSISTENCE_MANAGER_FACTORY_BEAN_NAME
- See Also:
- Constant Field Values
Constructor Detail
OpenPersistenceManagerInViewFilter
public OpenPersistenceManagerInViewFilter()
Method Detail
setPersistenceManagerFactoryBeanName
public void setPersistenceManagerFactoryBeanName(String persistenceManagerFactoryBeanName)
Set the bean name of the PersistenceManagerFactory to fetch from Spring's root application context. Default is "persistenceManagerFactory".
getPersistenceManagerFactoryBeanName
protected String getPersistenceManagerFactoryBeanName()
Return the bean name of the PersistenceManagerFactory to fetch from Spring's root application context.
shouldNotFilterAsyncDispatch
protected boolean shouldNotFilterAsyncDispatch()
Returns "false" so that the filter may re-bind the openedPersistenceManager
to each asynchronously dispatched thread and postpone closing it until the very last asynchronous dispatch.- Overrides:
shouldNotFilterAsyncDispatch
in classOncePerRequestFilter
shouldNotFilterErrorDispatch
protected boolean shouldNotFilterErrorDispatch()
Returns "false" so that the filter may provide anPersistenceManager
to each error dispatches.- Overrides:
shouldNotFilterErrorDispatch
in classOncePerRequestFilter
doFilterInternal
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException
Description copied from class:OncePerRequestFilter
Same 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:
doFilterInternal
in classOncePerRequestFilter
- Throws:
ServletException
IOException
lookupPersistenceManagerFactory
protected javax.jdo.PersistenceManagerFactory lookupPersistenceManagerFactory(HttpServletRequest request)
Look up the PersistenceManagerFactory that this filter should use, taking the current HTTP request as argument.Default implementation delegates to the
lookupPersistenceManagerFactory
without arguments.- Returns:
- the PersistenceManagerFactory to use
- See Also:
lookupPersistenceManagerFactory()
lookupPersistenceManagerFactory
protected javax.jdo.PersistenceManagerFactory lookupPersistenceManagerFactory()
Look up the PersistenceManagerFactory that this filter should use. The default implementation looks for a bean with the specified name in Spring's root application context.- Returns:
- the PersistenceManagerFactory to use
- See Also:
getPersistenceManagerFactoryBeanName()