A org.hibernate.context.spi.CurrentSessionContext impl which scopes the notion of current session by the current thread of execution. Unlike the JTA counterpart, threads do not give us a nice hook to perform any type of cleanup making it questionable for this impl to actually generate Session instances. In the interest of usability, it was decided to have this default impl actually generate a session upon first request and then clean it up after the Transaction associated with that session is committed/rolled-back. In order for ensuring that happens, the sessions generated here are unusable until after Session#beginTransaction() has been called. If close() is called on a session managed by this class, it will be automatically unbound.

Additionally, the static bind and unbind methods are provided to allow application code to explicitly control opening and closing of these sessions. This, with some from of interception, is the preferred approach. It also allows easy framework integration and one possible approach for implementing long-sessions.

The buildOrObtainSession, isAutoCloseEnabled, isAutoFlushEnabled, getConnectionHandlingMode, and buildCleanupSynch methods are all provided to allow easy subclassing (for long-running session scenarios, for example).

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected static class	ThreadLocalSessionContext.CleanupSync Transaction sync used for cleanup of the internal session map.
private class	ThreadLocalSessionContext.TransactionProtectionWrapper

Field Summary

Modifier and Type	Field and Description
private static final ThreadLocal<Map<SessionFactory, Session>>	CONTEXT_TL A ThreadLocal maintaining current sessions for the given execution thread.
private static final CoreMessageLogger	LOG
private static final Class<?>[]	SESSION_PROXY_INTERFACES

Access	Constructor and Description
public	ThreadLocalSessionContext(SessionFactoryImplementor The factory this context will service factory) Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. Constructs a ThreadLocal

Method Summary

Modifier and Type	Method and Description
public static void	bind(Session The session to bind. session) Associates the given session with the current thread of execution.
protected ThreadLocalSessionContext.CleanupSync	buildCleanupSynch()
protected Session	Returns: the built or (re)obtained session. buildOrObtainSession() Strictly provided for sub-classing purposes; specifically to allow long-session support.
public final Session	currentSession() Implements org.hibernate.context.spi.CurrentSessionContext.currentSession. Retrieve the current session according to the scoping defined by this implementation.
private static void	doBind(Session session, SessionFactory factory)
private static Session	doUnbind(SessionFactory factory)
private static Session	existingSession(SessionFactory factory)
protected PhysicalConnectionHandlingMode	Returns: The connection release mode for any built sessions. getConnectionHandlingMode() Mainly for subclass usage.
protected SessionFactoryImplementor	Returns: Value for property 'factory'. getFactory() Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. Getter for property 'factory'.
protected boolean	Returns: Whether the session should be closed by transaction completion. isAutoCloseEnabled() Mainly for subclass usage.
protected boolean	Returns: Whether the session should be flushed prior to transaction completion. isAutoFlushEnabled() Mainly for subclass usage.
private boolean	needsWrapping(Session session)
protected static Map<SessionFactory, Session>	sessionMap()
private static void	terminateOrphanedSession(Session orphan)
public static Session	Returns: The session which was unbound. unbind(SessionFactory The factory for which the session should be unbound. factory) Disassociates a previously bound session from the current thread of execution.
protected Session	wrap(Session session)

Inherited from org.hibernate.context.spi.AbstractCurrentSessionContext:: baseSessionBuilder factory validateExistingSession

Field Detail

CONTEXT_TL	back to summary
private static final ThreadLocal<Map<SessionFactory, Session>> CONTEXT_TL A ThreadLocal maintaining current sessions for the given execution thread. The actual ThreadLocal variable is a java.util.Map to account for the possibility for multiple SessionFactory instances being used during execution of the given thread.

LOG	back to summary
private static final CoreMessageLogger LOG

SESSION_PROXY_INTERFACES	back to summary
private static final Class<?>[] SESSION_PROXY_INTERFACES

ThreadLocalSessionContext	back to summary
public ThreadLocalSessionContext(SessionFactoryImplementor factory) Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. See corresponding docs for further information. Constructs a ThreadLocal Parameters factory:SessionFactoryImplementor The factory this context will service

Method Detail

bind	back to summary
public static void bind(Session session) Associates the given session with the current thread of execution. Parameters session:Session The session to bind.

bind

back to summary

public static void bind(Session session)

Associates the given session with the current thread of execution.

Parameters

session:Session: The session to bind.

buildCleanupSynch	back to summary
protected ThreadLocalSessionContext.CleanupSync buildCleanupSynch()

buildOrObtainSession	back to summary
protected Session buildOrObtainSession() Strictly provided for sub-classing purposes; specifically to allow long-session support. This implementation always just opens a new session. Returns:Session the built or (re)obtained session.

buildOrObtainSession

back to summary

protected Session buildOrObtainSession()

Strictly provided for sub-classing purposes; specifically to allow long-session support.

This implementation always just opens a new session.

Returns:Session: the built or (re)obtained session.

currentSession	back to summary
public final Session currentSession() throws HibernateException Implements org.hibernate.context.spi.CurrentSessionContext.currentSession. Doc from org.hibernate.context.spi.CurrentSessionContext.currentSession. Retrieve the current session according to the scoping defined by this implementation. Returns:Session The current session. Annotations @Override Exceptions HibernateException: Typically indicates an issue locating or creating the current session.

currentSession

back to summary

public final Session currentSession() throws HibernateException

Implements org.hibernate.context.spi.CurrentSessionContext.currentSession.

Doc from org.hibernate.context.spi.CurrentSessionContext.currentSession.

Retrieve the current session according to the scoping defined by this implementation.

Returns:Session

The current session.

Annotations

@Override

Exceptions

HibernateException:: Typically indicates an issue locating or creating the current session.

doBind	back to summary
private static void doBind(Session session, SessionFactory factory)

doUnbind	back to summary
private static Session doUnbind(SessionFactory factory)

existingSession	back to summary
private static Session existingSession(SessionFactory factory)

getConnectionHandlingMode	back to summary
protected PhysicalConnectionHandlingMode getConnectionHandlingMode() Mainly for subclass usage. This impl always returns after_transaction. Returns:PhysicalConnectionHandlingMode The connection release mode for any built sessions.

getConnectionHandlingMode

back to summary

protected PhysicalConnectionHandlingMode getConnectionHandlingMode()

Mainly for subclass usage. This impl always returns after_transaction.

Returns:PhysicalConnectionHandlingMode: The connection release mode for any built sessions.

getFactory back to summary

getFactory	back to summary
protected SessionFactoryImplementor getFactory() Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. See corresponding docs for further information. Getter for property 'factory'. Returns:SessionFactoryImplementor Value for property 'factory'.

protected SessionFactoryImplementor getFactory()

Deprecated

as a consequence of SessionFactoryImplementor being deprecated. See corresponding docs for further information.

Getter for property 'factory'.

Returns:SessionFactoryImplementor: Value for property 'factory'.

isAutoCloseEnabled	back to summary
protected boolean isAutoCloseEnabled() Mainly for subclass usage. This impl always returns true. Returns:boolean Whether the session should be closed by transaction completion.

isAutoCloseEnabled

back to summary

protected boolean isAutoCloseEnabled()

Mainly for subclass usage. This impl always returns true.

Returns:boolean: Whether the session should be closed by transaction completion.

isAutoFlushEnabled	back to summary
protected boolean isAutoFlushEnabled() Mainly for subclass usage. This impl always returns true. Returns:boolean Whether the session should be flushed prior to transaction completion.

isAutoFlushEnabled

back to summary

protected boolean isAutoFlushEnabled()

Mainly for subclass usage. This impl always returns true.

Returns:boolean: Whether the session should be flushed prior to transaction completion.

needsWrapping	back to summary
private boolean needsWrapping(Session session)

sessionMap	back to summary
protected static Map<SessionFactory, Session> sessionMap()

terminateOrphanedSession	back to summary
private static void terminateOrphanedSession(Session orphan)

unbind	back to summary
public static Session unbind(SessionFactory factory) Disassociates a previously bound session from the current thread of execution. Parameters factory:SessionFactory The factory for which the session should be unbound. Returns:Session The session which was unbound.

unbind

back to summary

public static Session unbind(SessionFactory factory)

Disassociates a previously bound session from the current thread of execution.

Parameters

factory:SessionFactory: The factory for which the session should be unbound.

Returns:Session

The session which was unbound.

wrap	back to summary
protected Session wrap(Session session)

org.hibernate.context.internal back to summary

protected Class ThreadLocalSessionContext.CleanupSync

Class Inheritance

extends Object
implements Synchronization, Serializable

java.lang.Object
org.hibernate.context.internal.ThreadLocalSessionContext.CleanupSync

All Implemented Interfaces

java.io.Serializable, jakarta.transaction.Synchronization

Transaction sync used for cleanup of the internal session map.

Field Summary

Modifier and Type	Field and Description
protected final SessionFactory	factory

Constructor Summary

Access	Constructor and Description
public	CleanupSync(SessionFactory factory)

Method Summary

Modifier and Type	Method and Description
public void	afterCompletion(int The status of the transaction completion. i) Implements jakarta.transaction.Synchronization.afterCompletion. This method is called by the transaction manager after the transaction is committed or rolled back.
public void	beforeCompletion() Implements jakarta.transaction.Synchronization.beforeCompletion. The beforeCompletion method is called by the transaction manager prior to the start of the two-phase transaction commit process.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

factory	back to summary
protected final SessionFactory factory

Constructor Detail

CleanupSync	back to summary
public CleanupSync(SessionFactory factory)

Method Detail

afterCompletion	back to summary
public void afterCompletion(int i) Implements jakarta.transaction.Synchronization.afterCompletion. Doc from jakarta.transaction.Synchronization.afterCompletion. This method is called by the transaction manager after the transaction is committed or rolled back. Parameters i:int The status of the transaction completion. Annotations @Override

afterCompletion

back to summary

public void afterCompletion(int i)

Implements jakarta.transaction.Synchronization.afterCompletion.

Doc from jakarta.transaction.Synchronization.afterCompletion.

This method is called by the transaction manager after the transaction is committed or rolled back.

Parameters

i:int: The status of the transaction completion.

Annotations

@Override

beforeCompletion	back to summary
public void beforeCompletion() Implements jakarta.transaction.Synchronization.beforeCompletion. Doc from jakarta.transaction.Synchronization.beforeCompletion. The beforeCompletion method is called by the transaction manager prior to the start of the two-phase transaction commit process. This call is executed with the transaction context of the transaction that is being committed. Annotations @Override

beforeCompletion

back to summary

public void beforeCompletion()

Implements jakarta.transaction.Synchronization.beforeCompletion.

Doc from jakarta.transaction.Synchronization.beforeCompletion.

The beforeCompletion method is called by the transaction manager prior to the start of the two-phase transaction commit process. This call is executed with the transaction context of the transaction that is being committed.

Annotations

@Override

org.hibernate.context.internal back to summary

private Class ThreadLocalSessionContext.TransactionProtectionWrapper

Class Inheritance

extends Object
implements InvocationHandler, Serializable

java.lang.Object
org.hibernate.context.internal.ThreadLocalSessionContext.TransactionProtectionWrapper

All Implemented Interfaces

java.io.Serializable, java.lang.reflect.InvocationHandler

Field Summary

Modifier and Type	Field and Description
private final Session	realSession
private Session	wrappedSession

Constructor Summary

Access	Constructor and Description
public	TransactionProtectionWrapper(Session realSession)

Method Summary

Modifier and Type	Method and Description
public Object	invoke(Object the proxy instance that the method was invoked on proxy, Method the `Method` instance corresponding to the interface method invoked on the proxy instance. The declaring class of the `Method` object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through. method, Object[] an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or `null` if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as `java.lang.Integer` or `java.lang.Boolean`. args) Implements java.lang.reflect.InvocationHandler.invoke. Processes a method invocation on a proxy instance and returns the result.
private void	readObject(ObjectInputStream ois)
public void	setWrapped(Session Value to set for property 'wrapped'. wrapped) Setter for property 'wrapped'.
private void	writeObject(ObjectOutputStream oos)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

realSession	back to summary
private final Session realSession

wrappedSession	back to summary
private Session wrappedSession

Constructor Detail

TransactionProtectionWrapper	back to summary
public TransactionProtectionWrapper(Session realSession)

Method Detail

invoke back to summary

invoke	back to summary
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable Implements java.lang.reflect.InvocationHandler.invoke. Doc from java.lang.reflect.InvocationHandler.invoke. Processes a method invocation on a proxy instance and returns the result. This method will be invoked on an invocation handler when a method is invoked on a proxy instance that it is associated with. Parameters proxy:Object the proxy instance that the method was invoked on method:Method the `Method` instance corresponding to the interface method invoked on the proxy instance. The declaring class of the `Method` object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through. args:Object[] an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or `null` if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as `java.lang.Integer` or `java.lang.Boolean`. Returns:Object the value to return from the method invocation on the proxy instance. If the declared return type of the interface method is a primitive type, then the value returned by this method must be an instance of the corresponding primitive wrapper class; otherwise, it must be a type assignable to the declared return type. If the value returned by this method is `null` and the interface method's return type is primitive, then a `NullPointerException` will be thrown by the method invocation on the proxy instance. If the value returned by this method is otherwise not compatible with the interface method's declared return type as described above, a `ClassCastException` will be thrown by the method invocation on the proxy instance. Annotations @Override @SuppressWarnings:SimplifiableIfStatement Exceptions Throwable: the exception to throw from the method invocation on the proxy instance. The exception's type must be assignable either to any of the exception types declared in the `throws` clause of the interface method or to the unchecked exception types `java.lang.RuntimeException` or `java.lang.Error`. If a checked exception is thrown by this method that is not assignable to any of the exception types declared in the `throws` clause of the interface method, then an `UndeclaredThrowableException` containing the exception that was thrown by this method will be thrown by the method invocation on the proxy instance.

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable

Implements java.lang.reflect.InvocationHandler.invoke.

Doc from java.lang.reflect.InvocationHandler.invoke.

Processes a method invocation on a proxy instance and returns the result. This method will be invoked on an invocation handler when a method is invoked on a proxy instance that it is associated with.

Parameters

proxy:Object: the proxy instance that the method was invoked on
method:Method: the Method instance corresponding to the interface method invoked on the proxy instance. The declaring class of the Method object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through.
args:Object[]: an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or null if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as java.lang.Integer or java.lang.Boolean.

Returns:Object

the value to return from the method invocation on the proxy instance. If the declared return type of the interface method is a primitive type, then the value returned by this method must be an instance of the corresponding primitive wrapper class; otherwise, it must be a type assignable to the declared return type. If the value returned by this method is null and the interface method's return type is primitive, then a NullPointerException will be thrown by the method invocation on the proxy instance. If the value returned by this method is otherwise not compatible with the interface method's declared return type as described above, a ClassCastException will be thrown by the method invocation on the proxy instance.

Annotations

@Override
@SuppressWarnings:SimplifiableIfStatement

Exceptions

Throwable:: the exception to throw from the method invocation on the proxy instance. The exception's type must be assignable either to any of the exception types declared in the throws clause of the interface method or to the unchecked exception types java.lang.RuntimeException or java.lang.Error. If a checked exception is thrown by this method that is not assignable to any of the exception types declared in the throws clause of the interface method, then an UndeclaredThrowableException containing the exception that was thrown by this method will be thrown by the method invocation on the proxy instance.

readObject	back to summary
private void readObject(ObjectInputStream ois) throws IOException, ClassNotFoundException

setWrapped	back to summary
public void setWrapped(Session wrapped) Setter for property 'wrapped'. Parameters wrapped:Session Value to set for property 'wrapped'.

setWrapped

back to summary

public void setWrapped(Session wrapped)

Setter for property 'wrapped'.

Parameters

wrapped:Session: Value to set for property 'wrapped'.

writeObject	back to summary
private void writeObject(ObjectOutputStream oos) throws IOException

public Class ThreadLocalSessionContext

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class ThreadLocalSessionContext.CleanupSync

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ThreadLocalSessionContext.TransactionProtectionWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail