org.springframework.orm.hibernate5.support

Class OpenSessionInViewFilter

  • All Implemented Interfaces:
    Filter, Aware, BeanNameAware, DisposableBean, InitializingBean, EnvironmentAware, EnvironmentCapable, ServletContextAware


    public class OpenSessionInViewFilter
    extends OncePerRequestFilter
    Servlet Filter that binds a Hibernate Session to the thread for the entire processing of the request. Intended for the "Open Session in View" pattern, i.e. to allow for lazy loading in web views despite the original transactions already being completed.

    This filter makes Hibernate Sessions available via the current thread, which will be autodetected by transaction managers. It is suitable for service layer transactions via HibernateTransactionManager as well as for non-transactional execution (if configured appropriately).

    NOTE: This filter will by default not flush the Hibernate Session, with the flush mode set to FlushMode.NEVER. It assumes to be used in combination with service layer transactions that care for the flushing: The active transaction manager will temporarily change the flush mode to FlushMode.AUTO during a read-write transaction, with the flush mode reset to FlushMode.NEVER at the end of each transaction.

    WARNING: Applying this filter to existing logic can cause issues that have not appeared before, through the use of a single Hibernate Session for the processing of an entire request. In particular, the reassociation of persistent objects with a Hibernate Session has to occur at the very beginning of request processing, to avoid clashes with already loaded instances of the same objects.

    Looks up the SessionFactory in Spring's root web application context. Supports a "sessionFactoryBeanName" filter init-param in web.xml; the default bean name is "sessionFactory".

    Since:
    4.2
    Author:
    Juergen Hoeller
    See Also:
    lookupSessionFactory(javax.servlet.http.HttpServletRequest), OpenSessionInViewInterceptor, OpenSessionInterceptor, HibernateTransactionManager, TransactionSynchronizationManager, SessionFactory.getCurrentSession()
    • Field Detail

      • DEFAULT_SESSION_FACTORY_BEAN_NAME

        public static final java.lang.String DEFAULT_SESSION_FACTORY_BEAN_NAME
        The default bean name used for the session factory.
        See Also:
        Constant Field Values
    • Constructor Detail

      • OpenSessionInViewFilter

        public OpenSessionInViewFilter()
    • Method Detail

      • setSessionFactoryBeanName

        public void setSessionFactoryBeanName(java.lang.String sessionFactoryBeanName)
        Set the bean name of the SessionFactory to fetch from Spring's root application context. Default is "sessionFactory".
        See Also:
        DEFAULT_SESSION_FACTORY_BEAN_NAME
      • getSessionFactoryBeanName

        protected java.lang.String getSessionFactoryBeanName()
        Return the bean name of the SessionFactory to fetch from Spring's root application context.
      • shouldNotFilterAsyncDispatch

        protected boolean shouldNotFilterAsyncDispatch()
        Returns "false" so that the filter may re-bind the opened Hibernate Session 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 a Hibernate Session to each error dispatches.
        Overrides:
        shouldNotFilterErrorDispatch in class OncePerRequestFilter
      • lookupSessionFactory

        protected SessionFactory lookupSessionFactory(HttpServletRequest request)
        Look up the SessionFactory that this filter should use, taking the current HTTP request as argument.

        The default implementation delegates to the lookupSessionFactory() variant without arguments.

        Parameters:
        request - the current request
        Returns:
        the SessionFactory to use
      • lookupSessionFactory

        protected SessionFactory lookupSessionFactory()
        Look up the SessionFactory that this filter should use.

        The default implementation looks for a bean with the specified name in Spring's root application context.

        Returns:
        the SessionFactory to use
        See Also:
        getSessionFactoryBeanName()