Class OpenSessionInViewFilter
- All Implemented Interfaces:
Filter,Aware,BeanNameAware,DisposableBean,InitializingBean,EnvironmentAware,EnvironmentCapable,ServletContextAware
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.MANUAL. 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.MANUAL 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".
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe default bean name used for the session factory.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 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 SessionFactory to fetch from Spring's root application context.protected SessionFactoryLook up the SessionFactory that this filter should use.protected SessionFactorylookupSessionFactory(HttpServletRequest request) Look up the SessionFactory that this filter should use, taking the current HTTP request as argument.protected SessionopenSession(SessionFactory sessionFactory) Open a Session for the SessionFactory that this filter uses.voidsetSessionFactoryBeanName(String sessionFactoryBeanName) Set the bean name of the SessionFactory to fetch from Spring's root application context.protected booleanReturns "false" so that the filter may re-bind the opened HibernateSessionto each asynchronously dispatched thread and postpone closing it until the very last asynchronous dispatch.protected booleanReturns "false" so that the filter may provide a HibernateSessionto 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_SESSION_FACTORY_BEAN_NAME
The default bean name used for the session factory.- See Also:
-
-
Constructor Details
-
OpenSessionInViewFilter
public OpenSessionInViewFilter()
-
-
Method Details
-
setSessionFactoryBeanName
Set the bean name of the SessionFactory to fetch from Spring's root application context. Default is "sessionFactory".- See Also:
-
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 HibernateSessionto 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 a HibernateSessionto 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
-
lookupSessionFactory
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
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:
-
openSession
protected Session openSession(SessionFactory sessionFactory) throws DataAccessResourceFailureException Open a Session for the SessionFactory that this filter uses.The default implementation delegates to the
SessionFactory.openSession()method and sets theSession's flush mode to "MANUAL".- Parameters:
sessionFactory- the SessionFactory that this filter uses- Returns:
- the Session to use
- Throws:
DataAccessResourceFailureException- if the Session could not be created- See Also:
-