spring-framework / org.springframework.orm.hibernate5.support / OpenSessionInViewInterceptor

OpenSessionInViewInterceptor

open class OpenSessionInViewInterceptor : AsyncWebRequestInterceptor

Spring web request interceptor that binds a Hibernate Session to the thread for the entire processing of the request.

This class is a concrete expression of the "Open Session in View" pattern, which is a pattern that allows for the lazy loading of associations in web views despite the original transactions already being completed.

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

In contrast to OpenSessionInViewFilter, this interceptor is configured in a Spring application context and can thus take advantage of bean wiring.

WARNING: Applying this interceptor 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.

Author
Juergen Hoeller

Since
4.2

See Also
OpenSessionInViewFilterOpenSessionInterceptororg.springframework.orm.hibernate5.HibernateTransactionManagerTransactionSynchronizationManagerSessionFactory#getCurrentSession()

Constructors

<init>

OpenSessionInViewInterceptor()

Spring web request interceptor that binds a Hibernate Session to the thread for the entire processing of the request.

This class is a concrete expression of the "Open Session in View" pattern, which is a pattern that allows for the lazy loading of associations in web views despite the original transactions already being completed.

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

In contrast to OpenSessionInViewFilter, this interceptor is configured in a Spring application context and can thus take advantage of bean wiring.

WARNING: Applying this interceptor 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.

Properties

PARTICIPATE_SUFFIX

static val PARTICIPATE_SUFFIX: String

Suffix that gets appended to the SessionFactory toString() representation for the "participate in existing session handling" request attribute.

Functions

afterCompletion

open fun afterCompletion(request: WebRequest, ex: Exception): Unit

Unbind the Hibernate Session from the thread and close it).

afterConcurrentHandlingStarted

open fun afterConcurrentHandlingStarted(request: WebRequest): Unit

getSessionFactory

open fun getSessionFactory(): SessionFactory

Return the Hibernate SessionFactory that should be used to create Hibernate Sessions.

postHandle

open fun postHandle(request: WebRequest, model: ModelMap): Unit

preHandle

open fun preHandle(request: WebRequest): Unit

Open a new Hibernate Session according and bind it to the thread via the TransactionSynchronizationManager.

setSessionFactory

open fun setSessionFactory(sessionFactory: SessionFactory): Unit

Set the Hibernate SessionFactory that should be used to create Hibernate Sessions.