Package org.hibernate.engine.spi

Interface SessionImplementor

All Superinterfaces:

AutoCloseable, EntityManager, JavaType.CoercionContext, JdbcSessionOwner, LobCreationContext, QueryProducer, QueryProducerImplementor, Serializable, Session, SharedSessionContract, SharedSessionContractImplementor, TransactionCoordinatorBuilder.Options, WrapperOptions

All Known Subinterfaces:

EventSource

All Known Implementing Classes:

AbstractDelegateSessionImplementor, SessionDelegatorBaseImpl, SessionImpl, ToOneDelegateSessionImplementor

public interface SessionImplementor
extends Session, SharedSessionContractImplementor

Defines the "internal contract" between Session and other parts of Hibernate including implementors of Type, EntityPersister, and CollectionPersister.

The Session, via this interface and SharedSessionContractImplementor, 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(org.hibernate.resource.transaction.spi.TransactionCoordinatorOwner, org.hibernate.resource.transaction.spi.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.

See also EventSource which extends this interface, providing a bridge to the event generation features of org.hibernate.event.

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.engine.jdbc.LobCreationContext

LobCreationContext.Callback<T>

Method Summary

Modifier and Type	Method	Description
default <C, T> T	callWithConnection(ConnectionFunction<C,T> function)
<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)	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.
<T> QueryImplementor<T>	createQuery(CriteriaSelect<T> selectQuery)
void	forceFlush(EntityEntry e)	Initiate a flush to force deletion of a re-persisted entity.
void	forceFlush(EntityKey e)	Initiate a flush to force deletion of a re-persisted entity.
ActionQueue	getActionQueue()	Get the ActionQueue associated with this session.
RootGraphImplementor<?>	getEntityGraph(String graphName)	Obtain an immutable reference to a predefined named entity graph or return null if there is no predefined graph with the given name.
default SessionImplementor	getSession()	Returns this object, fulfilling the contract of WrapperOptions.
SessionFactoryImplementor	getSessionFactory()	Get the session factory which created this session.
Object	instantiate(EntityPersister persister, Object id)	Instantiate the entity class of the given EntityPersister, initializing the new instance with the given identifier.
default <C> void	runWithConnection(ConnectionConsumer<C> action)

Methods inherited from interface jakarta.persistence.EntityManager

close, contains, createNamedStoredProcedureQuery, createNativeQuery, createNativeQuery, createNativeQuery, createStoredProcedureQuery, createStoredProcedureQuery, createStoredProcedureQuery, find, find, find, find, find, getCriteriaBuilder, getDelegate, getEntityManagerFactory, getLockMode, getMetamodel, getProperties, getTransaction, isJoinedToTransaction, isOpen, joinTransaction, lock, lock, lock, refresh, refresh, refresh, refresh

Methods inherited from interface org.hibernate.resource.jdbc.spi.JdbcSessionOwner

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

Methods inherited from interface org.hibernate.engine.jdbc.LobCreationContext

execute, fromContext

Methods inherited from interface org.hibernate.query.QueryProducer

createMutationQuery, createNamedSelectionQuery, createNamedSelectionQuery, createSelectionQuery, createSelectionQuery, createSelectionQuery, createSelectionQuery

Methods inherited from interface org.hibernate.query.spi.QueryProducerImplementor

createMutationQuery, createMutationQuery, createMutationQuery, createNamedMutationQuery, createNamedQuery, createNamedQuery, createNativeMutationQuery, createNativeQuery, createNativeQuery, createNativeQuery, createNativeQuery, createNativeQuery, createQuery, createQuery, createQuery, createQuery, createQuery, createQuery, getCacheMode, getNamedNativeQuery, getNamedNativeQuery, getNamedQuery

Methods inherited from interface org.hibernate.Session

addEventListeners, byId, byId, byMultipleIds, byMultipleIds, byMultipleNaturalId, byMultipleNaturalId, byNaturalId, byNaturalId, bySimpleNaturalId, bySimpleNaturalId, cancelQuery, clear, contains, createNamedQuery, createNamedQuery, createQuery, createQuery, createQuery, createQuery, createQuery, createQuery, detach, disableFetchProfile, enableFetchProfile, evict, find, findMultiple, findMultiple, flush, get, get, get, get, get, get, getCacheMode, getCacheRetrieveMode, getCacheStoreMode, getCurrentLockMode, getEntityGraphs, getEntityName, getFetchBatchSize, getFlushMode, getHibernateFlushMode, getIdentifier, getLobHelper, getManagedEntities, getManagedEntities, getManagedEntities, getManagedEntities, getReference, getReference, getReference, getStatistics, isDefaultReadOnly, isDirty, isFetchProfileEnabled, isReadOnly, isSubselectFetchingEnabled, load, lock, lock, lock, merge, merge, merge, persist, persist, refresh, refresh, remove, replicate, replicate, sessionWithOptions, setCacheMode, setCacheRetrieveMode, setCacheStoreMode, setDefaultReadOnly, setFetchBatchSize, setFlushMode, setHibernateFlushMode, setProperty, setReadOnly, setSubselectFetchingEnabled, unwrap

Methods inherited from interface org.hibernate.SharedSessionContract

beginTransaction, close, createEntityGraph, createNamedStoredProcedureQuery, createStoredProcedureCall, createStoredProcedureCall, createStoredProcedureCall, createStoredProcedureQuery, createStoredProcedureQuery, createStoredProcedureQuery, disableFilter, doReturningWork, doWork, enableFilter, fromTransaction, getCriteriaBuilder, getEnabledFilter, getJdbcBatchSize, getNamedProcedureCall, getTenantIdentifier, getTenantIdentifierValue, getTransaction, inTransaction, isConnected, isJoinedToTransaction, isOpen, joinTransaction, setJdbcBatchSize

Methods inherited from interface org.hibernate.engine.spi.SharedSessionContractImplementor

accessTransaction, afterOperation, afterScrollOperation, asEventSource, asSessionImplementor, asStatelessSession, autoFlushIfRequired, autoFlushIfRequired, autoPreFlush, bestGuessEntityName, bestGuessEntityName, checkOpen, checkOpen, checkTransactionNeededForUpdateOperation, flush, generateEntityKey, getCacheTransactionSynchronization, getConfiguredJdbcBatchSize, getContextEntityIdentifier, getDialect, getEntityPersister, getEntityUsingInterceptor, getEventListenerManager, getExceptionConverter, getFactory, getHibernateFlushMode, getInterceptor, getJdbcCoordinator, getJdbcServices, getLoadQueryInfluencers, getNativeJdbcParametersIgnored, getPersistenceContext, getPersistenceContextInternal, getSessionIdentifier, getSessionToken, getTypeConfiguration, guessEntityName, immediateLoad, initializeCollection, instantiate, internalLoad, isClosed, isCriteriaCopyTreeEnabled, isCriteriaPlanCacheEnabled, isDefaultReadOnly, isEventSource, isIdentifierRollbackEnabled, isOpenOrWaitingForAutoClose, isSessionImplementor, isStatelessSession, isTransactionInProgress, loadFromSecondLevelCache, lock, markForRollbackOnly, prepareForQueryExecution, registerProcess, setCriteriaCopyTreeEnabled, setCriteriaPlanCacheEnabled, setNativeJdbcParametersIgnored

Methods inherited from interface org.hibernate.resource.transaction.spi.TransactionCoordinatorBuilder.Options

shouldAutoJoinTransaction

Methods inherited from interface org.hibernate.type.descriptor.WrapperOptions

getJdbcTimeZone, getJsonFormatMapper, getLobCreator, getPreferredSqlTypeCodeForBoolean, getXmlFormatMapper, useStreamForLobBinding

Method Details

getSession

default SessionImplementor getSession()

Description copied from interface: SharedSessionContractImplementor

Returns this object, fulfilling the contract of WrapperOptions.

Specified by:

getSession in interface SharedSessionContractImplementor

Specified by:

getSession in interface WrapperOptions

getSessionFactory

SessionFactoryImplementor getSessionFactory()

Description copied from interface: Session

Get the session factory which created this session.

Specified by:

getSessionFactory in interface Session

Specified by:

getSessionFactory in interface SharedSessionContractImplementor

Specified by:

getSessionFactory in interface WrapperOptions

Returns:

the session factory

See Also:

• SessionFactory

createEntityGraph

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

Description copied from interface: Session

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 EntityManager

Specified by:

createEntityGraph in interface Session

Specified by:

createEntityGraph in interface SharedSessionContract

Parameters:

rootType - The root entity of the graph

See Also:

• EntityManager.find(EntityGraph, Object, FindOption...)
• SelectionQuery.setEntityGraph(EntityGraph, org.hibernate.graph.GraphSemantic)
• EntityGraphs.createGraph(jakarta.persistence.metamodel.EntityType)

createEntityGraph

RootGraphImplementor<?> createEntityGraph(String graphName)

Description copied from interface: Session

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 EntityManager

Specified by:

createEntityGraph in interface Session

Specified by:

createEntityGraph in interface SharedSessionContract

Parameters:

graphName - The name of the predefined named entity graph

See Also:

• EntityManager.find(EntityGraph, Object, FindOption...)
• SelectionQuery.setEntityGraph(EntityGraph, org.hibernate.graph.GraphSemantic)
• EntityManagerFactory.addNamedEntityGraph(String, EntityGraph)

getEntityGraph

RootGraphImplementor<?> getEntityGraph(String graphName)

Description copied from interface: Session

Obtain an immutable reference to a predefined named entity graph or return null if there is no predefined graph with the given name.

Specified by:

getEntityGraph in interface EntityManager

Specified by:

getEntityGraph in interface Session

Specified by:

getEntityGraph in interface SharedSessionContract

Parameters:

graphName - The name of the predefined named entity graph

See Also:

• EntityManager.find(EntityGraph, Object, FindOption...)
• SelectionQuery.setEntityGraph(EntityGraph, org.hibernate.graph.GraphSemantic)
• EntityManagerFactory.addNamedEntityGraph(String, EntityGraph)

createQuery

<T> QueryImplementor<T> createQuery(CriteriaSelect<T> selectQuery)

Specified by:

createQuery in interface EntityManager

getActionQueue

ActionQueue getActionQueue()

Get the ActionQueue associated with this session.

instantiate

Object instantiate(EntityPersister persister,
 Object id)
            throws HibernateException

Description copied from interface: SharedSessionContractImplementor

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

This is more efficient than SharedSessionContractImplementor.instantiate(String, Object), but not always interchangeable, since a single persister might be responsible for multiple types.

Specified by:

instantiate in interface SharedSessionContractImplementor

Throws:

HibernateException

forceFlush

void forceFlush(EntityEntry e)
         throws HibernateException

Initiate a flush to force deletion of a re-persisted entity.

Throws:

HibernateException

forceFlush

void forceFlush(EntityKey e)
         throws HibernateException

Initiate a flush to force deletion of a re-persisted entity.

Throws:

HibernateException

runWithConnection

default <C> void runWithConnection(ConnectionConsumer<C> action)

Specified by:

runWithConnection in interface EntityManager

callWithConnection

default <C,
T> T callWithConnection(ConnectionFunction<C,T> function)

Specified by:

callWithConnection in interface EntityManager