Class SessionLazyDelegator

java.lang.Object

org.hibernate.engine.spi.SessionLazyDelegator

All Implemented Interfaces:

EntityHandler, EntityManager, Serializable, AutoCloseable, Session, SharedSessionContract

public class SessionLazyDelegator
extends Object
implements Session

This helper class allows decorating a Session instance, while the instance itself is lazily provided via a Supplier. When the decorated instance is readily available, one should prefer using SessionDelegatorBaseImpl.

Another difference with SessionDelegatorBaseImpl is that this type only implements Session.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface EntityManager

EntityManager.CreationOption, EntityManager.Option

Constructor Summary

Constructors

Constructor	Description
SessionLazyDelegator(Supplier<Session> lazySessionLookup)

Method Summary

Modifier and Type	Method	Description
void	addEventListeners(SessionEventListener... listeners)	Add one or more listeners to the Session
void	addOption(EntityManager.Option option)
Transaction	beginTransaction()	Begin a unit of work and return the associated Transaction object.
<T> IdentifierLoadAccess<T>	byId(Class<T> entityClass)	Create an IdentifierLoadAccess instance to retrieve an instance of the given entity type by its primary key.
<T> IdentifierLoadAccess<T>	byId(String entityName)	Create an IdentifierLoadAccess instance to retrieve an instance of the named entity type by its primary key.
<T> MultiIdentifierLoadAccess<T>	byMultipleIds(Class<T> entityClass)	Create a MultiIdentifierLoadAccess instance to retrieve multiple instances of the given entity type by their primary key values, using batching.
<T> MultiIdentifierLoadAccess<T>	byMultipleIds(String entityName)	Create a MultiIdentifierLoadAccess instance to retrieve multiple instances of the named entity type by their primary key values, using batching.
<T> NaturalIdMultiLoadAccess<T>	byMultipleNaturalId(Class<T> entityClass)	Deprecated.
<T> NaturalIdMultiLoadAccess<T>	byMultipleNaturalId(String entityName)	Deprecated.
<T> NaturalIdLoadAccess<T>	byNaturalId(Class<T> entityClass)	Deprecated.
<T> NaturalIdLoadAccess<T>	byNaturalId(String entityName)	Deprecated.
<T> SimpleNaturalIdLoadAccess<T>	bySimpleNaturalId(Class<T> entityClass)	Deprecated.
<T> SimpleNaturalIdLoadAccess<T>	bySimpleNaturalId(String entityName)	Deprecated.
<C,T> T	callWithConnection(ConnectionFunction<C,T> function)
void	cancelQuery()	Cancel the execution of the current query.
void	clear()	Completely clear the persistence context.
void	close()	End the session by releasing the JDBC connection and cleaning up.
boolean	contains(Object entity)
boolean	contains(String entityName, Object object)	Determine if the given entity is associated with this session.
<T> RootGraph<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.
<T> RootGraph<T>	createEntityGraph(Class<T> rootType, String graphName)	Deprecated.
RootGraph<?>	createEntityGraph(String graphName)	Deprecated.
MutationQuery	createMutationQuery(CriteriaStatement<?> criteriaStatement)	Create a MutationQuery from the given update criteria tree
MutationQuery	createMutationQuery(String hqlString)	Create a MutationQuery reference for the given HQL insert, update, or delete statement.
MutationQuery	createMutationQuery(JpaCriteriaInsert insert)	Create a MutationQuery from the given insert criteria tree
MutationQuery	createNamedMutationQuery(String name)	Create a MutationQuery instance for the given named insert, update, or delete HQL query.
MutationOrSelectionQuery	createNamedQuery(String name)	Create an instance of Query for the given named query or statement, without indicating the expected result type, if any, nor whether the query is a typed query which returns a result list, or an update, delete, or insert statement.
<R> SelectionQuery<R>	createNamedQuery(String name, Class<R> resultClass)	Create a typed Query instance for the given named query.
<R> NativeQuery<R>	createNamedQuery(String name, String resultSetMappingName)
<R> NativeQuery<R>	createNamedQuery(String name, String resultSetMappingName, Class<R> resultClass)
<R> SelectionQuery<R>	createNamedSelectionQuery(String name, Class<R> resultType)	Create a SelectionQuery instance for the named NamedQuery with the given result type.
MutationQuery	createNamedStatement(String name)
ProcedureCall	createNamedStoredProcedureQuery(String name)	Obtain a ProcedureCall based on a named template
MutationQuery	createNativeMutationQuery(String sqlString)	Create a NativeQuery instance for the given native SQL statement.
NativeQuery	createNativeQuery(String sqlString)	Deprecated.
<T> TypedQuery<T>	createNativeQuery(String sql, jakarta.persistence.sql.ResultSetMapping<T> resultSetMapping)
NativeQuery	createNativeQuery(String sqlString, Class resultClass)	Create a NativeQuery instance for the given native SQL query using an implicit mapping to the specified Java type.
<R> NativeQuery<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.
NativeQuery	createNativeQuery(String sqlString, String resultSetMappingName)	Deprecated.
<R> NativeQuery<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.
MutationQuery	createNativeStatement(String sql)
<T> SelectionQuery<T>	createQuery(CriteriaSelect<T> selectQuery)
MutationQuery	createQuery(CriteriaStatement<?> criteriaStatement)
<R> SelectionQuery<R>	createQuery(TypedQueryReference<R> typedQueryReference)	Create a typed Query instance for the given typed query reference.
MutationOrSelectionQuery	createQuery(String queryString)	Create an instance of Query for the given HQL query or statement, without indicating the expected result type, if any, nor whether the query is a typed query which returns a result list, or an update, delete, or insert statement.
<T> SelectionQuery<T>	createQuery(String query, EntityGraph<T> entityGraph)
<R> SelectionQuery<R>	createQuery(String queryString, Class<R> resultClass)	Create a typed Query instance for the given HQL query string and given query result type.
<R> SelectionQuery<R>	createSelectionQuery(CriteriaQuery<R> criteria)	Create a SelectionQuery reference for the given CriteriaQuery.
<R> SelectionQuery<R>	createSelectionQuery(CriteriaSelect<R> criteria)	Create a SelectionQuery reference for the given CriteriaQuery.
<R> SelectionQuery<R>	createSelectionQuery(String hqlString, EntityGraph<R> resultGraph)	Create a SelectionQuery instance for the given HQL query string and given EntityGraph, which is interpreted as a load graph.
<R> SelectionQuery<R>	createSelectionQuery(String hqlString, Class<R> resultType)	Create a SelectionQuery instance for the given HQL query string and given query result type.
MutationQuery	createStatement(CriteriaStatement<?> criteriaStatement)
MutationQuery	createStatement(StatementReference statementReference)
MutationQuery	createStatement(String hqlString)
ProcedureCall	createStoredProcedureCall(String procedureName)	Create a ProcedureCall to a stored procedure.
ProcedureCall	createStoredProcedureCall(String procedureName, Class<?>... resultClasses)	Create a ProcedureCall to a stored procedure with the given result set entity mappings.
ProcedureCall	createStoredProcedureCall(String procedureName, String... resultSetMappings)	Create a ProcedureCall to a stored procedure with the given result set entity mappings.
ProcedureCall	createStoredProcedureQuery(String procedureName)	Create a ProcedureCall to a stored procedure.
ProcedureCall	createStoredProcedureQuery(String procedureName, Class... resultClasses)	Create a ProcedureCall to a stored procedure with the given result set entity mappings.
ProcedureCall	createStoredProcedureQuery(String procedureName, String... resultSetMappings)	Create a ProcedureCall to a stored procedure with the given result set entity mappings.
void	detach(Object object)	Remove this instance from the session cache.
void	disableFetchProfile(String name)	Disable the fetch profile with the given name in this session.
void	disableFilter(String filterName)	Disable the named filter for the current session.
<T> T	doReturningWork(ReturningWork<T> work)	Perform work using the Connection underlying by this session, and return a result.
void	doWork(Work work)	Perform work using the Connection underlying by this session.
void	enableFetchProfile(String name)	Enable the fetch profile with the given name in this session.
Filter	enableFilter(String filterName)	Enable the named filter for this current session.
void	evict(Object object)	Remove this instance from the session cache.
<T> T	find(EntityGraph<T> entityGraph, Object primaryKey, FindOption... options)
<T> T	find(Class<T> entityClass, Object primaryKey)	Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
<T> T	find(Class<T> entityClass, Object primaryKey, FindOption... options)	The option KeyType.NATURAL specifies that the given id should be interpreted as a natural id.
<T> T	find(Class<T> entityClass, Object primaryKey, LockModeType lockMode, Map<String,Object> properties)
<T> T	find(Class<T> entityClass, Object primaryKey, Map<String,Object> properties)
Object	find(String entityName, Object primaryKey, FindOption... options)	Corollary to EntityHandler.find(Class,Object,FindOption...) for dynamic models.
<E> List<E>	findMultiple(EntityGraph<E> entityGraph, List<?> ids, FindOption... options)	Return the persistent instances of the root entity of the given EntityGraph with the given identifiers as a list, fetching the associations specified by the graph, which is interpreted as a load graph.
<E> List<E>	findMultiple(Class<E> entityType, List<?> ids, FindOption... options)	Return the persistent instances of the given entity class with the given identifiers as a list.
void	flush()	Force this session to flush.
<T> T	get(EntityGraph<T> entityGraph, Object key, FindOption... findOptions)
<T> T	get(Class<T> entityType, Object id)
<T> T	get(Class<T> entityType, Object key, FindOption... findOptions)
<T> T	get(Class<T> entityType, Object id, LockMode lockMode)	Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
<T> T	get(Class<T> entityType, Object id, LockOptions lockOptions)	Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
Object	get(String entityName, Object key, FindOption... findOptions)	Form of SharedSessionContract.find(String,Object,FindOption...) throwing EntityNotFoundException if no entity exists for that id rather than returning null.
Object	get(String entityName, Object id, LockMode lockMode)	Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
Object	get(String entityName, Object id, LockOptions lockOptions)	Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
CacheMode	getCacheMode()	Get the current cache mode for this session.
CacheRetrieveMode	getCacheRetrieveMode()	The JPA-defined CacheRetrieveMode.
CacheStoreMode	getCacheStoreMode()	The JPA-defined CacheStoreMode.
HibernateCriteriaBuilder	getCriteriaBuilder()	Obtain a HibernateCriteriaBuilder which may be used to construct criteria queries.
LockMode	getCurrentLockMode(Object object)	Determine the current lock mode held on the given managed instance associated with this session.
Object	getDelegate()	Deprecated.
Filter	getEnabledFilter(String filterName)	Retrieve a currently enabled filter by name.
<T> RootGraph<T>	getEntityGraph(Class<T> entityClass, String name)	Obtain a mutable copy of a predefined named entity graph whose root type is exactly the given entity type.
RootGraph<?>	getEntityGraph(String graphName)	Obtain a mutable copy of a predefined named entity graph.
<T> List<EntityGraph<? super T>>	getEntityGraphs(Class<T> entityClass)	Retrieve all named EntityGraphs with the given root entity type.
EntityManagerFactory	getEntityManagerFactory()
String	getEntityName(Object object)	Return the entity name for the given persistent entity.
SessionFactory	getFactory()	The factory which created this session.
int	getFetchBatchSize()	Get the maximum batch size for batch fetching associations by id in this session.
FlushModeType	getFlushMode()	Get the current JPA flush mode for this session.
FlushMode	getHibernateFlushMode()	Get the current flush mode for this session.
Object	getIdentifier(Object object)	Return the identifier value of the given entity associated with this session.
Integer	getJdbcBatchSize()	Get the session-level JDBC batch size for the current session.
LobHelper	getLobHelper()	Obtain a LobHelper for instances of Blob and Clob.
LockModeType	getLockMode(Object entity)
Collection<?>	getManagedEntities()	Obtain the collection of all managed entities which belong to this persistence context.
<E> Collection<E>	getManagedEntities(EntityType<E> entityType)	Obtain a collection of all managed entities of the given type which belong to this persistence context.
<E> Collection<E>	getManagedEntities(Class<E> entityType)	Obtain a collection of all managed entities of the given type which belong to this persistence context.
Collection<?>	getManagedEntities(String entityName)	Obtain a collection of all managed instances of the entity type with the given entity name which belong to this persistence context.
Metamodel	getMetamodel()
<T> List<T>	getMultiple(EntityGraph<T> entityGraph, List<?> keys, FindOption... findOptions)
<T> List<T>	getMultiple(Class<T> entityType, List<?> keys, FindOption... findOptions)
NativeQuery	getNamedNativeQuery(String name)	Deprecated.
ProcedureCall	getNamedProcedureCall(String name)	Obtain a ProcedureCall based on a named template
Set<EntityManager.Option>	getOptions()
Map<String,Object>	getProperties()
<T> T	getReference(Class<T> entityType, Object id)	Return a reference to the persistent instance with the given class and identifier, making the assumption that the instance is still persistent in the database.
<T> T	getReference(Class<T> entityType, Object key, KeyType keyType)	Return a reference to the persistent instance of the given entity type with the given key, which is interpreted according to the given KeyType, making the assumption that the instance is still persistent in the database.
Object	getReference(String entityName, Object id)	Return a reference to the persistent instance of the given named entity with the given identifier, making the assumption that the instance is still persistent in the database.
<T> T	getReference(T object)	Return a reference to the persistent instance with the same identity as the given instance, which might be detached, making the assumption that the instance is still persistent in the database.
SessionFactory	getSessionFactory()	Get the session factory which created this session.
SessionStatistics	getStatistics()	Get the statistics for this session.
String	getTenantIdentifier()	Obtain the tenant identifier associated with this session, as a string.
Object	getTenantIdentifierValue()	Obtain the tenant identifier associated with this session.
Transaction	getTransaction()	Get the Transaction instance associated with this session.
boolean	isConnected()	Check if the session is currently connected.
boolean	isDefaultReadOnly()	Will entities and proxies that are loaded into this session be made read-only by default?
boolean	isDirty()	Whether this session contains any changes which must be synchronized with the database.
boolean	isFetchProfileEnabled(String name)	Is the fetch profile with the given name enabled in this session?
boolean	isJoinedToTransaction()	Check if the session is joined to the current transaction.
boolean	isOpen()	Check if the session is still open.
boolean	isReadOnly(Object entityOrProxy)	Is the specified entity or proxy read-only?
boolean	isSubselectFetchingEnabled()	Determine if subselect fetching is enabled in this session.
void	joinTransaction()	Join the currently active JTA transaction.
void	load(Object object, Object id)	Read the persistent state associated with the given identifier into the given transient instance.
void	lock(Object entity, LockModeType lockMode)
void	lock(Object entity, LockModeType lockMode, LockOption... options)
void	lock(Object entity, LockModeType lockMode, Map<String,Object> properties)
void	lock(Object object, LockMode lockMode)	Obtain the specified lock level on the given managed instance associated with this session.
void	lock(Object object, LockMode lockMode, LockOption... lockOptions)	Obtain the specified lock level on the given managed instance associated with this session, applying any other specified options.
void	lock(Object object, LockOptions lockOptions)	Obtain a lock on the given managed instance associated with this session, using the given lock options.
<T> T	merge(String entityName, T object)	Copy the state of the given object onto the persistent object with the same identifier.
<T> T	merge(T object)	Copy the state of the given object onto the persistent object with the same identifier.
<T> T	merge(T object, EntityGraph<? super T> loadGraph)	Copy the state of the given object onto the persistent object with the same identifier.
void	persist(Object object)	Make a transient instance persistent and mark it for later insertion in the database.
void	persist(String entityName, Object object)	Make a transient instance persistent and mark it for later insertion in the database.
void	refresh(Object object)	Reread the state of the given managed instance associated with this session from the underlying database.
void	refresh(Object entity, LockModeType lockMode, Map<String,Object> properties)
void	refresh(Object entity, RefreshOption... options)
void	refresh(Object entity, Map<String,Object> properties)
void	refresh(Object object, LockOptions lockOptions)	Reread the state of the given managed instance from the underlying database, obtaining the given LockMode.
void	remove(Object object)	Mark a persistence instance associated with this session for removal from the underlying database.
<C> void	runWithConnection(ConnectionConsumer<C> action)
SharedSessionBuilder	sessionWithOptions()	Obtain a Session builder with the ability to copy certain information from this session.
void	setCacheMode(CacheMode cacheMode)	Set the current cache mode for this session.
void	setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)	Enable or disable reads from the second-level cache.
void	setCacheStoreMode(CacheStoreMode cacheStoreMode)	Enable or disable writes to the second-level cache.
void	setDefaultReadOnly(boolean readOnly)	Change the default for entities and proxies loaded into this session from modifiable to read-only mode, or from read-only to modifiable mode.
void	setFetchBatchSize(int batchSize)	Set the maximum batch size for batch fetching associations by id in this session.
void	setFlushMode(FlushModeType flushMode)	Set the current JPA flush mode for this session.
void	setHibernateFlushMode(FlushMode flushMode)	Set the current flush mode for this session.
void	setJdbcBatchSize(Integer jdbcBatchSize)	Set the session-level JDBC batch size.
void	setProperty(String propertyName, Object value)	Set a hint.
void	setReadOnly(Object entityOrProxy, boolean readOnly)	Set an unmodified persistent object to read-only mode, or a read-only object to modifiable mode.
void	setSubselectFetchingEnabled(boolean enabled)	Enable or disable subselect fetching in this session.
SharedStatelessSessionBuilder	statelessWithOptions()	Obtain a StatelessSession builder with the ability to copy certain information from this session.
<T> T	unwrap(Class<T> type)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface SharedSessionContract

createNativeQuery, createQuery, find, fromTransaction, get, inTransaction

Constructor Details

SessionLazyDelegator

public SessionLazyDelegator(Supplier<Session> lazySessionLookup)

Method Details

getFactory

@Nonnull
public SessionFactory getFactory()

Description copied from interface: SharedSessionContract

The factory which created this session.

Specified by:

getFactory in interface SharedSessionContract

flush

public void flush()

Description copied from interface: Session

Force this session to flush. Must be called at the end of a unit of work, before the transaction is committed. Depending on the current flush mode, the session might automatically flush when EntityTransaction.commit() is called, and it is not necessary to call this method directly.

Flushing is the process of synchronizing the underlying persistent store with persistable state held in memory.

Specified by:

flush in interface EntityManager

Specified by:

flush in interface Session

setFlushMode

public void setFlushMode(@Nonnull
 FlushModeType flushMode)

Description copied from interface: Session

Set the current JPA flush mode for this session.

Flushing is the process of synchronizing the underlying persistent store with persistable state held in memory. The current flush mode determines when the session is automatically flushed.

Specified by:

setFlushMode in interface EntityManager

Specified by:

setFlushMode in interface Session

Parameters:

flushMode - the new FlushModeType

See Also:

• Session.setHibernateFlushMode(FlushMode)

setHibernateFlushMode

public void setHibernateFlushMode(FlushMode flushMode)

Description copied from interface: Session

Set the current flush mode for this session.

Flushing is the process of synchronizing the underlying persistent store with persistable state held in memory. The current flush mode determines when the session is automatically flushed.

The default flush mode is sometimes unnecessarily aggressive. For a logically "read only" session, it's reasonable to set the session's flush mode to FlushMode.MANUAL at the start of the session in order to avoid some unnecessary work.

Note that FlushMode defines more options than FlushModeType.

Specified by:

setHibernateFlushMode in interface Session

Parameters:

flushMode - the new FlushMode

getFlushMode

@Nonnull
public FlushModeType getFlushMode()

Description copied from interface: Session

Get the current JPA flush mode for this session.

Specified by:

getFlushMode in interface EntityManager

Specified by:

getFlushMode in interface Session

Returns:

the FlushModeType currently in effect

See Also:

• Session.getHibernateFlushMode()

getHibernateFlushMode

public FlushMode getHibernateFlushMode()

Description copied from interface: Session

Get the current flush mode for this session.

Specified by:

getHibernateFlushMode in interface Session

Returns:

the FlushMode currently in effect

setCacheMode

public void setCacheMode(@Nonnull
 CacheMode cacheMode)

Description copied from interface: Session

Set the current cache mode for this session.

The cache mode determines the manner in which this session can interact with the second level cache.

Specified by:

setCacheMode in interface Session

Specified by:

setCacheMode in interface SharedSessionContract

Parameters:

cacheMode - the new cache mode

setCacheRetrieveMode

public void setCacheRetrieveMode(@Nonnull
 CacheRetrieveMode cacheRetrieveMode)

Description copied from interface: Session

Enable or disable reads from the second-level cache.

Specified by:

setCacheRetrieveMode in interface EntityHandler

Specified by:

setCacheRetrieveMode in interface Session

Parameters:

cacheRetrieveMode - a JPA-defined CacheRetrieveMode

See Also:

• Session.setCacheMode(CacheMode)

setCacheStoreMode

public void setCacheStoreMode(@Nonnull
 CacheStoreMode cacheStoreMode)

Description copied from interface: Session

Enable or disable writes to the second-level cache.

Specified by:

setCacheStoreMode in interface EntityHandler

Specified by:

setCacheStoreMode in interface Session

Parameters:

cacheStoreMode - a JPA-defined CacheStoreMode

See Also:

• Session.setCacheMode(CacheMode)

getCacheStoreMode

@Nonnull
public CacheStoreMode getCacheStoreMode()

Description copied from interface: Session

The JPA-defined CacheStoreMode.

Specified by:

getCacheStoreMode in interface EntityHandler

Specified by:

getCacheStoreMode in interface Session

See Also:

• Session.getCacheMode()

getCacheRetrieveMode

@Nonnull
public CacheRetrieveMode getCacheRetrieveMode()

Description copied from interface: Session

The JPA-defined CacheRetrieveMode.

Specified by:

getCacheRetrieveMode in interface EntityHandler

Specified by:

getCacheRetrieveMode in interface Session

See Also:

• Session.getCacheMode()

addOption

public void addOption(@Nonnull
 EntityManager.Option option)

Specified by:

addOption in interface EntityManager

getOptions

@Nonnull
public Set<EntityManager.Option> getOptions()

Specified by:

getOptions in interface EntityManager

getCacheMode

@Nonnull
public CacheMode getCacheMode()

Description copied from interface: Session

Get the current cache mode for this session.

Specified by:

getCacheMode in interface Session

Specified by:

getCacheMode in interface SharedSessionContract

Returns:

the current cache mode

getSessionFactory

@Nonnull
public SessionFactory getSessionFactory()

Description copied from interface: Session

Get the session factory which created this session.

Specified by:

getSessionFactory in interface Session

Returns:

the session factory

See Also:

• SessionFactory

cancelQuery

public void cancelQuery()

Description copied from interface: Session

Cancel the execution of the current query.

This is the sole method on session which may be safely called from another thread.

Specified by:

cancelQuery in interface Session

isDirty

public boolean isDirty()

Description copied from interface: Session

Whether this session contains any changes which must be synchronized with the database. In other words, would any DML operations be executed if we flushed this session?

Specified by:

isDirty in interface Session

Returns:

true if the session contains pending changes; false otherwise.

isDefaultReadOnly

public boolean isDefaultReadOnly()

Description copied from interface: Session

Will entities and proxies that are loaded into this session be made read-only by default?

To determine the read-only/modifiable setting for a particular entity or proxy use Session.isReadOnly(Object).

Specified by:

isDefaultReadOnly in interface Session

Returns:

true, loaded entities/proxies will be made read-only by default; false, loaded entities/proxies will be made modifiable by default.

See Also:

• Session.isReadOnly(Object)

setDefaultReadOnly

public void setDefaultReadOnly(boolean readOnly)

Description copied from interface: Session

Change the default for entities and proxies loaded into this session from modifiable to read-only mode, or from read-only to modifiable mode.

Read-only entities are not dirty-checked, and snapshots of persistent state are not maintained. Read-only entities can be modified, but a modification to a field of a read-only entity is not made persistent.

When a proxy is initialized, the loaded entity will have the same read-only/modifiable setting as the uninitialized proxy, regardless of the current default read-only mode of the session.

To change the read-only/modifiable setting for a particular entity or proxy that already belongs to this session, use Session.setReadOnly(Object,boolean).

To override the default read-only mode of the current session for all entities and proxies returned by a given Query, use SelectionQuery.setReadOnly(boolean).

Every instance of an immutable entity is loaded in read-only mode.

Specified by:

setDefaultReadOnly in interface Session

Parameters:

readOnly - true, the default for loaded entities/proxies is read-only; false, the default for loaded entities/proxies is modifiable

See Also:

• Session.setReadOnly(Object,boolean)
• SelectionQuery.setReadOnly(boolean)

getIdentifier

@Nullable
public Object getIdentifier(@Nonnull
 Object object)

Description copied from interface: Session

Return the identifier value of the given entity associated with this session. An exception is thrown if the given entity instance is transient or detached in relation to this session.

Specified by:

getIdentifier in interface Session

Parameters:

object - a persistent instance associated with this session

Returns:

the identifier

contains

public boolean contains(@Nonnull
 String entityName,
 @Nonnull
 Object object)

Description copied from interface: Session

Determine if the given entity is associated with this session.

Specified by:

contains in interface Session

Parameters:

entityName - the entity name

object - an instance of a persistent class

Returns:

true if the given instance is associated with this Session

detach

public void detach(@Nonnull
 Object object)

Description copied from interface: Session

Remove this instance from the session cache. Changes to the instance will not be synchronized with the database. This operation cascades to associated instances if the association is mapped with CascadeType.DETACH.

Specified by:

detach in interface EntityManager

Specified by:

detach in interface Session

Parameters:

object - the managed instance to detach

evict

public void evict(@Nonnull
 Object object)

Description copied from interface: Session

Remove this instance from the session cache. Changes to the instance will not be synchronized with the database. This operation cascades to associated instances if the association is mapped with CascadeType.DETACH.

This operation is a synonym for Session.detach(Object).

Specified by:

evict in interface Session

Parameters:

object - the managed entity to evict

load

public void load(@Nonnull
 Object object,
 @Nonnull
 Object id)

Description copied from interface: Session

Read the persistent state associated with the given identifier into the given transient instance.

Specified by:

load in interface Session

Parameters:

object - a transient instance of an entity class

id - an identifier

merge

@Nonnull
public <T> T merge(@Nonnull
 T object)

Description copied from interface: Session

Copy the state of the given object onto the persistent object with the same identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If the given instance is unsaved, save a copy and return it as a newly persistent instance. The given instance does not become associated with the session. This operation cascades to associated instances if the association is mapped with CascadeType.MERGE.

Specified by:

merge in interface EntityManager

Specified by:

merge in interface Session

Parameters:

object - a detached instance with state to be copied

Returns:

an updated persistent instance

merge

@Nonnull
public <T> T merge(@Nonnull
 String entityName,
 @Nonnull
 T object)

Description copied from interface: Session

Copy the state of the given object onto the persistent object with the same identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If the given instance is unsaved, save a copy and return it as a newly persistent instance. The given instance does not become associated with the session. This operation cascades to associated instances if the association is mapped with CascadeType.MERGE.

Specified by:

merge in interface Session

Parameters:

entityName - the entity name

object - a detached instance with state to be copied

Returns:

an updated persistent instance

merge

@Nonnull
public <T> T merge(@Nonnull
 T object,
 @Nonnull
 EntityGraph<? super T> loadGraph)

Description copied from interface: Session

Copy the state of the given object onto the persistent object with the same identifier. If there is no persistent instance currently associated with the session, it is loaded using the given EntityGraph, which is interpreted as a load graph. Return the persistent instance. If the given instance is unsaved, save a copy and return it as a newly persistent instance. The given instance does not become associated with the session. This operation cascades to associated instances if the association is mapped with CascadeType.MERGE.

Specified by:

merge in interface Session

Parameters:

object - a detached instance with state to be copied

loadGraph - an entity graph interpreted as a load graph

Returns:

an updated persistent instance

persist

public void persist(@Nonnull
 Object object)

Description copied from interface: Session

Make a transient instance persistent and mark it for later insertion in the database. This operation cascades to associated instances if the association is mapped with CascadeType.PERSIST.

For entities with a generated id, persist() ultimately results in generation of an identifier for the given instance. But this may happen asynchronously, when the session is flushed, depending on the identifier generation strategy.

Specified by:

persist in interface EntityManager

Specified by:

persist in interface Session

Parameters:

object - a transient instance to be made persistent

persist

public void persist(String entityName,
 Object object)

Description copied from interface: Session

Make a transient instance persistent and mark it for later insertion in the database. This operation cascades to associated instances if the association is mapped with CascadeType.PERSIST.

For entities with a generated id, persist() ultimately results in generation of an identifier for the given instance. But this may happen asynchronously, when the session is flushed, depending on the identifier generation strategy.

Specified by:

persist in interface Session

Parameters:

entityName - the entity name

object - a transient instance to be made persistent

lock

public void lock(@Nonnull
 Object object,
 @Nonnull
 LockMode lockMode)

Description copied from interface: Session

Obtain the specified lock level on the given managed instance associated with this session. This operation may be used to:

• perform a version check on an entity read from the second-level cache by requesting LockMode.READ,
• schedule a version check at transaction commit by requesting LockMode.OPTIMISTIC,
• schedule a version increment at transaction commit by requesting LockMode.OPTIMISTIC_FORCE_INCREMENT
• upgrade to a pessimistic lock with LockMode.PESSIMISTIC_READ or LockMode.PESSIMISTIC_WRITE, or
• immediately increment the version of the given instance by requesting LockMode.PESSIMISTIC_FORCE_INCREMENT.

If the requested lock mode is already held on the given entity, this operation has no effect.

The modes LockMode.WRITE and LockMode.UPGRADE_SKIPLOCKED are not legal arguments to lock().

Specified by:

lock in interface Session

Parameters:

object - a persistent instance associated with this session

lockMode - the lock level

See Also:

• EntityManager.lock(Object, LockModeType)

lock

public void lock(@Nonnull
 Object object,
 @Nonnull
 LockMode lockMode,
 @Nullable
 LockOption... lockOptions)

Description copied from interface: Session

Obtain the specified lock level on the given managed instance associated with this session, applying any other specified options. This operation may be used to:

• perform a version check on an entity read from the second-level cache by requesting LockMode.READ,
• schedule a version check at transaction commit by requesting LockMode.OPTIMISTIC,
• schedule a version increment at transaction commit by requesting LockMode.OPTIMISTIC_FORCE_INCREMENT
• upgrade to a pessimistic lock with LockMode.PESSIMISTIC_READ or LockMode.PESSIMISTIC_WRITE, or
• immediately increment the version of the given instance by requesting LockMode.PESSIMISTIC_FORCE_INCREMENT.

If the requested lock mode is already held on the given entity, this operation has no effect.

The modes LockMode.WRITE and LockMode.UPGRADE_SKIPLOCKED are not legal arguments to lock().

Specified by:

lock in interface Session

Parameters:

object - a persistent instance associated with this session

lockMode - the lock level

See Also:

• EntityManager.lock(Object, LockModeType, LockOption...)

lock

public void lock(@Nonnull
 Object object,
 @Nonnull
 LockOptions lockOptions)

Description copied from interface: Session

Obtain a lock on the given managed instance associated with this session, using the given lock options.

Specified by:

lock in interface Session

Parameters:

object - a persistent instance associated with this session

lockOptions - the lock options

refresh

public void refresh(@Nonnull
 Object object)

Description copied from interface: Session

Reread the state of the given managed instance associated with this session from the underlying database. This may be useful:

• when a database trigger alters the object state upon insert or update,
• after executing any HQL update or delete statement,
• after executing a native SQL statement, or
• after inserting a Blob or Clob.

This operation cascades to associated instances if the association is mapped with CascadeType.REFRESH.

This operation requests LockMode.READ. To obtain a stronger lock, call Session.refresh(Object,RefreshOption...), passing the appropriate LockMode as an option.

Specified by:

refresh in interface EntityManager

Specified by:

refresh in interface Session

Parameters:

object - a persistent instance associated with this session

refresh

public void refresh(@Nonnull
 Object object,
 @Nonnull
 LockOptions lockOptions)

Description copied from interface: Session

Reread the state of the given managed instance from the underlying database, obtaining the given LockMode.

Specified by:

refresh in interface Session

Parameters:

object - a persistent instance associated with this session

lockOptions - contains the lock mode to use

remove

public void remove(@Nonnull
 Object object)

Description copied from interface: Session

Mark a persistence instance associated with this session for removal from the underlying database. This operation cascades to associated instances if the association is mapped CascadeType.REMOVE.

Except when operating in fully JPA-compliant mode, this operation does, contrary to the JPA specification, accept a detached entity instance.

Specified by:

remove in interface EntityManager

Specified by:

remove in interface Session

Parameters:

object - the managed persistent instance to remove, or a detached instance unless operating in fully JPA-compliant mode

getCurrentLockMode

public LockMode getCurrentLockMode(Object object)

Description copied from interface: Session

Determine the current lock mode held on the given managed instance associated with this session.

Unlike the JPA-standard EntityManager.getLockMode(Object), this operation may be called when no transaction is active, in which case it should return LockMode.NONE, indicating that no pessimistic lock is held on the given entity.

Specified by:

getCurrentLockMode in interface Session

Parameters:

object - a persistent instance associated with this session

Returns:

the lock mode currently held on the given entity

clear

public void clear()

Description copied from interface: Session

Completely clear the persistence context. Evict all loaded instances, causing every managed entity currently associated with this session to transition to the detached state, and cancel all pending insertions, updates, and deletions.

Does not close open iterators or instances of ScrollableResults.

Specified by:

clear in interface EntityManager

Specified by:

clear in interface Session

findMultiple

@Nonnull
public <E> List<E> findMultiple(@Nonnull
 Class<E> entityType,
 @Nonnull
 List<?> ids,
 @Nullable
 FindOption... options)

Description copied from interface: Session

Return the persistent instances of the given entity class with the given identifiers as a list. The position of an instance in the returned list matches the position of its identifier in the given list of identifiers, and the returned list contains a null value if there is no persistent instance matching a given identifier. If an instance is already associated with the session, that instance is returned. This method never returns an uninitialized instance.

Every object returned by findMultiple() is either an unproxied instance of the given entity class or a fully fetched proxy object.

This method accepts FindMultipleOption.BatchSize as an option, allowing control over the number of records retrieved in a single database request. The performance impact of setting a batch size depends on whether a SQL array may be used to pass the list of identifiers to the database:

• for databases which support standard SQL arrays, a smaller batch size might be extremely inefficient compared to a very large batch size or no batching at all, but
• on the other hand, for databases with no SQL array type, a large batch size results in long SQL statements with many JDBC parameters.

Specified by:

findMultiple in interface EntityHandler

Specified by:

findMultiple in interface Session

Parameters:

entityType - the entity type

ids - the list of identifiers

options - options, if any

Returns:

an ordered list of persistent instances, with null elements representing missing entities, whose positions in the list match the positions of their ids in the given list of identifiers

See Also:

• FindMultipleOption

findMultiple

@Nonnull
public <E> List<E> findMultiple(@Nonnull
 EntityGraph<E> entityGraph,
 @Nonnull
 List<?> ids,
 @Nullable
 FindOption... options)

Description copied from interface: Session

Return the persistent instances of the root entity of the given EntityGraph with the given identifiers as a list, fetching the associations specified by the graph, which is interpreted as a load graph. The position of an instance in the returned list matches the position of its identifier in the given list of identifiers, and the returned list contains a null value if there is no persistent instance matching a given identifier. If an instance is already associated with the session, that instance is returned. This method never returns an uninitialized instance.

Every object returned by findMultiple() is either an unproxied instance of the given entity class, or a fully-fetched proxy object.

This method accepts FindMultipleOption.BatchSize as an option, allowing control over the number of records retrieved in a single database request. The performance impact of setting a batch size depends on whether a SQL array may be used to pass the list of identifiers to the database:

• for databases which support standard SQL arrays a smaller batch size might be extremely inefficient compared to a very large batch size or no batching at all, but
• on the other hand, for databases with no SQL array type, a large batch size results in long SQL statements with many JDBC parameters.

Specified by:

findMultiple in interface EntityHandler

Specified by:

findMultiple in interface Session

Parameters:

entityGraph - the entity graph interpreted as a load graph

ids - the list of identifiers

options - options, if any

Returns:

an ordered list of persistent instances, with null elements representing missing entities, whose positions in the list match the positions of their ids in the given list of identifiers

See Also:

• FindMultipleOption

get

@Nonnull
public <T> T get(@Nonnull
 Class<T> entityType,
 @Nonnull
 Object id)

Specified by:

get in interface EntityHandler

get

@Nonnull
public <T> T get(@Nonnull
 Class<T> entityType,
 @Nonnull
 Object key,
 @Nullable
 FindOption... findOptions)

Specified by:

get in interface EntityHandler

get

@Nonnull
public <T> T get(@Nonnull
 EntityGraph<T> entityGraph,
 @Nonnull
 Object key,
 @Nullable
 FindOption... findOptions)

Specified by:

get in interface EntityHandler

getMultiple

@Nonnull
public <T> List<T> getMultiple(@Nonnull
 Class<T> entityType,
 @Nonnull
 List<?> keys,
 @Nullable
 FindOption... findOptions)

Specified by:

getMultiple in interface EntityHandler

getMultiple

@Nonnull
public <T> List<T> getMultiple(@Nonnull
 EntityGraph<T> entityGraph,
 @Nonnull
 List<?> keys,
 @Nullable
 FindOption... findOptions)

Specified by:

getMultiple in interface EntityHandler

get

@Nonnull
public <T> T get(@Nonnull
 Class<T> entityType,
 @Nonnull
 Object id,
 @Nonnull
 LockMode lockMode)

Description copied from interface: Session

Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance. Obtain the specified lock mode if the instance exists.

Specified by:

get in interface Session

Parameters:

entityType - the entity type

id - an identifier

lockMode - the lock mode

Returns:

a persistent instance or null

get

@Nonnull
public Object get(@Nonnull
 String entityName,
 @Nonnull
 Object key,
 @Nullable
 FindOption... findOptions)

Description copied from interface: SharedSessionContract

Form of SharedSessionContract.find(String,Object,FindOption...) throwing EntityNotFoundException if no entity exists for that id rather than returning null.

Specified by:

get in interface SharedSessionContract

Parameters:

entityName - The entity name

key - The key (primary or natural, based on KeyType)

findOptions - Options for the load operation.

Returns:

a persistent instance

See Also:

• SessionFactory.createGraphForDynamicEntity(String)
• EntityHandler.get(EntityGraph,Object,FindOption...)

get

@Nonnull
public Object get(@Nonnull
 String entityName,
 @Nonnull
 Object id,
 @Nonnull
 LockMode lockMode)

Description copied from interface: Session

Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance. Obtain the specified lock mode if the instance exists.

Specified by:

get in interface Session

Parameters:

entityName - the entity name

id - an identifier

lockMode - the lock mode

Returns:

a persistent instance or null

get

@Nonnull
public <T> T get(@Nonnull
 Class<T> entityType,
 @Nonnull
 Object id,
 @Nonnull
 LockOptions lockOptions)

Description copied from interface: Session

Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance. Obtain the specified lock mode if the instance exists.

Specified by:

get in interface Session

Parameters:

entityType - the entity type

id - an identifier

lockOptions - the lock mode

Returns:

a persistent instance or null

get

@Nonnull
public Object get(@Nonnull
 String entityName,
 @Nonnull
 Object id,
 @Nonnull
 LockOptions lockOptions)

Description copied from interface: Session

Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance. Obtain the specified lock mode if the instance exists.

Specified by:

get in interface Session

Parameters:

entityName - the entity name

id - an identifier

lockOptions - contains the lock mode

Returns:

a persistent instance or null

getEntityName

@Nonnull
public String getEntityName(@Nonnull
 Object object)

Description copied from interface: Session

Return the entity name for the given persistent entity.

If the given entity is an uninitialized proxy, the proxy is initialized by side effect.

Specified by:

getEntityName in interface Session

Parameters:

object - a persistent entity associated with this session

Returns:

the entity name

getReference

@Nonnull
public <T> T getReference(@Nonnull
 Class<T> entityType,
 @Nonnull
 Object id)

Description copied from interface: Session

Return a reference to the persistent instance with the given class and identifier, making the assumption that the instance is still persistent in the database. This method never results in access to the underlying data store, and thus might return a proxy that is initialized on-demand, when a non-identifier method is accessed.

Note that Hibernate.createDetachedProxy(SessionFactory,Class,Object) may be used to obtain a detached reference.

It's sometimes necessary to narrow a reference returned by getReference() to a subtype of the given entity type. A direct Java typecast should never be used in this situation. Instead, the method Hibernate.unproxy(Object,Class) is the recommended way to narrow the type of a proxy object. Alternatively, a new reference may be obtained by simply calling getReference() again, passing the subtype. Either way, the narrowed reference will usually not be identical to the original reference, when the references are compared using the == operator.

Specified by:

getReference in interface EntityManager

Specified by:

getReference in interface Session

Parameters:

entityType - the entity type

id - the identifier of a persistent instance that exists in the database

Returns:

the persistent instance or proxy

getReference

@Nonnull
public Object getReference(@Nonnull
 String entityName,
 @Nonnull
 Object id)

Description copied from interface: Session

Return a reference to the persistent instance of the given named entity with the given identifier, making the assumption that the instance is still persistent in the database. This method never results in access to the underlying data store, and thus might return a proxy that is initialized on-demand, when a non-identifier method is accessed.

Specified by:

getReference in interface Session

Parameters:

entityName - the entity name

id - the identifier of a persistent instance that exists in the database

Returns:

the persistent instance or proxy

getReference

@Nonnull
public <T> T getReference(@Nonnull
 T object)

Description copied from interface: Session

Return a reference to the persistent instance with the same identity as the given instance, which might be detached, making the assumption that the instance is still persistent in the database. This method never results in access to the underlying data store, and thus might return a proxy that is initialized on-demand, when a non-identifier method is accessed.

Specified by:

getReference in interface EntityManager

Specified by:

getReference in interface Session

Parameters:

object - a detached persistent instance

Returns:

the persistent instance or proxy

getReference

@Nonnull
public <T> T getReference(@Nonnull
 Class<T> entityType,
 @Nonnull
 Object key,
 @Nonnull
 KeyType keyType)

Description copied from interface: Session

Return a reference to the persistent instance of the given entity type with the given key, which is interpreted according to the given KeyType, making the assumption that the instance is still persistent in the database.

Specified by:

getReference in interface Session

Parameters:

entityType - the entity type

key - the id or natural id of a persistent instance that exists in the database

keyType - Whether the given key should be treated as an id or as a natural id

byId

@Nonnull
public <T> IdentifierLoadAccess<T> byId(@Nonnull
 String entityName)

Description copied from interface: Session

Create an IdentifierLoadAccess instance to retrieve an instance of the named entity type by its primary key.

Specified by:

byId in interface Session

Parameters:

entityName - the entity name of the entity type to be retrieved

Returns:

an instance of IdentifierLoadAccess for executing the lookup

byMultipleIds

@Nonnull
public <T> MultiIdentifierLoadAccess<T> byMultipleIds(@Nonnull
 Class<T> entityClass)

Description copied from interface: Session

Create a MultiIdentifierLoadAccess instance to retrieve multiple instances of the given entity type by their primary key values, using batching.

Specified by:

byMultipleIds in interface Session

Parameters:

entityClass - the entity type to be retrieved

Returns:

an instance of MultiIdentifierLoadAccess for executing the lookup

See Also:

• Session.findMultiple(Class, List, FindOption...)

byMultipleIds

@Nonnull
public <T> MultiIdentifierLoadAccess<T> byMultipleIds(@Nonnull
 String entityName)

Description copied from interface: Session

Create a MultiIdentifierLoadAccess instance to retrieve multiple instances of the named entity type by their primary key values, using batching.

Specified by:

byMultipleIds in interface Session

Parameters:

entityName - the entity name of the entity type to be retrieved

Returns:

an instance of MultiIdentifierLoadAccess for executing the lookup

byId

@Nonnull
public <T> IdentifierLoadAccess<T> byId(@Nonnull
 Class<T> entityClass)

Description copied from interface: Session

Create an IdentifierLoadAccess instance to retrieve an instance of the given entity type by its primary key.

Specified by:

byId in interface Session

Parameters:

entityClass - the entity type to be retrieved

Returns:

an instance of IdentifierLoadAccess for executing the lookup

byNaturalId

@Deprecated
@Nonnull
public <T> NaturalIdLoadAccess<T> byNaturalId(@Nonnull
 String entityName)

Deprecated.

Description copied from interface: Session

Create a NaturalIdLoadAccess instance to retrieve an instance of the named entity type by its natural id, which may be a composite natural id. The entity must have at least one attribute annotated NaturalId.

Specified by:

byNaturalId in interface Session

Parameters:

entityName - the entity name of the entity type to be retrieved

Returns:

an instance of NaturalIdLoadAccess for executing the lookup

byNaturalId

@Deprecated
@Nonnull
public <T> NaturalIdLoadAccess<T> byNaturalId(@Nonnull
 Class<T> entityClass)

Deprecated.

Description copied from interface: Session

Create a NaturalIdLoadAccess instance to retrieve an instance of the given entity type by its natural id, which may be a composite natural id. The entity must have at least one attribute annotated NaturalId.

Specified by:

byNaturalId in interface Session

Parameters:

entityClass - the entity type to be retrieved

Returns:

an instance of NaturalIdLoadAccess for executing the lookup

bySimpleNaturalId

@Deprecated
@Nonnull
public <T> SimpleNaturalIdLoadAccess<T> bySimpleNaturalId(@Nonnull
 String entityName)

Deprecated.

Description copied from interface: Session

Create a SimpleNaturalIdLoadAccess instance to retrieve an instance of the named entity type by its natural id, which must be a simple (non-composite) value. The entity must have exactly one attribute annotated NaturalId.

Specified by:

bySimpleNaturalId in interface Session

Parameters:

entityName - the entity name of the entity type to be retrieved

Returns:

an instance of SimpleNaturalIdLoadAccess for executing the lookup

bySimpleNaturalId

@Deprecated
@Nonnull
public <T> SimpleNaturalIdLoadAccess<T> bySimpleNaturalId(@Nonnull
 Class<T> entityClass)

Deprecated.

Description copied from interface: Session

Create a SimpleNaturalIdLoadAccess instance to retrieve an instance of the given entity type by its natural id, which must be a simple (non-composite) value. The entity must have exactly one attribute annotated NaturalId.

Specified by:

bySimpleNaturalId in interface Session

Parameters:

entityClass - the entity type to be retrieved

Returns:

an instance of SimpleNaturalIdLoadAccess for executing the lookup

byMultipleNaturalId

@Deprecated
@Nonnull
public <T> NaturalIdMultiLoadAccess<T> byMultipleNaturalId(@Nonnull
 Class<T> entityClass)

Deprecated.

Description copied from interface: Session

Create a MultiIdentifierLoadAccess instance to retrieve multiple instances of the given entity type by their by natural id values, using batching.

Specified by:

byMultipleNaturalId in interface Session

Parameters:

entityClass - the entity type to be retrieved

Returns:

an instance of NaturalIdMultiLoadAccess for executing the lookup

byMultipleNaturalId

@Deprecated
@Nonnull
public <T> NaturalIdMultiLoadAccess<T> byMultipleNaturalId(@Nonnull
 String entityName)

Deprecated.

Description copied from interface: Session

Create a MultiIdentifierLoadAccess instance to retrieve multiple instances of the named entity type by their by natural id values, using batching.

Specified by:

byMultipleNaturalId in interface Session

Parameters:

entityName - the entity name of the entity type to be retrieved

Returns:

an instance of NaturalIdMultiLoadAccess for executing the lookup

enableFilter

@Nonnull
public Filter enableFilter(@Nonnull
 String filterName)

Description copied from interface: SharedSessionContract

Enable the named filter for this current session.

The returned Filter object must be used to bind arguments to parameters of the filter, and every parameter must be set before any other operation of this session is called.

Specified by:

enableFilter in interface SharedSessionContract

Parameters:

filterName - the name of the filter to be enabled.

Returns:

the Filter instance representing the enabled filter.

See Also:

• FilterDef

getEnabledFilter

@Nullable
public Filter getEnabledFilter(@Nonnull
 String filterName)

Description copied from interface: SharedSessionContract

Retrieve a currently enabled filter by name.

Specified by:

getEnabledFilter in interface SharedSessionContract

Parameters:

filterName - the name of the filter to be retrieved.

Returns:

the Filter instance representing the enabled filter.

disableFilter

public void disableFilter(@Nonnull
 String filterName)

Description copied from interface: SharedSessionContract

Disable the named filter for the current session.

Specified by:

disableFilter in interface SharedSessionContract

Parameters:

filterName - the name of the filter to be disabled.

getStatistics

@Nonnull
public SessionStatistics getStatistics()

Description copied from interface: Session

Get the statistics for this session.

Specified by:

getStatistics in interface Session

Returns:

the session statistics being collected for this session

isReadOnly

public boolean isReadOnly(@Nonnull
 Object entityOrProxy)

Description copied from interface: Session

Is the specified entity or proxy read-only?

To get the default read-only/modifiable setting used for entities and proxies that are loaded into the session use Session.isDefaultReadOnly()

Specified by:

isReadOnly in interface Session

Parameters:

entityOrProxy - an entity or proxy

Returns:

true if the entity or proxy is read-only, false if the entity or proxy is modifiable.

See Also:

• Session.isDefaultReadOnly()

setReadOnly

public void setReadOnly(@Nonnull
 Object entityOrProxy,
 boolean readOnly)

Description copied from interface: Session

Set an unmodified persistent object to read-only mode, or a read-only object to modifiable mode. In read-only mode, no snapshot is maintained, the instance is never dirty-checked, and mutations to the fields of the entity are not made persistent.

If the entity or proxy already has the specified read-only/modifiable setting, then this method does nothing.

To set the default read-only/modifiable setting used for all entities and proxies that are loaded into the session use Session.setDefaultReadOnly(boolean).

To override the default read-only mode of the current session for all entities and proxies returned by a given Query, use SelectionQuery.setReadOnly(boolean).

Every instance of an immutable entity is loaded in read-only mode. An immutable entity may not be set to modifiable.

Specified by:

setReadOnly in interface Session

Parameters:

entityOrProxy - an entity or proxy

readOnly - true if the entity or proxy should be made read-only; false if the entity or proxy should be made modifiable

See Also:

• Session.setDefaultReadOnly(boolean)
• SelectionQuery.setReadOnly(boolean)
• Immutable
• ReadOnlyMode

isFetchProfileEnabled

public boolean isFetchProfileEnabled(@Nonnull
 String name)
                              throws UnknownProfileException

Description copied from interface: Session

Is the fetch profile with the given name enabled in this session?

Specified by:

isFetchProfileEnabled in interface Session

Parameters:

name - the name of the profile

Returns:

True if fetch profile is enabled; false if not.

Throws:

UnknownProfileException - Indicates that the given name does not match any known fetch profile names

See Also:

• FetchProfile

enableFetchProfile

public void enableFetchProfile(@Nonnull
 String name)
                        throws UnknownProfileException

Description copied from interface: Session

Enable the fetch profile with the given name in this session. If the requested fetch profile is already enabled, the call has no effect.

Specified by:

enableFetchProfile in interface Session

Parameters:

name - the name of the fetch profile to be enabled

Throws:

UnknownProfileException - Indicates that the given name does not match any known fetch profile names

See Also:

• FetchProfile

disableFetchProfile

public void disableFetchProfile(@Nonnull
 String name)
                         throws UnknownProfileException

Description copied from interface: Session

Disable the fetch profile with the given name in this session. If the requested fetch profile is not currently enabled, the call has no effect.

Specified by:

disableFetchProfile in interface Session

Parameters:

name - the name of the fetch profile to be disabled

Throws:

UnknownProfileException - Indicates that the given name does not match any known fetch profile names

See Also:

• FetchProfile

getLobHelper

@Nonnull
public LobHelper getLobHelper()

Description copied from interface: Session

Obtain a LobHelper for instances of Blob and Clob.

Specified by:

getLobHelper in interface Session

Returns:

an instance of LobHelper

getManagedEntities

@Nonnull
public Collection<?> getManagedEntities()

Description copied from interface: Session

Obtain the collection of all managed entities which belong to this persistence context.

Specified by:

getManagedEntities in interface Session

getManagedEntities

@Nonnull
public Collection<?> getManagedEntities(@Nonnull
 String entityName)

Description copied from interface: Session

Obtain a collection of all managed instances of the entity type with the given entity name which belong to this persistence context.

Specified by:

getManagedEntities in interface Session

getManagedEntities

@Nonnull
public <E> Collection<E> getManagedEntities(@Nonnull
 Class<E> entityType)

Description copied from interface: Session

Obtain a collection of all managed entities of the given type which belong to this persistence context. This operation is not polymorphic, and does not return instances of subtypes of the given entity type.

Specified by:

getManagedEntities in interface Session

getManagedEntities

@Nonnull
public <E> Collection<E> getManagedEntities(@Nonnull
 EntityType<E> entityType)

Description copied from interface: Session

Obtain a collection of all managed entities of the given type which belong to this persistence context. This operation is not polymorphic, and does not return instances of subtypes of the given entity type.

Specified by:

getManagedEntities in interface Session

sessionWithOptions

@Nonnull
public SharedSessionBuilder sessionWithOptions()

Description copied from interface: SharedSessionContract

Obtain a Session builder with the ability to copy certain information from this session.

Specified by:

sessionWithOptions in interface SharedSessionContract

Returns:

the session builder

addEventListeners

public void addEventListeners(@Nonnull
 SessionEventListener... listeners)

Description copied from interface: Session

Add one or more listeners to the Session

Specified by:

addEventListeners in interface Session

Parameters:

listeners - the listener(s) to add

createEntityGraph

@Nonnull
public <T> RootGraph<T> createEntityGraph(@Nonnull
 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 EntityHandler

Specified by:

createEntityGraph in interface Session

Specified by:

createEntityGraph in interface SharedSessionContract

Parameters:

rootType - The root entity of the graph

See Also:

• EntityHandler.get(EntityGraph, Object, FindOption...)
• EntityHandler.find(EntityGraph, Object, FindOption...)
• SharedSessionContract.createQuery(String, EntityGraph)
• StatementOrTypedQuery.withEntityGraph(EntityGraph)
• EntityGraphs.createGraph(jakarta.persistence.metamodel.EntityType)

createEntityGraph

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

Deprecated.

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

createEntityGraph

@Deprecated
@Nullable
public <T> RootGraph<T> createEntityGraph(@Nonnull
 Class<T> rootType,
 @Nonnull
 String graphName)

Deprecated.

Description copied from interface: Session

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

Specified by:

createEntityGraph in interface Session

Specified by:

createEntityGraph in interface SharedSessionContract

Parameters:

rootType - the root entity class of the graph

graphName - The name of the predefined named entity graph

getEntityGraph

@Nonnull
public RootGraph<?> getEntityGraph(@Nonnull
 String graphName)

Description copied from interface: Session

Obtain a mutable copy of a predefined named entity graph.

Specified by:

getEntityGraph in interface EntityHandler

Specified by:

getEntityGraph in interface Session

Specified by:

getEntityGraph in interface SharedSessionContract

Parameters:

graphName - The name of the predefined named entity graph

See Also:

• EntityHandler.get(EntityGraph, Object, FindOption...)
• EntityHandler.find(EntityGraph, Object, FindOption...)
• SharedSessionContract.createQuery(String, EntityGraph)
• StatementOrTypedQuery.withEntityGraph(EntityGraph)
• EntityManagerFactory.addNamedEntityGraph(String, EntityGraph)

getEntityGraph

@Nonnull
public <T> RootGraph<T> getEntityGraph(@Nonnull
 Class<T> entityClass,
 @Nonnull
 String name)

Description copied from interface: Session

Obtain a mutable copy of a predefined named entity graph whose root type is exactly the given entity type.

Specified by:

getEntityGraph in interface EntityHandler

Specified by:

getEntityGraph in interface Session

Specified by:

getEntityGraph in interface SharedSessionContract

Parameters:

entityClass - the root entity class of the graph

name - The name of the predefined named entity graph

See Also:

• EntityHandler.get(EntityGraph, Object, FindOption...)
• EntityHandler.find(EntityGraph, Object, FindOption...)
• SharedSessionContract.createQuery(String, EntityGraph)
• StatementOrTypedQuery.withEntityGraph(EntityGraph)
• EntityManagerFactory.addNamedEntityGraph(String, EntityGraph)

getEntityGraphs

@Nonnull
public <T> List<EntityGraph<? super T>> getEntityGraphs(@Nonnull
 Class<T> entityClass)

Description copied from interface: Session

Retrieve all named EntityGraphs with the given root entity type.

Specified by:

getEntityGraphs in interface EntityHandler

Specified by:

getEntityGraphs in interface Session

Specified by:

getEntityGraphs in interface SharedSessionContract

See Also:

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

runWithConnection

public <C> void runWithConnection(@Nonnull
 ConnectionConsumer<C> action)

Specified by:

runWithConnection in interface EntityHandler

callWithConnection

public <C,T> T callWithConnection(@Nonnull
 ConnectionFunction<C,T> function)

Specified by:

callWithConnection in interface EntityHandler

createQuery

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

Description copied from interface: Session

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 Session

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
public <T> SelectionQuery<T> createQuery(@Nonnull
 String query,
 @Nonnull
 EntityGraph<T> entityGraph)

Specified by:

createQuery in interface EntityHandler

Specified by:

createQuery in interface SharedSessionContract

See Also:

• EntityHandler.createQuery(String,EntityGraph)

createQuery

@Nonnull
public <R> SelectionQuery<R> createQuery(@Nonnull
 TypedQueryReference<R> typedQueryReference)

Description copied from interface: Session

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

Specified by:

createQuery in interface EntityHandler

Specified by:

createQuery in interface Session

Specified by:

createQuery in interface SharedSessionContract

Parameters:

typedQueryReference - the type query reference

Returns:

The Query instance for execution

See Also:

• EntityHandler.createQuery(TypedQueryReference)

createQuery

@Nonnull
public MutationOrSelectionQuery createQuery(@Nonnull
 String queryString)

Description copied from interface: Session

Create an instance of Query for the given HQL query or statement, without indicating the expected result type, if any, nor whether the query is a typed query which returns a result list, or an update, delete, or insert statement.

Specified by:

createQuery in interface EntityHandler

Specified by:

createQuery in interface Session

Specified by:

createQuery in interface SharedSessionContract

createNamedQuery

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

Description copied from interface: Session

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 Session

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)

createNamedStatement

@Nonnull
public MutationQuery createNamedStatement(@Nonnull
 String name)

Specified by:

createNamedStatement in interface EntityHandler

Specified by:

createNamedStatement in interface SharedSessionContract

createNamedQuery

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

Specified by:

createNamedQuery in interface SharedSessionContract

createNamedQuery

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

Specified by:

createNamedQuery in interface SharedSessionContract

createNativeStatement

@Nonnull
public MutationQuery createNativeStatement(@Nonnull
 String sql)

Specified by:

createNativeStatement in interface EntityHandler

Specified by:

createNativeStatement in interface SharedSessionContract

createNamedQuery

@Nonnull
public MutationOrSelectionQuery createNamedQuery(@Nonnull
 String name)

Description copied from interface: Session

Create an instance of Query for the given named query or statement, without indicating the expected result type, if any, nor whether the query is a typed query which returns a result list, or an update, delete, or insert statement.

Specified by:

createNamedQuery in interface EntityHandler

Specified by:

createNamedQuery in interface Session

Specified by:

createNamedQuery in interface SharedSessionContract

createSelectionQuery

@Nonnull
public <R> SelectionQuery<R> createSelectionQuery(@Nonnull
 CriteriaSelect<R> criteria)

Description copied from interface: SharedSessionContract

Create a SelectionQuery reference for the given CriteriaQuery.

Specified by:

createSelectionQuery in interface SharedSessionContract

See Also:

• EntityHandler.createQuery(CriteriaSelect)

createQuery

@Nonnull
public <T> SelectionQuery<T> createQuery(@Nonnull
 CriteriaSelect<T> selectQuery)

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)

statelessWithOptions

public SharedStatelessSessionBuilder statelessWithOptions()

Description copied from interface: SharedSessionContract

Obtain a StatelessSession builder with the ability to copy certain information from this session.

Specified by:

statelessWithOptions in interface SharedSessionContract

Returns:

the session builder

getTenantIdentifier

@Nullable
public String getTenantIdentifier()

Description copied from interface: SharedSessionContract

Obtain the tenant identifier associated with this session, as a string.

Specified by:

getTenantIdentifier in interface SharedSessionContract

Returns:

The tenant identifier associated with this session, or null

See Also:

• CurrentTenantIdentifierResolver
• SessionBuilder.tenantIdentifier(Object)
• SessionCreationOption.TenantId

getTenantIdentifierValue

@Nullable
public Object getTenantIdentifierValue()

Description copied from interface: SharedSessionContract

Obtain the tenant identifier associated with this session.

Specified by:

getTenantIdentifierValue in interface SharedSessionContract

Returns:

The tenant identifier associated with this session, or null

See Also:

• CurrentTenantIdentifierResolver
• SessionBuilder.tenantIdentifier(Object)
• SessionCreationOption.TenantId

close

public void close()
           throws HibernateException

Description copied from interface: SharedSessionContract

End the session by releasing the JDBC connection and cleaning up.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface EntityHandler

Specified by:

close in interface SharedSessionContract

Throws:

HibernateException - Indicates problems cleaning up.

isOpen

public boolean isOpen()

Description copied from interface: SharedSessionContract

Check if the session is still open.

Specified by:

isOpen in interface EntityHandler

Specified by:

isOpen in interface SharedSessionContract

Returns:

true if it is open

isConnected

public boolean isConnected()

Description copied from interface: SharedSessionContract

Check if the session is currently connected.

Specified by:

isConnected in interface SharedSessionContract

Returns:

true if it is connected

beginTransaction

@Nonnull
public Transaction beginTransaction()

Description copied from interface: SharedSessionContract

Begin a unit of work and return the associated Transaction object. If a new underlying transaction is required, begin the transaction. Otherwise, continue the new work in the context of the existing underlying transaction.

Specified by:

beginTransaction in interface SharedSessionContract

Returns:

an instance of Transaction representing the new transaction

See Also:

• SharedSessionContract.getTransaction()
• EntityTransaction.begin()

getTransaction

@Nonnull
public Transaction getTransaction()

Description copied from interface: SharedSessionContract

Get the Transaction instance associated with this session.

Specified by:

getTransaction in interface EntityHandler

Specified by:

getTransaction in interface SharedSessionContract

Returns:

an instance of Transaction representing the transaction associated with this session

See Also:

• EntityHandler.getTransaction()

getNamedProcedureCall

@Nonnull
public ProcedureCall getNamedProcedureCall(@Nonnull
 String name)

Description copied from interface: SharedSessionContract

Obtain a ProcedureCall based on a named template

Specified by:

getNamedProcedureCall in interface SharedSessionContract

Parameters:

name - The name given to the template

Returns:

The ProcedureCall

See Also:

• NamedStoredProcedureQuery

createStoredProcedureCall

@Nonnull
public ProcedureCall createStoredProcedureCall(@Nonnull
 String procedureName)

Description copied from interface: SharedSessionContract

Create a ProcedureCall to a stored procedure.

Specified by:

createStoredProcedureCall in interface SharedSessionContract

Parameters:

procedureName - The name of the procedure.

Returns:

The representation of the procedure call.

createStoredProcedureCall

@Nonnull
public ProcedureCall createStoredProcedureCall(@Nonnull
 String procedureName,
 @Nonnull
 Class<?>... resultClasses)

Description copied from interface: SharedSessionContract

Create a ProcedureCall to a stored procedure with the given result set entity mappings. Each given class is considered a "root return".

Specified by:

createStoredProcedureCall in interface SharedSessionContract

Parameters:

procedureName - The name of the procedure.

resultClasses - The entity(s) to map the result on to.

Returns:

The representation of the procedure call.

createStoredProcedureCall

@Nonnull
public ProcedureCall createStoredProcedureCall(@Nonnull
 String procedureName,
 @Nonnull
 String... resultSetMappings)

Description copied from interface: SharedSessionContract

Create a ProcedureCall to a stored procedure with the given result set entity mappings.

Specified by:

createStoredProcedureCall in interface SharedSessionContract

Parameters:

procedureName - The name of the procedure.

resultSetMappings - The explicit result set mapping(s) to use for mapping the results

Returns:

The representation of the procedure call.

createNamedStoredProcedureQuery

@Nonnull
public ProcedureCall createNamedStoredProcedureQuery(@Nonnull
 String name)

Description copied from interface: SharedSessionContract

Obtain a ProcedureCall based on a named template

Specified by:

createNamedStoredProcedureQuery in interface EntityHandler

Specified by:

createNamedStoredProcedureQuery in interface SharedSessionContract

Parameters:

name - The name given to the template

Returns:

The ProcedureCall

See Also:

• NamedStoredProcedureQuery

createStoredProcedureQuery

@Nonnull
public ProcedureCall createStoredProcedureQuery(@Nonnull
 String procedureName)

Description copied from interface: SharedSessionContract

Create a ProcedureCall to a stored procedure.

Specified by:

createStoredProcedureQuery in interface EntityHandler

Specified by:

createStoredProcedureQuery in interface SharedSessionContract

Parameters:

procedureName - The name of the procedure.

Returns:

The representation of the procedure call.

createStoredProcedureQuery

@Nonnull
public ProcedureCall createStoredProcedureQuery(@Nonnull
 String procedureName,
 @Nonnull
 Class... resultClasses)

Description copied from interface: SharedSessionContract

Create a ProcedureCall to a stored procedure with the given result set entity mappings. Each given class is considered a "root return".

Specified by:

createStoredProcedureQuery in interface EntityHandler

Specified by:

createStoredProcedureQuery in interface SharedSessionContract

Parameters:

procedureName - The name of the procedure.

resultClasses - The entity(s) to map the result on to.

Returns:

The representation of the procedure call.

createStoredProcedureQuery

@Nonnull
public ProcedureCall createStoredProcedureQuery(@Nonnull
 String procedureName,
 @Nonnull
 String... resultSetMappings)

Description copied from interface: SharedSessionContract

Create a ProcedureCall to a stored procedure with the given result set entity mappings.

Specified by:

createStoredProcedureQuery in interface EntityHandler

Specified by:

createStoredProcedureQuery in interface SharedSessionContract

Parameters:

procedureName - The name of the procedure.

resultSetMappings - The explicit result set mapping(s) to use for mapping the results

Returns:

The representation of the procedure call.

getJdbcBatchSize

public Integer getJdbcBatchSize()

Description copied from interface: SharedSessionContract

Get the session-level JDBC batch size for the current session.

Specified by:

getJdbcBatchSize in interface SharedSessionContract

Returns:

the current session-level JDBC batch size

See Also:

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

setJdbcBatchSize

public void setJdbcBatchSize(Integer jdbcBatchSize)

Description copied from interface: SharedSessionContract

Set the session-level JDBC batch size. Override the factory-level JDBC batch size controlled by the configuration property "hibernate.jdbc.batch_size".

Specified by:

setJdbcBatchSize in interface SharedSessionContract

Parameters:

jdbcBatchSize - the new session-level JDBC batch size

See Also:

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

getFetchBatchSize

public int getFetchBatchSize()

Description copied from interface: Session

Get the maximum batch size for batch fetching associations by id in this session.

Specified by:

getFetchBatchSize in interface Session

setFetchBatchSize

public void setFetchBatchSize(int batchSize)

Description copied from interface: Session

Set the maximum batch size for batch fetching associations by id in this session. Override the factory-level default controlled by the configuration property "hibernate.default_batch_fetch_size".

• If batchSize>1, then batch fetching is enabled.
• If batchSize<0, the batch size is inherited from the factory-level setting.
• Otherwise, batch fetching is disabled.

Specified by:

setFetchBatchSize in interface Session

Parameters:

batchSize - the maximum batch size for batch fetching

See Also:

• FetchSettings.DEFAULT_BATCH_FETCH_SIZE

isSubselectFetchingEnabled

public boolean isSubselectFetchingEnabled()

Description copied from interface: Session

Determine if subselect fetching is enabled in this session.

Specified by:

isSubselectFetchingEnabled in interface Session

Returns:

true is subselect fetching is enabled

setSubselectFetchingEnabled

public void setSubselectFetchingEnabled(boolean enabled)

Description copied from interface: Session

Enable or disable subselect fetching in this session. Override the factory-level default controlled by the configuration property "hibernate.use_subselect_fetch".

Specified by:

setSubselectFetchingEnabled in interface Session

Parameters:

enabled - true to enable subselect fetching

See Also:

• FetchSettings.USE_SUBSELECT_FETCH

getCriteriaBuilder

@Nonnull
public HibernateCriteriaBuilder getCriteriaBuilder()

Description copied from interface: SharedSessionContract

Obtain a HibernateCriteriaBuilder which may be used to construct criteria queries.

Specified by:

getCriteriaBuilder in interface EntityHandler

Specified by:

getCriteriaBuilder in interface SharedSessionContract

Returns:

an instance of HibernateCriteriaBuilder

See Also:

• SessionFactory.getCriteriaBuilder()

doWork

public void doWork(@Nonnull
 Work work)
            throws HibernateException

Description copied from interface: SharedSessionContract

Perform work using the Connection underlying by this session.

Specified by:

doWork in interface SharedSessionContract

Parameters:

work - The work to be performed.

Throws:

HibernateException - Generally indicates wrapped SQLException

doReturningWork

public <T> T doReturningWork(@Nonnull
 ReturningWork<T> work)
                      throws HibernateException

Description copied from interface: SharedSessionContract

Perform work using the Connection underlying by this session, and return a result.

Specified by:

doReturningWork in interface SharedSessionContract

Type Parameters:

T - The type of the result returned from the work

Parameters:

work - The work to be performed.

Returns:

the result of calling ReturningWork.execute(Connection).

Throws:

HibernateException - Generally indicates wrapped SQLException

createNativeQuery

@Deprecated
@Nonnull
public NativeQuery createNativeQuery(@Nonnull
 String sqlString)

Deprecated.

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:

sqlString - The native (SQL) query string

Returns:

The NativeQuery instance for manipulation and execution

See Also:

• EntityHandler.createNativeQuery(String)

createNativeQuery

@Nonnull
public NativeQuery createNativeQuery(@Nonnull
 String sqlString,
 @Nonnull
 Class 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

public <R> NativeQuery<R> createNativeQuery(String sqlString,
 Class<R> resultClass,
 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

@Deprecated
@Nonnull
public NativeQuery createNativeQuery(@Nonnull
 String sqlString,
 @Nonnull
 String resultSetMappingName)

Deprecated.

Specified by:

createNativeQuery in interface EntityHandler

Specified by:

createNativeQuery in interface SharedSessionContract

createNativeQuery

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

Specified by:

createNativeQuery in interface EntityHandler

Specified by:

createNativeQuery in interface SharedSessionContract

createNativeQuery

public <R> NativeQuery<R> createNativeQuery(String sqlString,
 String resultSetMappingName,
 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

createSelectionQuery

public <R> SelectionQuery<R> createSelectionQuery(String hqlString,
 Class<R> resultType)

Description copied from interface: SharedSessionContract

Create a SelectionQuery 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:

createSelectionQuery in interface SharedSessionContract

Parameters:

hqlString - The HQL select query as a string

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

See Also:

• EntityHandler.createQuery(String)

createSelectionQuery

public <R> SelectionQuery<R> createSelectionQuery(String hqlString,
 EntityGraph<R> resultGraph)

Description copied from interface: SharedSessionContract

Create a SelectionQuery instance for the given HQL query string and given EntityGraph, which is interpreted as a load graph. The query result type is the root entity of the given graph.

• If the query has an explicit select clause, there must be a single item in the select list, and the select item must be assignable to the root type of the given graph.
• Otherwise, if a query has no explicit select list, the select list is inferred from the given entity graph. The query must have exactly one root entity in the from clause, it must be assignable to the root type of the given graph, and the inferred select list will contain just that entity.

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.

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

Specified by:

createSelectionQuery in interface SharedSessionContract

Parameters:

hqlString - The HQL select query as a string

resultGraph - An EntityGraph whose root type is the query result type, which is interpreted as a load graph

See Also:

• EntityHandler.createQuery(String)

createSelectionQuery

@Nonnull
public <R> SelectionQuery<R> createSelectionQuery(@Nonnull
 CriteriaQuery<R> criteria)

Description copied from interface: SharedSessionContract

Create a SelectionQuery reference for the given CriteriaQuery.

Specified by:

createSelectionQuery in interface SharedSessionContract

See Also:

• EntityHandler.createQuery(CriteriaSelect)

createMutationQuery

@Nonnull
public MutationQuery createMutationQuery(@Nonnull
 String hqlString)

Description copied from interface: SharedSessionContract

Create a MutationQuery reference for the given HQL insert, update, or delete statement.

Specified by:

createMutationQuery in interface SharedSessionContract

Parameters:

hqlString - The HQL insert, update, or delete statement

createStatement

@Nonnull
public MutationQuery createStatement(@Nonnull
 String hqlString)

Specified by:

createStatement in interface EntityHandler

Specified by:

createStatement in interface SharedSessionContract

createStatement

@Nonnull
public MutationQuery createStatement(@Nonnull
 StatementReference statementReference)

Specified by:

createStatement in interface EntityHandler

Specified by:

createStatement in interface SharedSessionContract

createStatement

@Nonnull
public MutationQuery 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
public MutationQuery createMutationQuery(@Nonnull
 CriteriaStatement<?> criteriaStatement)

Description copied from interface: SharedSessionContract

Create a MutationQuery from the given update criteria tree

Specified by:

createMutationQuery in interface SharedSessionContract

createQuery

@Nonnull
public MutationQuery createQuery(@Nonnull
 CriteriaStatement<?> criteriaStatement)

Description copied from interface: Session

Specified by:

createQuery in interface EntityManager

Specified by:

createQuery in interface Session

createMutationQuery

@Nonnull
public MutationQuery createMutationQuery(@Nonnull
 JpaCriteriaInsert insert)

Description copied from interface: SharedSessionContract

Create a MutationQuery from the given insert criteria tree

Specified by:

createMutationQuery in interface SharedSessionContract

createNativeMutationQuery

@Nonnull
public MutationQuery createNativeMutationQuery(@Nonnull
 String sqlString)

Description copied from interface: SharedSessionContract

Create a NativeQuery instance for the given native SQL statement.

Specified by:

createNativeMutationQuery in interface SharedSessionContract

Parameters:

sqlString - a native SQL statement string

Returns:

The NativeQuery instance for manipulation and execution

createNamedSelectionQuery

@Nonnull
public <R> SelectionQuery<R> createNamedSelectionQuery(@Nonnull
 String name,
 @Nonnull
 Class<R> resultType)

Description copied from interface: SharedSessionContract

Create a SelectionQuery instance for the named NamedQuery with the given result type.

Specified by:

createNamedSelectionQuery in interface SharedSessionContract

createNamedMutationQuery

@Nonnull
public MutationQuery createNamedMutationQuery(@Nonnull
 String name)

Description copied from interface: SharedSessionContract

Create a MutationQuery instance for the given named insert, update, or delete HQL query. The named query might be defined as HQL) or native-SQL.

Specified by:

createNamedMutationQuery in interface SharedSessionContract

find

@Nullable
public <T> T find(@Nonnull
 Class<T> entityClass,
 @Nonnull
 Object primaryKey)

Description copied from interface: Session

Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance.

The object returned by get() or find() is either an unproxied instance of the given entity class, or a fully-fetched proxy object.

This operation requests LockMode.NONE, that is, no lock, allowing the object to be retrieved from the cache without the cost of database access. However, if it is necessary to read the state from the database, the object will be returned with the lock mode LockMode.READ.

To bypass the second-level cache, and ensure that the state of the requested instance is read directly from the database, either:

• call Session.find(Class,Object,FindOption...), passing CacheRetrieveMode.BYPASS as an option,
• call Session.find(Class,Object,FindOption...) with the explicit lock mode LockMode.READ, or
• set the cache mode to CacheRetrieveMode.BYPASS before calling this method.

Specified by:

find in interface EntityHandler

Specified by:

find in interface Session

Parameters:

entityClass - the entity type

primaryKey - an identifier

Returns:

a fully-fetched persistent instance or null

find

@Nullable
public <T> T find(@Nonnull
 Class<T> entityClass,
 @Nonnull
 Object primaryKey,
 @Nullable
 Map<String,Object> properties)

Specified by:

find in interface EntityManager

find

@Nullable
public <T> T find(@Nonnull
 Class<T> entityClass,
 @Nonnull
 Object primaryKey,
 @Nonnull
 LockModeType lockMode,
 @Nullable
 Map<String,Object> properties)

Specified by:

find in interface EntityManager

find

@Nullable
public <T> T find(@Nonnull
 Class<T> entityClass,
 @Nonnull
 Object primaryKey,
 @Nullable
 FindOption... options)

Description copied from interface: Session

The option KeyType.NATURAL specifies that the given id should be interpreted as a natural id.

Specified by:

find in interface EntityHandler

Specified by:

find in interface Session

Parameters:

entityClass - the entity type

primaryKey - an identifier

options - options controlling the behavior of the operation

find

@Nullable
public <T> T find(@Nonnull
 EntityGraph<T> entityGraph,
 @Nonnull
 Object primaryKey,
 @Nullable
 FindOption... options)

Specified by:

find in interface EntityHandler

find

@Nullable
public Object find(@Nonnull
 String entityName,
 @Nonnull
 Object primaryKey,
 @Nullable
 FindOption... options)

Description copied from interface: SharedSessionContract

Corollary to EntityHandler.find(Class,Object,FindOption...) for dynamic models.

Specified by:

find in interface SharedSessionContract

Parameters:

entityName - The entity name

primaryKey - The key (primary or natural, based on KeyType)

options - Options for the load operation.

Returns:

The persistent instance, or null

See Also:

• SessionFactory.createGraphForDynamicEntity(String)
• EntityHandler.find(EntityGraph,Object,FindOption...)

lock

public void lock(@Nonnull
 Object entity,
 @Nonnull
 LockModeType lockMode)

Specified by:

lock in interface EntityManager

lock

public void lock(@Nonnull
 Object entity,
 @Nonnull
 LockModeType lockMode,
 @Nullable
 Map<String,Object> properties)

Specified by:

lock in interface EntityManager

lock

public void lock(@Nonnull
 Object entity,
 @Nonnull
 LockModeType lockMode,
 @Nullable
 LockOption... options)

Specified by:

lock in interface EntityManager

refresh

public void refresh(@Nonnull
 Object entity,
 @Nullable
 Map<String,Object> properties)

Specified by:

refresh in interface EntityManager

refresh

public void refresh(@Nonnull
 Object entity,
 @Nonnull
 LockModeType lockMode,
 @Nullable
 Map<String,Object> properties)

Specified by:

refresh in interface EntityManager

refresh

public void refresh(@Nonnull
 Object entity,
 @Nullable
 RefreshOption... options)

Description copied from interface: Session

Specified by:

refresh in interface EntityManager

Specified by:

refresh in interface Session

Parameters:

entity - a persistent instance associated with this session

options - options controlling the behavior of the operation

contains

public boolean contains(@Nonnull
 Object entity)

Specified by:

contains in interface EntityManager

getLockMode

@Nonnull
public LockModeType getLockMode(@Nonnull
 Object entity)

Specified by:

getLockMode in interface EntityManager

setProperty

public void setProperty(@Nonnull
 String propertyName,
 @Nullable
 Object value)

Description copied from interface: Session

Set a hint. The hints understood by Hibernate are enumerated by AvailableHints.

Specified by:

setProperty in interface EntityHandler

Specified by:

setProperty in interface Session

See Also:

• HibernateHints
• SpecHints

getProperties

@Nonnull
public Map<String,Object> getProperties()

Specified by:

getProperties in interface EntityHandler

joinTransaction

public void joinTransaction()

Description copied from interface: SharedSessionContract

Join the currently active JTA transaction.

Specified by:

joinTransaction in interface EntityManager

Specified by:

joinTransaction in interface SharedSessionContract

See Also:

• EntityManager.joinTransaction()

isJoinedToTransaction

public boolean isJoinedToTransaction()

Description copied from interface: SharedSessionContract

Check if the session is joined to the current transaction.

Specified by:

isJoinedToTransaction in interface EntityManager

Specified by:

isJoinedToTransaction in interface SharedSessionContract

See Also:

• SharedSessionContract.joinTransaction()
• EntityManager.isJoinedToTransaction()

unwrap

@Nonnull
public <T> T unwrap(@Nonnull
 Class<T> type)

Specified by:

unwrap in interface EntityHandler

getNamedNativeQuery

@Deprecated
@Nonnull
public NativeQuery getNamedNativeQuery(@Nonnull
 String name)

Deprecated.

Specified by:

getNamedNativeQuery in interface Session

getDelegate

@Deprecated
@Nonnull
public Object getDelegate()

Deprecated.

Specified by:

getDelegate in interface EntityManager

getEntityManagerFactory

@Nonnull
public EntityManagerFactory getEntityManagerFactory()

Specified by:

getEntityManagerFactory in interface EntityHandler

getMetamodel

@Nonnull
public Metamodel getMetamodel()

Specified by:

getMetamodel in interface EntityHandler