Interface SharedSessionContractImplementor

All Superinterfaces:

AutoCloseable, EntityHandler, JdbcSessionOwner, LobCreationContext, Serializable, SharedSessionContract, TransactionCoordinatorBuilder.Options, WrapperOptions

All Known Subinterfaces:

EventSource, SessionImplementor, StatelessSessionImplementor

All Known Implementing Classes:

SessionDelegatorBaseImpl

public interface SharedSessionContractImplementor
extends SharedSessionContract, JdbcSessionOwner, TransactionCoordinatorBuilder.Options, LobCreationContext, WrapperOptions

Defines the internal contract shared between Session and StatelessSession as used by other parts of Hibernate, including implementors of Type, EntityPersister, and CollectionPersister.

The Session, via this interface, implements:

• JdbcSessionOwner, and so the session also acts as the orchestrator of a "JDBC session", and may be used to construct a JdbcCoordinator.
• TransactionCoordinatorBuilder.Options, allowing the session to control the creation of the TransactionCoordinator delegate when it is passed as an argument to TransactionCoordinatorBuilder.buildTransactionCoordinator(TransactionCoordinatorOwner, TransactionCoordinatorBuilder.Options)
• LobCreationContext, and so the session may act as the context for JDBC LOB instance creation.
• WrapperOptions, and so the session may influence the process of binding and extracting values to and from JDBC, which is performed by implementors of JdbcType.

Nested Class Summary

Nested classes/interfaces inherited from interface LobCreationContext

LobCreationContext.Callback<T>

Method Summary

Modifier and Type	Method	Description
Transaction	accessTransaction()	Retrieves the current Transaction, or creates a new transaction if there is no transaction active.
void	afterOperation(boolean success)	Check if there is a Hibernate or JTA transaction in progress and, if there is not, flush if necessary, making sure that the connection has been committed (if it is not in autocommit mode), and finally run the after completion processing.
void	afterScrollOperation()	Called after each operation on a ScrollableResults, providing an opportunity for a stateless session to clear its temporary persistence context.
default EventSource	asEventSource()	Cast this session to EventSource if possible.
default boolean	autoFlushIfRequired(Set<String> querySpaces)	detect in-memory changes, determine if the changes are to tables named in the query and, if so, complete execution the flush
boolean	autoFlushIfRequired(Set<String> querySpaces, boolean skipPreFlush)	detect in-memory changes, determine if the changes are to tables named in the query and, if so, complete execution the flush
boolean	autoPreFlushIfRequired(QueryParameterBindings parameterBindings)
String	bestGuessEntityName(Object object)	Obtain the best estimate of the entity name of the given entity instance, which is not involved in an association, by also considering information held in the proxy, and whether the object is already associated with this session.
<T> T	callEntityLifecycleCallback(Supplier<T> callback)	Call a Jakarta Persistence entity lifecycle callback.
<T> T	callInterceptorCallback(Supplier<T> callback)	Call a Hibernate Interceptor callback.
default void	checkOpen()	Check whether the session is open, and if not: mark the current transaction, if any, for rollback only, and throw an IllegalStateException.
void	checkOpen(boolean markForRollbackIfClosed)	Check whether the session is open, and if not: if markForRollbackIfClosed = true, mark the current transaction, if any, for rollback only, and throw an IllegalStateException.
default void	checkTransactionNeededForUpdateOperation(String exceptionMessage)	Check if an active Transaction is available before performing an update operation against the database.
<T> RootGraphImplementor<T>	createEntityGraph(Class<T> rootType)	Create a new mutable instance of EntityGraph, with only a root node, allowing programmatic definition of the graph from scratch.
RootGraphImplementor<?>	createEntityGraph(String graphName)	Deprecated.
MutationQueryImplementor<?>	createMutationQuery(CriteriaStatement<?> criteriaStatement)	Create a MutationQuery from the given update criteria tree
MutationQueryImplementor<?>	createMutationQuery(JpaCriteriaInsert<?> insert)	Create a MutationQuery from the given insert criteria tree
<R> SelectionQueryImplementor<R>	createNamedQuery(String name, Class<R> resultClass)	Create a typed Query instance for the given named query.
<R> NativeQueryImplementor<R>	createNamedQuery(String name, String resultSetMappingName)
<R> NativeQueryImplementor<R>	createNamedQuery(String name, String resultSetMappingName, Class<R> resultClass)
default <R> NativeQueryImplementor<R>	createNativeQuery(Class<R> resultClass, String sqlString)	Synonym for SharedSessionContract.createNativeQuery(String,Class), offering generally easier readability for use code.
NativeQueryImplementor	createNativeQuery(String sql)	Create a NativeQuery instance for the given native SQL query.
<T> NativeQueryImplementor<T>	createNativeQuery(String sql, jakarta.persistence.sql.ResultSetMapping<T> resultSetMapping)
<R> NativeQueryImplementor<R>	createNativeQuery(String sqlString, Class<R> resultClass)	Create a NativeQuery instance for the given native SQL query using an implicit mapping to the specified Java type.
<R> NativeQueryImplementor<R>	createNativeQuery(String sqlString, Class<R> resultClass, String tableAlias)	Create a NativeQuery instance for the given native SQL query using an implicit mapping to the specified Java entity type.
NativeQueryImplementor	createNativeQuery(String sql, String resultSetMappingName)
<R> NativeQueryImplementor<R>	createNativeQuery(String sqlString, String resultSetMappingName, Class<R> resultClass)	Create a NativeQuery instance for the given native SQL query using an explicit mapping to the specified Java type.
<T> SelectionQueryImplementor<T>	createQuery(CriteriaSelect<T> criteriaSelect)
<R> SelectionQueryImplementor<R>	createQuery(TypedQueryReference<R> typedQueryReference)	Create a typed Query instance for the given typed query reference.
default <R> SelectionQueryImplementor<R>	createQuery(Class<R> resultClass, String hqlString)	Synonym for SharedSessionContract.createQuery(String,Class), offering generally easier readability for use code.
<T> SelectionQueryImplementor<T>	createQuery(String hqlString, EntityGraph<T> entityGraph)
<R> SelectionQueryImplementor<R>	createQuery(String queryString, Class<R> resultClass)	Create a typed Query instance for the given HQL query string and given query result type.
MutationQueryImplementor	createStatement(CriteriaStatement<?> criteriaStatement)
void	flush()	Flush this session.
CollectionKey	generateCollectionKey(CollectionPersister persister, Object key)	Instantiate a CollectionKey with the given key and for the collection represented by the given CollectionPersister.
EntityKey	generateEntityKey(Object id, EntityPersister persister)	Instantiate an EntityKey with the given id and for the entity represented by the given EntityPersister.
AuditWorkQueue	getAuditWorkQueue()	Access the transaction-scoped audit work queue for deferred audit row writes.
CacheTransactionSynchronization	getCacheTransactionSynchronization()	The current CacheTransactionSynchronization associated with this session.
default Integer	getConfiguredJdbcBatchSize()	Get the currently configured JDBC batch size, which might have been specified at either the session or factory level.
Object	getContextEntityIdentifier(Object object)	Return the identifier of the persistent object, or null if it is not associated with this session.
Object	getCurrentChangesetContext()	Obtain the full changeset context associated with getCurrentChangesetIdentifier(), if the configured changeset supplier exposes one.
Object	getCurrentChangesetIdentifier()	The changeset id associated with the current unit of work, for use with temporal effectivity columns and with audit log changeset id columns.
Transaction	getCurrentTransaction()	The current Transaction object associated with this session, if it has already been created, or null otherwise.
LockOptions	getDefaultLockOptions()	The default lock options associated with this session.
Timeout	getDefaultLockTimeout()	Lock timeout specified on the SessionFactory via hint.
Timeout	getDefaultTimeout()	Query timeout specified on the SessionFactory via hint.
default Dialect	getDialect()	Obtain the Dialect.
RootGraphImplementor<?>	getEntityGraph(String graphName)	Obtain a mutable copy of a predefined named entity graph.
EntityPersister	getEntityPersister(String entityName, Object object)	Get the EntityPersister for the given entity instance.
Object	getEntityUsingInterceptor(EntityKey key)	Get the entity instance associated with the given EntityKey, calling the Interceptor if necessary.
SessionEventListenerManager	getEventListenerManager()	Get the SessionEventListenerManager associated with this session.
ExceptionConverter	getExceptionConverter()	Obtain an ExceptionConverter for reporting an error.
<E extends Extension> E	getExtension(Class<E> extension)	Allows accessing session scoped extension storages of the particular session instance.
SessionFactoryImplementor	getFactory()	Obtain the factory which created this session.
FlushMode	getHibernateFlushMode()	Get the current FlushMode for this session.
Interceptor	getInterceptor()	Retrieves the Interceptor associated with this session.
JdbcCoordinator	getJdbcCoordinator()	Obtain the JdbcCoordinator for this session.
JdbcServices	getJdbcServices()	Obtain the JdbcServices for the factory which created this session.
LoadQueryInfluencers	getLoadQueryInfluencers()	Get the LoadQueryInfluencers associated with this session.
boolean	getNativeJdbcParametersIgnored()
PersistenceContext	getPersistenceContext()	Get the persistence context for this session.
PersistenceContext	getPersistenceContextInternal()	Similar to getPersistenceContext(), with two differences: this version performs better as it allows for inlining and probably better prediction, and it skips some checks of the current state of the session.
default SharedSessionContractImplementor	getSession()	Returns this object, fulfilling the contract of WrapperOptions.
SessionAssociationMarkers	getSessionAssociationMarkers()	Wrap all state that lazy loading interceptors might need to manage association with this session, or to handle lazy loading after detachment via the UUID of the SessionFactory.
default SessionFactoryImplementor	getSessionFactory()	Obtain the factory which created this session.
UUID	getSessionIdentifier()	Obtain a UUID which uniquely identifies this session.
default Object	getSessionToken()	Obtain a "token" which uniquely identifies this session.
TransactionCompletionCallbacks	getTransactionCompletionCallbacks()	Access to register callbacks for transaction completion processing.
TransactionCompletionCallbacksImplementor	getTransactionCompletionCallbacksImplementor()	Access to registered callbacks for transaction completion processing.
default TypeConfiguration	getTypeConfiguration()	Obtain the TypeConfiguration for the factory which created this session.
String	guessEntityName(Object entity)	Obtain an estimate of the entity name of the given entity instance, which is not involved in an association, using only the EntityNameResolver.
Object	immediateLoad(String entityName, Object id)	Load an instance immediately.
void	initializeCollection(PersistentCollection<?> collection, boolean writing)	Initialize the given collection (if not already initialized).
Object	instantiate(EntityPersister persister, Object id)	Instantiate the entity class of the given EntityPersister, initializing the new instance with the given identifier.
Object	internalLoad(String entityName, Object id, boolean eager, boolean nullable)	Obtain an entity instance with the given id, without checking if it was deleted or scheduled for deletion.
boolean	isClosed()	Determines whether the session is closed.
boolean	isCriteriaCopyTreeEnabled()
boolean	isCriteriaPlanCacheEnabled()
boolean	isDefaultReadOnly()	Are entities and proxies loaded by this session read-only by default?
default boolean	isEventSource()	Determines if this session implements EventSource.
boolean	isIdentifierRollbackEnabled()
boolean	isManaged(Object entity)	Is the given entity managed by this session?
default boolean	isOpenOrWaitingForAutoClose()	Determines whether the session is open or is waiting for auto-close.
default boolean	isStateless()	Whether the session stateless, as opposed tp stateful.
boolean	isTransactionInProgress()	Does this session have an active Hibernate transaction, or is it associated with a JTA transaction currently in progress?
Object	loadFromSecondLevelCache(EntityPersister persister, EntityKey entityKey, Object instanceToLoad, LockMode lockMode)	Attempts to load the entity from the second-level cache.
void	lock(String entityName, Object child, LockOptions lockOptions)	Cascade the lock operation to the given child entity.
void	markForRollbackOnly()	Marks current transaction, if any, for rollback only.
void	prepareForQueryExecution(boolean requiresTxn)	Prepare for the execution of a Query or ProcedureCall
void	runEntityLifecycleCallback(Runnable callback)	Run a Jakarta Persistence entity lifecycle callback.
void	runInterceptorCallback(Runnable callback)	Run a Hibernate Interceptor callback.
void	setCriteriaCopyTreeEnabled(boolean jpaCriteriaCopyComplianceEnabled)
void	setCriteriaPlanCacheEnabled(boolean jpaCriteriaCacheEnabled)
void	setNativeJdbcParametersIgnored(boolean nativeJdbcParametersIgnored)

Methods inherited from interface EntityHandler

callWithConnection, find, find, find, findMultiple, findMultiple, get, get, get, getCacheRetrieveMode, getCacheStoreMode, getEntityManagerFactory, getMetamodel, getMultiple, getMultiple, getProperties, runWithConnection, setCacheRetrieveMode, setCacheStoreMode, setProperty, unwrap

Methods inherited from interface JdbcSessionOwner

afterObtainConnection, afterTransactionBegin, afterTransactionCompletion, beforeReleaseConnection, beforeTransactionCompletion, flushBeforeTransactionCompletion, getEventMonitor, getJdbcBatchSize, getJdbcConnectionAccess, getJdbcSessionContext, getSqlExceptionHelper, getTransactionCoordinator, startTransactionBoundary

Methods inherited from interface LobCreationContext

execute, fromContext

Methods inherited from interface SharedSessionContract

beginTransaction, close, createEntityGraph, createMutationQuery, createNamedMutationQuery, createNamedQuery, createNamedSelectionQuery, createNamedStatement, createNamedStoredProcedureQuery, createNativeMutationQuery, createNativeStatement, createQuery, createSelectionQuery, createSelectionQuery, createSelectionQuery, createSelectionQuery, createStatement, createStatement, createStoredProcedureCall, createStoredProcedureCall, createStoredProcedureCall, createStoredProcedureQuery, createStoredProcedureQuery, createStoredProcedureQuery, disableFilter, doReturningWork, doWork, enableFilter, find, find, fromTransaction, get, get, getCacheMode, getCriteriaBuilder, getEnabledFilter, getEntityGraph, getEntityGraphs, getJdbcBatchSize, getNamedProcedureCall, getTenantIdentifier, getTenantIdentifierValue, getTransaction, inTransaction, isConnected, isJoinedToTransaction, isOpen, joinTransaction, sessionWithOptions, setCacheMode, setJdbcBatchSize, statelessWithOptions

Methods inherited from interface TransactionCoordinatorBuilder.Options

shouldAutoJoinTransaction

Methods inherited from interface WrapperOptions

getJdbcTimeZone, getJsonFormatMapper, getLobCreator, getPreferredSqlTypeCodeForBoolean, getXmlFormatMapper, useLanguageTagForLocale, useStreamForLobBinding

Method Details

getFactory

@Nonnull
SessionFactoryImplementor getFactory()

Obtain the factory which created this session.

Specified by:

getFactory in interface SharedSessionContract

getSessionFactory

@Nonnull
default SessionFactoryImplementor getSessionFactory()

Obtain the factory which created this session.

Specified by:

getSessionFactory in interface WrapperOptions

getTypeConfiguration

@Nonnull
default TypeConfiguration getTypeConfiguration()

Obtain the TypeConfiguration for the factory which created this session.

Specified by:

getTypeConfiguration in interface WrapperOptions

getDialect

@Nonnull
default Dialect getDialect()

Obtain the Dialect.

Specified by:

getDialect in interface WrapperOptions

getEventListenerManager

@Nonnull
SessionEventListenerManager getEventListenerManager()

Get the SessionEventListenerManager associated with this session.

getPersistenceContext

@Nonnull
PersistenceContext getPersistenceContext()

Get the persistence context for this session.

See getPersistenceContextInternal() for a faster alternative.

Implementation Note:

This method is not extremely fast: if you need to call the PersistenceContext multiple times, prefer keeping a reference to it instead of invoking this method multiple times.

getJdbcCoordinator

@Nonnull
JdbcCoordinator getJdbcCoordinator()

Obtain the JdbcCoordinator for this session.

getJdbcServices

@Nonnull
JdbcServices getJdbcServices()

Obtain the JdbcServices for the factory which created this session.

getSessionIdentifier

@Nonnull
UUID getSessionIdentifier()

Obtain a UUID which uniquely identifies this session.

The UUID is useful mainly for logging.

getSession

@Nonnull
default SharedSessionContractImplementor getSession()

Returns this object, fulfilling the contract of WrapperOptions.

Specified by:

getSession in interface WrapperOptions

getSessionToken

default Object getSessionToken()

Obtain a "token" which uniquely identifies this session.

isClosed

boolean isClosed()

Determines whether the session is closed.

Returns:

true if the session is closed; false otherwise.

API Note:

Provided separately from SharedSessionContract.isOpen() as this method does not attempt any JTA synchronization registration, whereas SharedSessionContract.isOpen() does. This one is better for most internal purposes.

isOpenOrWaitingForAutoClose

default boolean isOpenOrWaitingForAutoClose()

Determines whether the session is open or is waiting for auto-close.

Returns:

true if the session is closed, or if it's waiting for auto-close; false otherwise.

checkOpen

default void checkOpen()

Check whether the session is open, and if not:

• mark the current transaction, if any, for rollback only, and
• throw an IllegalStateException. (JPA specifies this exception type.)

checkOpen

void checkOpen(boolean markForRollbackIfClosed)

Check whether the session is open, and if not:

• if markForRollbackIfClosed = true, mark the current transaction, if any, for rollback only, and
• throw an IllegalStateException. (JPA specifies this exception type.)

runEntityLifecycleCallback

void runEntityLifecycleCallback(Runnable callback)

Run a Jakarta Persistence entity lifecycle callback.

callEntityLifecycleCallback

<T> T callEntityLifecycleCallback(@Nonnull
 Supplier<T> callback)

Call a Jakarta Persistence entity lifecycle callback.

runInterceptorCallback

void runInterceptorCallback(@Nonnull
 Runnable callback)

Run a Hibernate Interceptor callback.

callInterceptorCallback

<T> T callInterceptorCallback(@Nonnull
 Supplier<T> callback)

Call a Hibernate Interceptor callback.

prepareForQueryExecution

void prepareForQueryExecution(boolean requiresTxn)

Prepare for the execution of a Query or ProcedureCall

markForRollbackOnly

void markForRollbackOnly()

Marks current transaction, if any, for rollback only.

getCacheTransactionSynchronization

CacheTransactionSynchronization getCacheTransactionSynchronization()

The current CacheTransactionSynchronization associated with this session. This may be null if the session is not currently associated with an active transaction.

getCurrentChangesetIdentifier

Object getCurrentChangesetIdentifier()

The changeset id associated with the current unit of work, for use with temporal effectivity columns and with audit log changeset id columns.

getCurrentChangesetContext

@Nullable
Object getCurrentChangesetContext()

Obtain the full changeset context associated with getCurrentChangesetIdentifier(), if the configured changeset supplier exposes one.

This is used by graph-queue audit execution to capture changelog state before materializing audit bind plans. Suppliers which only produce a scalar changeset identifier return null.

isTransactionInProgress

boolean isTransactionInProgress()

Does this session have an active Hibernate transaction, or is it associated with a JTA transaction currently in progress?

checkTransactionNeededForUpdateOperation

default void checkTransactionNeededForUpdateOperation(@Nonnull
 String exceptionMessage)

Check if an active Transaction is available before performing an update operation against the database.

If an active transaction is necessary, but no transaction is active, a TransactionRequiredException is raised.

Parameters:

exceptionMessage - the message to use for the TransactionRequiredException

accessTransaction

@Nonnull
Transaction accessTransaction()

Retrieves the current Transaction, or creates a new transaction if there is no transaction active.

This method is primarily for internal or integrator use.

Returns:

the Transaction

getCurrentTransaction

@Incubating
@Nullable
Transaction getCurrentTransaction()

The current Transaction object associated with this session, if it has already been created, or null otherwise.

Since:

7.2

getTransactionCompletionCallbacks

@Incubating
TransactionCompletionCallbacks getTransactionCompletionCallbacks()

Access to register callbacks for transaction completion processing.

Since:

7.2

getTransactionCompletionCallbacksImplementor

@Incubating
@Nonnull
TransactionCompletionCallbacksImplementor getTransactionCompletionCallbacksImplementor()

Access to registered callbacks for transaction completion processing.

Since:

7.2

getAuditWorkQueue

@Incubating
AuditWorkQueue getAuditWorkQueue()

Access the transaction-scoped audit work queue for deferred audit row writes. Lazily initialized on first access.

Since:

7.4

generateEntityKey

@Nonnull
EntityKey generateEntityKey(@Nonnull
 Object id,
 @Nonnull
 EntityPersister persister)

Instantiate an EntityKey with the given id and for the entity represented by the given EntityPersister.

When operating in a temporal context, this will automatically create a TemporalEntityKey that includes the transaction identifier.

Parameters:

id - The entity id

persister - The entity persister

Returns:

The entity key

generateCollectionKey

@Nonnull
CollectionKey generateCollectionKey(@Nonnull
 CollectionPersister persister,
 @Nonnull
 Object key)

Instantiate a CollectionKey with the given key and for the collection represented by the given CollectionPersister.

When operating in a temporal context, this will automatically create a TemporalCollectionKey that includes the transaction identifier.

Parameters:

persister - The collection persister

key - The collection key (owner FK)

Returns:

The collection key

getInterceptor

Interceptor getInterceptor()

Retrieves the Interceptor associated with this session.

initializeCollection

void initializeCollection(@Nonnull
 PersistentCollection<?> collection,
 boolean writing)
                   throws HibernateException

Initialize the given collection (if not already initialized).

Throws:

HibernateException

internalLoad

Object internalLoad(@Nonnull
 String entityName,
 @Nonnull
 Object id,
 boolean eager,
 boolean nullable)
             throws HibernateException

Obtain an entity instance with the given id, without checking if it was deleted or scheduled for deletion.

• When nullable = false, this method may create a new proxy or return an existing proxy; if it does not exist, an exception is thrown.
• When nullable = true, the method does not create new proxies, though it might return an existing proxy; if it does not exist, a null value is returned.

When eager = true, the object is eagerly fetched from the database.

Throws:

HibernateException

immediateLoad

Object immediateLoad(@Nonnull
 String entityName,
 @Nonnull
 Object id)

Load an instance immediately. This method is only called when lazily initializing a proxy. Do not return the proxy.

getEntityPersister

@Nonnull
EntityPersister getEntityPersister(@Nullable
 String entityName,
 @Nonnull
 Object object)

Get the EntityPersister for the given entity instance.

Parameters:

entityName - optional entity name

object - the entity instance

getEntityUsingInterceptor

Object getEntityUsingInterceptor(@Nonnull
 EntityKey key)

Get the entity instance associated with the given EntityKey, calling the Interceptor if necessary.

getContextEntityIdentifier

Object getContextEntityIdentifier(@Nonnull
 Object object)

Return the identifier of the persistent object, or null if it is not associated with this session.

bestGuessEntityName

String bestGuessEntityName(@Nonnull
 Object object)

Obtain the best estimate of the entity name of the given entity instance, which is not involved in an association, by also considering information held in the proxy, and whether the object is already associated with this session.

guessEntityName

String guessEntityName(@Nonnull
 Object entity)

Obtain an estimate of the entity name of the given entity instance, which is not involved in an association, using only the EntityNameResolver.

instantiate

Object instantiate(@Nonnull
 EntityPersister persister,
 @Nonnull
 Object id)

Instantiate the entity class of the given EntityPersister, initializing the new instance with the given identifier.

isDefaultReadOnly

boolean isDefaultReadOnly()

Are entities and proxies loaded by this session read-only by default?

isIdentifierRollbackEnabled

boolean isIdentifierRollbackEnabled()

setCriteriaCopyTreeEnabled

void setCriteriaCopyTreeEnabled(boolean jpaCriteriaCopyComplianceEnabled)

isCriteriaCopyTreeEnabled

boolean isCriteriaCopyTreeEnabled()

setCriteriaPlanCacheEnabled

void setCriteriaPlanCacheEnabled(boolean jpaCriteriaCacheEnabled)

isCriteriaPlanCacheEnabled

boolean isCriteriaPlanCacheEnabled()

getNativeJdbcParametersIgnored

boolean getNativeJdbcParametersIgnored()

setNativeJdbcParametersIgnored

void setNativeJdbcParametersIgnored(boolean nativeJdbcParametersIgnored)

getHibernateFlushMode

@Nonnull
FlushMode getHibernateFlushMode()

Get the current FlushMode for this session.

Returns:

The flush mode

flush

void flush()

Flush this session.

isEventSource

default boolean isEventSource()

Determines if this session implements EventSource.

Only stateful session are sources of events. If this object is a stateless session, this method return false.

asEventSource

@Nonnull
default EventSource asEventSource()

Cast this session to EventSource if possible.

Only stateful session are sources of events. If this object is a stateless session, this method throws.

Throws:

ClassCastException - if the cast is not possible

isStateless

default boolean isStateless()

Whether the session stateless, as opposed tp stateful.

API Note:

Essentially, whether casting this session to StatelessSessionImplementor will succeed.

afterScrollOperation

void afterScrollOperation()

Called after each operation on a ScrollableResults, providing an opportunity for a stateless session to clear its temporary persistence context. For a stateful session, this method does nothing.

getLoadQueryInfluencers

@Nonnull
LoadQueryInfluencers getLoadQueryInfluencers()

Get the LoadQueryInfluencers associated with this session.

Returns:

the LoadQueryInfluencers associated with this session; should never be null.

getDefaultLockOptions

LockOptions getDefaultLockOptions()

The default lock options associated with this session.

getDefaultLockTimeout

@Nullable
Timeout getDefaultLockTimeout()

Lock timeout specified on the SessionFactory via hint.

getDefaultTimeout

@Nullable
Timeout getDefaultTimeout()

Query timeout specified on the SessionFactory via hint.

getExceptionConverter

@Nonnull
ExceptionConverter getExceptionConverter()

Obtain an ExceptionConverter for reporting an error.

The converter associated to a session might be lazily initialized, so only invoke this getter when there's an actual need to use it.

Returns:

the ExceptionConverter for this Session.

getConfiguredJdbcBatchSize

@Nullable
default Integer getConfiguredJdbcBatchSize()

Get the currently configured JDBC batch size, which might have been specified at either the session or factory level.

Returns:

the session-level JDBC batch size is set, or the factory-level setting otherwise

Since:

5.2

See Also:

• SessionFactoryOptions.getJdbcBatchSize()
• SessionFactoryBuilder.applyJdbcBatchSize(int)

getPersistenceContextInternal

@Nonnull
PersistenceContext getPersistenceContextInternal()

Similar to getPersistenceContext(), with two differences:

1. this version performs better as it allows for inlining and probably better prediction, and
2. it skips some checks of the current state of the session.

Choose wisely: performance is important, but correctness comes first.

Returns:

the PersistenceContext associated to this session.

isManaged

boolean isManaged(Object entity)

Is the given entity managed by this session?

Returns:

true if this is a stateful session and the entity belongs to its persistence context and was not removed

autoFlushIfRequired

default boolean autoFlushIfRequired(Set<String> querySpaces)

detect in-memory changes, determine if the changes are to tables named in the query and, if so, complete execution the flush

Parameters:

querySpaces - the tables named in the query.

Returns:

true if flush is required, false otherwise.

autoFlushIfRequired

boolean autoFlushIfRequired(Set<String> querySpaces,
 boolean skipPreFlush)

detect in-memory changes, determine if the changes are to tables named in the query and, if so, complete execution the flush

Parameters:

querySpaces - the tables named in the query.

skipPreFlush - see AutoFlushEvent.isSkipPreFlush()

Returns:

true if flush is required, false otherwise.

autoPreFlushIfRequired

boolean autoPreFlushIfRequired(QueryParameterBindings parameterBindings)

afterOperation

void afterOperation(boolean success)

Check if there is a Hibernate or JTA transaction in progress and, if there is not, flush if necessary, making sure that the connection has been committed (if it is not in autocommit mode), and finally run the after completion processing.

Parameters:

success - true if the operation a success

lock

void lock(@Nonnull
 String entityName,
 @Nonnull
 Object child,
 @Nonnull
 LockOptions lockOptions)

Cascade the lock operation to the given child entity.

loadFromSecondLevelCache

@Incubating
Object loadFromSecondLevelCache(@Nonnull
 EntityPersister persister,
 @Nonnull
 EntityKey entityKey,
 @Nullable
 Object instanceToLoad,
 @Nonnull
 LockMode lockMode)

Attempts to load the entity from the second-level cache.

Parameters:

persister - The persister for the entity being requested for load

entityKey - The entity key

instanceToLoad - The instance that is being initialized, or null

lockMode - The lock mode

Returns:

The entity from the second-level cache, or null.

Since:

7.0

getSessionAssociationMarkers

@Incubating
@Nonnull
SessionAssociationMarkers getSessionAssociationMarkers()

Wrap all state that lazy loading interceptors might need to manage association with this session, or to handle lazy loading after detachment via the UUID of the SessionFactory. N.B. this captures the current Session, however it can get updated to a null session (for detached entities) or updated to a different Session.

createEntityGraph

@Nonnull
<T> RootGraphImplementor<T> createEntityGraph(@Nonnull
 Class<T> rootType)

Description copied from interface: SharedSessionContract

Create a new mutable instance of EntityGraph, with only a root node, allowing programmatic definition of the graph from scratch.

Specified by:

createEntityGraph in interface EntityHandler

Specified by:

createEntityGraph in interface SharedSessionContract

Parameters:

rootType - the root entity class of the graph

See Also:

• EntityGraphs.createGraph(jakarta.persistence.metamodel.EntityType)

createEntityGraph

@Deprecated
@Nullable
RootGraphImplementor<?> createEntityGraph(@Nonnull
 String graphName)

Deprecated.

Description copied from interface: SharedSessionContract

Create a new mutable instance of EntityGraph, based on a predefined named entity graph, allowing customization of the graph, or return null if there is no predefined graph with the given name.

Specified by:

createEntityGraph in interface SharedSessionContract

Parameters:

graphName - the name of the graph

getEntityGraph

@Nonnull
RootGraphImplementor<?> getEntityGraph(@Nonnull
 String graphName)

Description copied from interface: SharedSessionContract

Obtain a mutable copy of a predefined named entity graph.

Specified by:

getEntityGraph in interface EntityHandler

Specified by:

getEntityGraph in interface SharedSessionContract

Parameters:

graphName - the name of the predefined named entity graph

See Also:

• EntityHandler.getEntityGraph(String)
• EntityManagerFactory.getNamedEntityGraphs(Class)
• EntityManagerFactory.addNamedEntityGraph(String, EntityGraph)

createQuery

@Nonnull
<R> SelectionQueryImplementor<R> createQuery(@Nonnull
 String queryString,
 @Nonnull
 Class<R> resultClass)

Description copied from interface: SharedSessionContract

Create a typed Query instance for the given HQL query string and given query result type.

• If the query has a single item in the select list, then the select item must be assignable to the given result type.
• Otherwise, if there are multiple select items, then the select items will be packaged into an instance of the result type. The result type must have an appropriate constructor with parameter types matching the select items, or it must be one of the types Object[], List, Map, or Tuple.

If a query has no explicit select list, the select list is inferred from the given query result type:

• if the result type is an entity type, the query must have exactly one root entity in the from clause, it must be assignable to the result type, and the inferred select list will contain just that entity, or
• otherwise, the select list contains every root entity and every non-fetch joined entity, and each query result will be packaged into an instance of the result type, just as specified above.

If a query has no explicit from clause, and the given result type is an entity type, the root entity is inferred to be the result type.

Passing Object.class as the query result type is not recommended.

The returned Query may be executed by calling SelectionQuery.getResultList() or SelectionQuery.getSingleResult().

Specified by:

createQuery in interface EntityHandler

Specified by:

createQuery in interface SharedSessionContract

Parameters:

queryString - The HQL query

resultClass - The Class object representing the query result type, which should not be Object.class

Returns:

The Query instance for manipulation and execution

See Also:

• EntityHandler.createQuery(String,Class)

createQuery

@Nonnull
default <R> SelectionQueryImplementor<R> createQuery(@Nonnull
 Class<R> resultClass,
 @Nonnull
 String hqlString)

Description copied from interface: SharedSessionContract

Synonym for SharedSessionContract.createQuery(String,Class), offering generally easier readability for use code. For example

var peeps = session.createQuery(Person.class, "some really long query string" )
		...
		.list();

as opposed to

var peeps = session.createQuery("some really long query string", Person.class)
		...
		.list();

Specified by:

createQuery in interface SharedSessionContract

createQuery

@Nonnull
<R> SelectionQueryImplementor<R> createQuery(@Nonnull
 TypedQueryReference<R> typedQueryReference)

Description copied from interface: SharedSessionContract

Create a typed Query instance for the given typed query reference.

Specified by:

createQuery in interface EntityHandler

Specified by:

createQuery in interface SharedSessionContract

Parameters:

typedQueryReference - the type query reference

Returns:

The Query instance for execution

See Also:

• EntityHandler.createQuery(TypedQueryReference)

createNativeQuery

@Nonnull
<R> NativeQueryImplementor<R> createNativeQuery(@Nonnull
 String sqlString,
 @Nonnull
 Class<R> resultClass)

Description copied from interface: SharedSessionContract

Create a NativeQuery instance for the given native SQL query using an implicit mapping to the specified Java type.

• If the given class is an entity class, this method is equivalent to createNativeQuery(sqlString).addEntity(resultClass).
• If the given class has a registered JavaType, then the query must return a result set with a single column whose JdbcType is compatible with that JavaType.
• Otherwise, the select items will be packaged into an instance of the result type. The result type must have an appropriate constructor with parameter types matching the select items, or it must be one of the types Object[], List, Map, or Tuple.

Specified by:

createNativeQuery in interface EntityHandler

Specified by:

createNativeQuery in interface SharedSessionContract

Parameters:

sqlString - The native (SQL) query string

resultClass - The Java type to map results to

Returns:

The NativeQuery instance for manipulation and execution

See Also:

• EntityHandler.createNativeQuery(String,Class)

createNativeQuery

@Nonnull
default <R> NativeQueryImplementor<R> createNativeQuery(@Nonnull
 Class<R> resultClass,
 @Nonnull
 String sqlString)

Description copied from interface: SharedSessionContract

Synonym for SharedSessionContract.createNativeQuery(String,Class), offering generally easier readability for use code. For example

var peeps = session.createNativeQuery(Person.class, "some really long query string" )
		...
		.list();

as opposed to

var peeps = session.createNativeQuery("some really long query string", Person.class)
		...
		.list();

Specified by:

createNativeQuery in interface SharedSessionContract

createNativeQuery

@Nonnull
<R> NativeQueryImplementor<R> createNativeQuery(@Nonnull
 String sqlString,
 @Nonnull
 Class<R> resultClass,
 @Nonnull
 String tableAlias)

Description copied from interface: SharedSessionContract

Create a NativeQuery instance for the given native SQL query using an implicit mapping to the specified Java entity type.

The given class must be an entity class. This method is equivalent to createNativeQuery(sqlString).addEntity(tableAlias, resultClass).

Specified by:

createNativeQuery in interface SharedSessionContract

Parameters:

sqlString - Native (SQL) query string

resultClass - The Java entity class to map results to

tableAlias - The table alias for columns in the result set

Returns:

The NativeQuery instance for manipulation and execution

See Also:

• EntityHandler.createNativeQuery(String,Class)

createNativeQuery

@Nonnull
<R> NativeQueryImplementor<R> createNativeQuery(@Nonnull
 String sqlString,
 @Nonnull
 String resultSetMappingName,
 @Nonnull
 Class<R> resultClass)

Description copied from interface: SharedSessionContract

Create a NativeQuery instance for the given native SQL query using an explicit mapping to the specified Java type.

The given result set mapping name must identify a mapping defined by a SqlResultSetMapping annotation.

Specified by:

createNativeQuery in interface SharedSessionContract

Parameters:

sqlString - The native (SQL) query string

resultSetMappingName - The explicit result mapping name

Returns:

The NativeQuery instance for manipulation and execution

See Also:

• EntityHandler.createNativeQuery(String,Class)
• SqlResultSetMapping

createNamedQuery

@Nonnull
<R> SelectionQueryImplementor<R> createNamedQuery(@Nonnull
 String name,
 @Nonnull
 Class<R> resultClass)

Description copied from interface: SharedSessionContract

Create a typed Query instance for the given named query. The named query might be defined in HQL or in native SQL.

Specified by:

createNamedQuery in interface EntityHandler

Specified by:

createNamedQuery in interface SharedSessionContract

Parameters:

name - the name of a query defined in metadata

resultClass - the type of the query result

Returns:

The Query instance for manipulation and execution

See Also:

• EntityHandler.createNamedQuery(String,Class)

createNamedQuery

@Nonnull
<R> NativeQueryImplementor<R> createNamedQuery(@Nonnull
 String name,
 @Nonnull
 String resultSetMappingName)

Specified by:

createNamedQuery in interface SharedSessionContract

createNamedQuery

@Nonnull
<R> NativeQueryImplementor<R> createNamedQuery(@Nonnull
 String name,
 @Nonnull
 String resultSetMappingName,
 @Nonnull
 Class<R> resultClass)

Specified by:

createNamedQuery in interface SharedSessionContract

createQuery

@Nonnull
<T> SelectionQueryImplementor<T> createQuery(@Nonnull
 CriteriaSelect<T> criteriaSelect)

Description copied from interface: SharedSessionContract

Specified by:

createQuery in interface EntityHandler

Specified by:

createQuery in interface SharedSessionContract

See Also:

• SharedSessionContract.createSelectionQuery(CriteriaSelect)
• EntityHandler.createQuery(CriteriaSelect)

createMutationQuery

@Nonnull
MutationQueryImplementor<?> createMutationQuery(@Nonnull
 CriteriaStatement<?> criteriaStatement)

Description copied from interface: SharedSessionContract

Create a MutationQuery from the given update criteria tree

Specified by:

createMutationQuery in interface SharedSessionContract

createStatement

@Nonnull
MutationQueryImplementor createStatement(@Nonnull
 CriteriaStatement<?> criteriaStatement)

Description copied from interface: SharedSessionContract

Specified by:

createStatement in interface EntityHandler

Specified by:

createStatement in interface SharedSessionContract

See Also:

• SharedSessionContract.createMutationQuery(CriteriaStatement)
• EntityHandler.createStatement(CriteriaStatement)

createMutationQuery

@Nonnull
MutationQueryImplementor<?> createMutationQuery(@Nonnull
 JpaCriteriaInsert<?> insert)

Description copied from interface: SharedSessionContract

Create a MutationQuery from the given insert criteria tree

Specified by:

createMutationQuery in interface SharedSessionContract

createQuery

@Nonnull
<T> SelectionQueryImplementor<T> createQuery(@Nonnull
 String hqlString,
 @Nonnull
 EntityGraph<T> entityGraph)

Specified by:

createQuery in interface EntityHandler

Specified by:

createQuery in interface SharedSessionContract

See Also:

• EntityHandler.createQuery(String,EntityGraph)

createNativeQuery

@Nonnull
NativeQueryImplementor createNativeQuery(@Nonnull
 String sql)

Description copied from interface: SharedSessionContract

Create a NativeQuery instance for the given native SQL query.

Specified by:

createNativeQuery in interface EntityHandler

Specified by:

createNativeQuery in interface SharedSessionContract

Parameters:

sql - The native (SQL) query string

Returns:

The NativeQuery instance for manipulation and execution

See Also:

• EntityHandler.createNativeQuery(String)

createNativeQuery

@Nonnull
NativeQueryImplementor createNativeQuery(@Nonnull
 String sql,
 @Nonnull
 String resultSetMappingName)

Specified by:

createNativeQuery in interface EntityHandler

Specified by:

createNativeQuery in interface SharedSessionContract

createNativeQuery

@Nonnull
<T> NativeQueryImplementor<T> createNativeQuery(@Nonnull
 String sql,
 @Nonnull
 jakarta.persistence.sql.ResultSetMapping<T> resultSetMapping)

Specified by:

createNativeQuery in interface EntityHandler

Specified by:

createNativeQuery in interface SharedSessionContract

getExtension

@Incubating
<E extends Extension> E getExtension(Class<E> extension)

Allows accessing session scoped extension storages of the particular session instance.

Extensions first had to be registered with the SessionFactory

Type Parameters:

E - The type of the extension storage.

Parameters:

extension - The extension storage attached to the current session. if the current session does not yet have the particular storage type attached to this session.