org.springframework.orm.jdo.support

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, 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 or JtaTransactionManager 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".

Since:

1.1

Author:

Juergen Hoeller

See Also:

OpenPersistenceManagerInViewInterceptor, JdoTransactionManager, PersistenceManagerFactoryUtils.getPersistenceManager(javax.jdo.PersistenceManagerFactory, boolean), TransactionSynchronizationManager

Field Summary

Fields

Modifier and Type	Field and 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 and Description
OpenPersistenceManagerInViewFilter()

Method Summary

Modifier and Type	Method and Description
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	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 opened PersistenceManager 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 PersistenceManager 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, destroy, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

See Also:

DEFAULT_PERSISTENCE_MANAGER_FACTORY_BEAN_NAME

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 opened PersistenceManager to each asynchronously dispatched thread and postpone closing it until the very last asynchronous dispatch.

Overrides:

shouldNotFilterAsyncDispatch in class OncePerRequestFilter

shouldNotFilterErrorDispatch

protected boolean shouldNotFilterErrorDispatch()

Returns "false" so that the filter may provide an PersistenceManager to each error dispatches.

Overrides:

shouldNotFilterErrorDispatch in class OncePerRequestFilter

doFilterInternal

protected void doFilterInternal(HttpServletRequest request,
                                HttpServletResponse response,
                                FilterChain filterChain)
                         throws ServletException,
                                IOException

Description copied from class: OncePerRequestFilter

Same contract as for 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.

Specified by:

doFilterInternal in class OncePerRequestFilter

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