Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.engine.spi.SessionImplementor

Defines the "internal contract" between Session and other parts of Hibernate including implementors of org.hibernate.type.Type, EntityPersister, and org.hibernate.persister.collection.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 org.hibernate.resource.transaction.spi.TransactionCoordinatorBuilder#buildTransactionCoordinator
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 org.hibernate.type.descriptor.jdbc.JdbcType.

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

Modifier and Type	Method and Description
public default SessionImplementor	asSessionImplementor() Overrides default org.hibernate.engine.spi.SharedSessionContractImplementor.asSessionImplementor. Cast this object to `SessionImplementor`, if possible.
public <T> RootGraphImplementor<T>	createEntityGraph(Class<T> the root entity class of the graph rootType) Redeclares org.hibernate.Session.createEntityGraph, org.hibernate.SharedSessionContract.createEntityGraph. Create a new mutable `EntityGraph` with only a root node.
public RootGraphImplementor<?>	createEntityGraph(String the name of the graph graphName) Redeclares org.hibernate.Session.createEntityGraph, org.hibernate.SharedSessionContract.createEntityGraph. Create a new mutable copy of the named `EntityGraph`, or return `null` if there is no graph with the given name.
public void	delete(String entityName, Object child, boolean isCascadeDeleteEnabled, DeleteContext transientEntities) Deprecated OperationalContext should cover this overload I believe
public void	forceFlush(EntityEntry e) Initiate a flush to force deletion of a re-persisted entity.
public void	forceFlush(EntityKey e) Initiate a flush to force deletion of a re-persisted entity.
public ActionQueue	getActionQueue() Get the `ActionQueue` associated with this session.
public RootGraphImplementor<?>	getEntityGraph(String the name of the graph graphName) Redeclares org.hibernate.Session.getEntityGraph, org.hibernate.SharedSessionContract.getEntityGraph. Retrieve the named `EntityGraph` as an immutable graph, or return `null` if there is no graph with the given name.
public default SessionImplementor	getSession() Overrides default org.hibernate.engine.spi.SharedSessionContractImplementor.getSession. Returns this object, fulfilling the contract of `WrapperOptions`.
public SessionFactoryImplementor	getSessionFactory() Redeclares org.hibernate.Session.getSessionFactory. Redeclares as abstract: org.hibernate.engine.spi.SharedSessionContractImplementor.getSessionFactory. Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. Get the session factory which created this session.
public Object	instantiate(EntityPersister persister, Object id) Redeclares org.hibernate.engine.spi.SharedSessionContractImplementor.instantiate. Instantiate the entity class of the given `EntityPersister`, initializing the new instance with the given identifier.
public default boolean	isSessionImplementor() Overrides default org.hibernate.engine.spi.SharedSessionContractImplementor.isSessionImplementor. Does this object implement `SessionImplementor`?
public void	lock(String entityName, Object child, LockOptions lockOptions) Cascade the lock operation to the given child entity.
public void	merge(String entityName, Object object, MergeContext copiedAlready) Deprecated OperationalContext should cover this overload I believe
public void	persist(String entityName, Object object, PersistContext createdAlready) Deprecated OperationalContext should cover this overload I believe
public void	persistOnFlush(String entityName, Object object, PersistContext copiedAlready) Deprecated OperationalContext should cover this overload I believe
public void	refresh(String entityName, Object object, RefreshContext refreshedAlready) Deprecated OperationalContext should cover this overload I believe
public void	removeOrphanBeforeUpdates(String entityName, Object child) Deprecated OperationalContext should cover this overload I believe

Modifier and Type

Method and Description

public default SessionImplementor

asSessionImplementor()

Overrides default org.hibernate.engine.spi.SharedSessionContractImplementor.asSessionImplementor.

Cast this object to SessionImplementor, if possible.

public <T> RootGraphImplementor<T>

createEntityGraph(Class<T>

the root entity class of the graph

rootType)

Redeclares org.hibernate.Session.createEntityGraph, org.hibernate.SharedSessionContract.createEntityGraph.

Create a new mutable EntityGraph with only a root node.

public RootGraphImplementor<?>

createEntityGraph(String

the name of the graph

graphName)

Redeclares org.hibernate.Session.createEntityGraph, org.hibernate.SharedSessionContract.createEntityGraph.

Create a new mutable copy of the named EntityGraph, or return null if there is no graph with the given name.

public void

delete(String entityName, Object child, boolean isCascadeDeleteEnabled, DeleteContext transientEntities)

Deprecated OperationalContext should cover this overload I believe

public void

forceFlush(EntityEntry e)

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

public void

forceFlush(EntityKey e)

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

public ActionQueue

getActionQueue()

Get the ActionQueue associated with this session.

public RootGraphImplementor<?>

getEntityGraph(String

the name of the graph

graphName)

Redeclares org.hibernate.Session.getEntityGraph, org.hibernate.SharedSessionContract.getEntityGraph.

Retrieve the named EntityGraph as an immutable graph, or return null if there is no graph with the given name.

public default SessionImplementor

getSession()

Overrides default org.hibernate.engine.spi.SharedSessionContractImplementor.getSession.

Returns this object, fulfilling the contract of WrapperOptions.

public SessionFactoryImplementor

getSessionFactory()

Redeclares org.hibernate.Session.getSessionFactory.

Redeclares as abstract: org.hibernate.engine.spi.SharedSessionContractImplementor.getSessionFactory.

Deprecated as a consequence of SessionFactoryImplementor being deprecated.

Get the session factory which created this session.

public Object

instantiate(EntityPersister persister, Object id)

Redeclares org.hibernate.engine.spi.SharedSessionContractImplementor.instantiate.

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

public default boolean

isSessionImplementor()

Overrides default org.hibernate.engine.spi.SharedSessionContractImplementor.isSessionImplementor.

Does this object implement SessionImplementor?

public void

lock(String entityName, Object child, LockOptions lockOptions)

Cascade the lock operation to the given child entity.

public void

merge(String entityName, Object object, MergeContext copiedAlready)

Deprecated OperationalContext should cover this overload I believe

public void

persist(String entityName, Object object, PersistContext createdAlready)

Deprecated OperationalContext should cover this overload I believe

public void

persistOnFlush(String entityName, Object object, PersistContext copiedAlready)

Deprecated OperationalContext should cover this overload I believe

public void

refresh(String entityName, Object object, RefreshContext refreshedAlready)

Deprecated OperationalContext should cover this overload I believe

public void

removeOrphanBeforeUpdates(String entityName, Object child)

Deprecated OperationalContext should cover this overload I believe

Method Detail

asSessionImplementor back to summary

asSessionImplementor	back to summary
public default SessionImplementor asSessionImplementor() Overrides default org.hibernate.engine.spi.SharedSessionContractImplementor.asSessionImplementor. Doc from org.hibernate.engine.spi.SharedSessionContractImplementor.asSessionImplementor. Cast this object to `SessionImplementor`, if possible. Annotations @Override

public default SessionImplementor asSessionImplementor()

Overrides default org.hibernate.engine.spi.SharedSessionContractImplementor.asSessionImplementor.

Doc from org.hibernate.engine.spi.SharedSessionContractImplementor.asSessionImplementor.

Cast this object to SessionImplementor, if possible.

Annotations

@Override

createEntityGraph back to summary

createEntityGraph	back to summary
public <T> RootGraphImplementor<T> createEntityGraph(Class<T> rootType) Redeclares org.hibernate.Session.createEntityGraph, org.hibernate.SharedSessionContract.createEntityGraph. Doc from org.hibernate.SharedSessionContract.createEntityGraph. Create a new mutable `EntityGraph` with only a root node. Parameters rootType:Class<T> the root entity class of the graph Returns:RootGraphImplementor<T> Doc from jakarta.persistence.EntityManager.createEntityGraph. entity graph Annotations @Override

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

Redeclares org.hibernate.Session.createEntityGraph, org.hibernate.SharedSessionContract.createEntityGraph.

Doc from org.hibernate.SharedSessionContract.createEntityGraph.

Create a new mutable EntityGraph with only a root node.

Parameters

rootType:Class<T>: the root entity class of the graph

Returns:RootGraphImplementor<T>

Doc from jakarta.persistence.EntityManager.createEntityGraph.

entity graph

Annotations

@Override

createEntityGraph back to summary

createEntityGraph	back to summary
public RootGraphImplementor<?> createEntityGraph(String graphName) Redeclares org.hibernate.Session.createEntityGraph, org.hibernate.SharedSessionContract.createEntityGraph. Doc from org.hibernate.SharedSessionContract.createEntityGraph. Create a new mutable copy of the named `EntityGraph`, or return `null` if there is no graph with the given name. Parameters graphName:String the name of the graph Returns:RootGraphImplementor<?> Doc from jakarta.persistence.EntityManager.createEntityGraph. entity graph Annotations @Override

public RootGraphImplementor<?> createEntityGraph(String graphName)

Redeclares org.hibernate.Session.createEntityGraph, org.hibernate.SharedSessionContract.createEntityGraph.

Doc from org.hibernate.SharedSessionContract.createEntityGraph.

Create a new mutable copy of the named EntityGraph, or return null if there is no graph with the given name.

Parameters

graphName:String: the name of the graph

Returns:RootGraphImplementor<?>

Doc from jakarta.persistence.EntityManager.createEntityGraph.

entity graph

Annotations

@Override

delete	back to summary
public void delete(String entityName, Object child, boolean isCascadeDeleteEnabled, DeleteContext transientEntities) Deprecated OperationalContext should cover this overload I believe Annotations @Deprecated

forceFlush	back to summary
public void forceFlush(EntityEntry e) throws HibernateException Initiate a flush to force deletion of a re-persisted entity.

forceFlush	back to summary
public void forceFlush(EntityKey e) throws HibernateException Initiate a flush to force deletion of a re-persisted entity.

getActionQueue	back to summary
public ActionQueue getActionQueue() Get the `ActionQueue` associated with this session.

getEntityGraph back to summary

getEntityGraph	back to summary
public RootGraphImplementor<?> getEntityGraph(String graphName) Redeclares org.hibernate.Session.getEntityGraph, org.hibernate.SharedSessionContract.getEntityGraph. Doc from org.hibernate.SharedSessionContract.getEntityGraph. Retrieve the named `EntityGraph` as an immutable graph, or return `null` if there is no graph with the given name. Parameters graphName:String the name of the graph Returns:RootGraphImplementor<?> Doc from jakarta.persistence.EntityManager.getEntityGraph. named entity graph Annotations @Override

public RootGraphImplementor<?> getEntityGraph(String graphName)

Redeclares org.hibernate.Session.getEntityGraph, org.hibernate.SharedSessionContract.getEntityGraph.

Doc from org.hibernate.SharedSessionContract.getEntityGraph.

Retrieve the named EntityGraph as an immutable graph, or return null if there is no graph with the given name.

Parameters

graphName:String: the name of the graph

Returns:RootGraphImplementor<?>

Doc from jakarta.persistence.EntityManager.getEntityGraph.

named entity graph

Annotations

@Override

getSession back to summary

getSession	back to summary
public default SessionImplementor getSession() Overrides default org.hibernate.engine.spi.SharedSessionContractImplementor.getSession. Doc from org.hibernate.engine.spi.SharedSessionContractImplementor.getSession. Returns this object, fulfilling the contract of `WrapperOptions`. Annotations @Override

public default SessionImplementor getSession()

Overrides default org.hibernate.engine.spi.SharedSessionContractImplementor.getSession.

Doc from org.hibernate.engine.spi.SharedSessionContractImplementor.getSession.

Returns this object, fulfilling the contract of WrapperOptions.

Annotations

@Override

getSessionFactory back to summary

getSessionFactory	back to summary
public SessionFactoryImplementor getSessionFactory() Redeclares org.hibernate.Session.getSessionFactory. Redeclares as abstract: org.hibernate.engine.spi.SharedSessionContractImplementor.getSessionFactory. Doc from org.hibernate.Session.getSessionFactory. Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. See corresponding docs for further information. Get the session factory which created this session. Returns:SessionFactoryImplementor the session factory Annotations @Override

public SessionFactoryImplementor getSessionFactory()

Redeclares org.hibernate.Session.getSessionFactory.

Redeclares as abstract: org.hibernate.engine.spi.SharedSessionContractImplementor.getSessionFactory.

Doc from org.hibernate.Session.getSessionFactory.

Deprecated

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

Get the session factory which created this session.

Returns:SessionFactoryImplementor

the session factory

Annotations

@Override

instantiate back to summary

instantiate	back to summary
public Object instantiate(EntityPersister persister, Object id) throws HibernateException Redeclares org.hibernate.engine.spi.SharedSessionContractImplementor.instantiate. Doc from org.hibernate.engine.spi.SharedSessionContractImplementor.instantiate. Instantiate the entity class of the given `EntityPersister`, initializing the new instance with the given identifier. This is more efficient than `instantiate(String, Object)`, but not always interchangeable, since a single persister might be responsible for multiple types.

public Object instantiate(EntityPersister persister, Object id) throws HibernateException

Redeclares org.hibernate.engine.spi.SharedSessionContractImplementor.instantiate.

Doc from org.hibernate.engine.spi.SharedSessionContractImplementor.instantiate.

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

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

isSessionImplementor back to summary

isSessionImplementor	back to summary
public default boolean isSessionImplementor() Overrides default org.hibernate.engine.spi.SharedSessionContractImplementor.isSessionImplementor. Doc from org.hibernate.engine.spi.SharedSessionContractImplementor.isSessionImplementor. Does this object implement `SessionImplementor`? Annotations @Override

public default boolean isSessionImplementor()

Overrides default org.hibernate.engine.spi.SharedSessionContractImplementor.isSessionImplementor.

Doc from org.hibernate.engine.spi.SharedSessionContractImplementor.isSessionImplementor.

Does this object implement SessionImplementor?

Annotations

@Override

lock	back to summary
public void lock(String entityName, Object child, LockOptions lockOptions) Cascade the lock operation to the given child entity.

merge	back to summary
public void merge(String entityName, Object object, MergeContext copiedAlready) throws HibernateException Deprecated OperationalContext should cover this overload I believe Annotations @Deprecated

persist	back to summary
public void persist(String entityName, Object object, PersistContext createdAlready) throws HibernateException Deprecated OperationalContext should cover this overload I believe Annotations @Deprecated

persistOnFlush	back to summary
public void persistOnFlush(String entityName, Object object, PersistContext copiedAlready) Deprecated OperationalContext should cover this overload I believe Annotations @Deprecated

refresh	back to summary
public void refresh(String entityName, Object object, RefreshContext refreshedAlready) throws HibernateException Deprecated OperationalContext should cover this overload I believe Annotations @Deprecated

removeOrphanBeforeUpdates	back to summary
public void removeOrphanBeforeUpdates(String entityName, Object child) Deprecated OperationalContext should cover this overload I believe Annotations @Deprecated

public Interface SessionImplementor

Method Summary

Method Detail