@Deprecated public class OpenSessionInViewFilter extends OncePerRequestFilter
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
or JtaTransactionManager
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.
If you intend to use this filter without transactions, consider changing
the default flush mode (through the "flushMode" property).
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.
Alternatively, turn this filter into deferred close mode, by specifying "singleSession"="false": It will not use a single session per request then, but rather let each data access operation or transaction use its own session (like without Open Session in View). Each of those sessions will be registered for deferred close, though, actually processed at request completion.
A single session per request allows for most efficient first-level caching,
but can cause side effects, for example on saveOrUpdate
or when
continuing after a rolled-back transaction. The deferred close strategy is as safe
as no Open Session in View in that respect, while still allowing for lazy loading
in views (but not providing a first-level cache for the entire request).
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".
setSingleSession(boolean)
,
setFlushMode(org.hibernate.FlushMode)
,
lookupSessionFactory(javax.servlet.http.HttpServletRequest)
,
OpenSessionInViewInterceptor
,
OpenSessionInterceptor
,
HibernateTransactionManager
,
SessionFactoryUtils.getSession(org.hibernate.SessionFactory, boolean)
,
TransactionSynchronizationManager
,
SessionFactory.getCurrentSession()
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SESSION_FACTORY_BEAN_NAME
Deprecated.
|
ALREADY_FILTERED_SUFFIX
logger
Constructor and Description |
---|
OpenSessionInViewFilter()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
protected void |
closeSession(Session session,
SessionFactory sessionFactory)
Deprecated.
Close the given Session.
|
protected void |
doFilterInternal(HttpServletRequest request,
HttpServletResponse response,
FilterChain filterChain)
Deprecated.
Same contract as for
doFilter , but guaranteed to be
just invoked once per request within a single request thread. |
protected FlushMode |
getFlushMode()
Deprecated.
Return the Hibernate FlushMode that this filter applies to its
Session (in single session mode). |
protected Session |
getSession(SessionFactory sessionFactory)
Deprecated.
Get a Session for the SessionFactory that this filter uses.
|
protected String |
getSessionFactoryBeanName()
Deprecated.
Return the bean name of the SessionFactory to fetch from Spring's
root application context.
|
protected boolean |
isSingleSession()
Deprecated.
Return whether to use a single session for each request.
|
protected SessionFactory |
lookupSessionFactory()
Deprecated.
Look up the SessionFactory that this filter should use.
|
protected SessionFactory |
lookupSessionFactory(HttpServletRequest request)
Deprecated.
Look up the SessionFactory that this filter should use,
taking the current HTTP request as argument.
|
void |
setFlushMode(FlushMode flushMode)
Deprecated.
Specify the Hibernate FlushMode to apply to this filter's
Session . |
void |
setSessionFactoryBeanName(String sessionFactoryBeanName)
Deprecated.
Set the bean name of the SessionFactory to fetch from Spring's
root application context.
|
void |
setSingleSession(boolean singleSession)
Deprecated.
Set whether to use a single session for each request.
|
protected boolean |
shouldNotFilterAsyncDispatch()
Deprecated.
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. |
protected boolean |
shouldNotFilterErrorDispatch()
Deprecated.
Returns "false" so that the filter may provide a Hibernate
Session to each error dispatches. |
doFilter, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter
addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext
public static final String DEFAULT_SESSION_FACTORY_BEAN_NAME
public void setSessionFactoryBeanName(String sessionFactoryBeanName)
DEFAULT_SESSION_FACTORY_BEAN_NAME
protected String getSessionFactoryBeanName()
public void setSingleSession(boolean singleSession)
If set to "false", each data access operation or transaction will use its own session (like without Open Session in View). Each of those sessions will be registered for deferred close, though, actually processed at request completion.
protected boolean isSingleSession()
public void setFlushMode(FlushMode flushMode)
Session
. Only applied in single session mode.
Can be populated with the corresponding constant name in XML bean definitions: e.g. "AUTO".
The default is "MANUAL". Specify "AUTO" if you intend to use this filter without service layer transactions.
protected FlushMode getFlushMode()
Session
(in single session mode).protected boolean shouldNotFilterAsyncDispatch()
Session
to each asynchronously dispatched thread and postpone
closing it until the very last asynchronous dispatch.shouldNotFilterAsyncDispatch
in class OncePerRequestFilter
protected boolean shouldNotFilterErrorDispatch()
Session
to each error dispatches.shouldNotFilterErrorDispatch
in class OncePerRequestFilter
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException
OncePerRequestFilter
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.
doFilterInternal
in class OncePerRequestFilter
ServletException
IOException
protected SessionFactory lookupSessionFactory(HttpServletRequest request)
The default implementation delegates to the lookupSessionFactory()
variant without arguments.
request
- the current requestprotected SessionFactory lookupSessionFactory()
The default implementation looks for a bean with the specified name in Spring's root application context.
getSessionFactoryBeanName()
protected Session getSession(SessionFactory sessionFactory) throws DataAccessResourceFailureException
The default implementation delegates to the
SessionFactoryUtils.getSession
method and
sets the Session
's flush mode to "MANUAL".
Can be overridden in subclasses for creating a Session with a custom entity interceptor or JDBC exception translator.
sessionFactory
- the SessionFactory that this filter usesDataAccessResourceFailureException
- if the Session could not be createdSessionFactoryUtils.getSession(SessionFactory, boolean)
,
FlushMode.MANUAL
protected void closeSession(Session session, SessionFactory sessionFactory)
Can be overridden in subclasses, e.g. for flushing the Session before closing it. See class-level javadoc for a discussion of flush handling. Note that you should also override getSession accordingly, to set the flush mode to something else than NEVER.
session
- the Session used for filteringsessionFactory
- the SessionFactory that this filter uses