Class StatelessSessionLazyDelegator

java.lang.Object

org.hibernate.engine.spi.StatelessSessionLazyDelegator

All Implemented Interfaces:

EntityAgent, EntityHandler, Serializable, AutoCloseable, SharedSessionContract, StatelessSession

public abstract class StatelessSessionLazyDelegator
extends Object
implements StatelessSession

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface EntityAgent

EntityAgent.CreationOption, EntityAgent.Option

Constructor Summary

Constructors

Constructor	Description
StatelessSessionLazyDelegator()

Method Summary

Modifier and Type	Method	Description
void	addOption(EntityAgent.Option option)
Transaction	beginTransaction()	Begin a unit of work and return the associated Transaction object.
<C,T> T	callWithConnection(ConnectionFunction<C,T> function)
void	close()	End the session by releasing the JDBC connection and cleaning up.
<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, for removal: This API element is subject to removal in a future version.
RootGraph<?>	createEntityGraph(String graphName)	Deprecated, for removal: This API element is subject to removal in a future version.
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)	Create a NativeQuery instance for the given native SQL query.
<T> TypedQuery<T>	createNativeQuery(String sql, jakarta.persistence.sql.ResultSetMapping<T> resultSetMapping)
<R> NativeQuery<R>	createNativeQuery(String sqlString, Class<R> resultClass)	Create a NativeQuery instance for the given native SQL query using an implicit mapping to the specified Java type.
<R> 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 sql, String resultSetMapping)
<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> criteriaSelect)
<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 hqlString, 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.
abstract StatelessSession	delegate()
void	delete(Object entity)	Delete a record.
void	delete(String entityName, Object entity)	Delete a record.
void	deleteMultiple(List<?> entities)	Delete multiple records in the same order as the entity instances representing the records occur in the given list.
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.
Filter	enableFilter(String filterName)	Enable the named filter for this current session.
<T> T	fetch(T association)	Fetch an association or collection that's configured for lazy loading.
<T> T	find(EntityGraph<T> entityGraph, Object primaryKey, FindOption... options)
<T> T	find(Class<T> entityClass, Object primaryKey)
<T> T	find(Class<T> entityClass, Object primaryKey, FindOption... options)
Object	find(String entityName, Object key, FindOption... findOptions)	Corollary to EntityHandler.find(Class,Object,FindOption...) for dynamic models.
<E> List<E>	findMultiple(EntityGraph<E> entityGraph, List<?> ids, FindOption... options)
<E> List<E>	findMultiple(Class<E> entityType, List<?> ids, FindOption... options)
<T> T	get(EntityGraph<T> entityGraph, Object key, FindOption... findOptions)
<T> T	get(EntityGraph<T> graph, GraphSemantic graphSemantic, Object id)	Deprecated, for removal: This API element is subject to removal in a future version.
<T> T	get(EntityGraph<T> graph, GraphSemantic graphSemantic, Object id, LockMode lockMode)	Deprecated, for removal: This API element is subject to removal in a future version.
<T> T	get(Class<T> entityType, Object id)
<T> T	get(Class<T> entityType, Object key, FindOption... findOptions)
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)	Deprecated, for removal: This API element is subject to removal in a future version.
CacheMode	getCacheMode()	Get the current cache mode for this session.
CacheRetrieveMode	getCacheRetrieveMode()
CacheStoreMode	getCacheStoreMode()
HibernateCriteriaBuilder	getCriteriaBuilder()	Obtain a HibernateCriteriaBuilder which may be used to construct criteria queries.
Filter	getEnabledFilter(String filterName)	Retrieve a currently enabled filter by name.
<T> RootGraph<T>	getEntityGraph(Class<T> rootType, String graphName)	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()
SessionFactory	getFactory()	The factory which created this session.
Object	getIdentifier(Object entity)	Return the identifier value of the given entity, which may be detached.
Integer	getJdbcBatchSize()	Get the session-level JDBC batch size for the current session.
Metamodel	getMetamodel()
<T> List<T>	getMultiple(EntityGraph<T> entityGraph, List<?> keys, FindOption... findOptions)
<T> List<T>	getMultiple(EntityGraph<T> entityGraph, GraphSemantic graphSemantic, List<?> ids)	Deprecated, for removal: This API element is subject to removal in a future version.
<T> List<T>	getMultiple(Class<T> entityType, List<?> keys, FindOption... findOptions)
ProcedureCall	getNamedProcedureCall(String name)	Obtain a ProcedureCall based on a named template
Set<EntityAgent.Option>	getOptions()
Map<String,Object>	getProperties()
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.
void	insert(Object entity)	Insert a record.
Object	insert(String entityName, Object entity)	Insert a record.
void	insertMultiple(List<?> entities)	Insert multiple records in the same order as the entity instances representing the new records occur in the given list.
boolean	isConnected()	Check if the session is currently connected.
boolean	isJoinedToTransaction()	Check if the session is joined to the current transaction.
boolean	isOpen()	Check if the session is still open.
void	joinTransaction()	Join the currently active JTA transaction.
void	refresh(Object entity)	Refresh the entity instance state from the database.
void	refresh(Object entity, LockModeType lockModeType)
void	refresh(Object entity, LockMode lockMode)	Refresh the entity instance state from the database.
void	refresh(String entityName, Object entity)	Refresh the entity instance state from the database.
void	refresh(String entityName, Object entity, LockMode lockMode)	Refresh the entity instance state from the database.
void	refreshMultiple(List<?> entities)
<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)
void	setCacheStoreMode(CacheStoreMode cacheStoreMode)
void	setJdbcBatchSize(Integer jdbcBatchSize)	Set the session-level JDBC batch size.
void	setProperty(String propertyName, Object value)
SharedStatelessSessionBuilder	statelessWithOptions()	Obtain a StatelessSession builder with the ability to copy certain information from this session.
<T> T	unwrap(Class<T> type)
void	update(Object entity)	Update a record.
void	update(String entityName, Object entity)	Update a record.
void	updateMultiple(List<?> entities)	Update multiple records in the same order as the entity instances representing the records occur in the given list.
void	upsert(Object entity)	Use a SQL merge into statement to perform an upsert, that is, to insert the record if it does not exist, or update it if it already exists.
void	upsert(String entityName, Object entity)	Use a SQL merge into statement to perform an upsert.
void	upsertMultiple(List<?> entities)	Upsert multiple records, that is, for a given record, insert the record if it does not exist or update the record if it already exists, in the same order as the entity instances representing the records occur in the given list.

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

StatelessSessionLazyDelegator

public StatelessSessionLazyDelegator()

Method Details

delegate

public abstract StatelessSession delegate()

insert

public void insert(@Nonnull
 Object entity)

Description copied from interface: StatelessSession

Insert a record.

If the entity @Id field is declared to be generated, for example, if it is annotated @GeneratedValue, the id is generated and assigned to the given instance.

The PostPersist callback will be triggered if the operation is successful.

Specified by:

insert in interface EntityAgent

Specified by:

insert in interface StatelessSession

Parameters:

entity - a new transient instance

insertMultiple

public void insertMultiple(@Nonnull
 List<?> entities)

Description copied from interface: StatelessSession

Insert multiple records in the same order as the entity instances representing the new records occur in the given list.

Specified by:

insertMultiple in interface EntityAgent

Specified by:

insertMultiple in interface StatelessSession

Parameters:

entities - a list of transient instances to be inserted

insert

public Object insert(@Nonnull
 String entityName,
 @Nonnull
 Object entity)

Description copied from interface: StatelessSession

Insert a record.

The PostPersist callback will be triggered if the operation is successful.

Specified by:

insert in interface StatelessSession

Parameters:

entityName - The entityName for the entity to be inserted

entity - a new transient instance

Returns:

the identifier of the instance

update

public void update(@Nonnull
 Object entity)

Description copied from interface: StatelessSession

Update a record.

The PostUpdate callback will be triggered if the operation is successful.

Specified by:

update in interface EntityAgent

Specified by:

update in interface StatelessSession

Parameters:

entity - a detached entity instance

updateMultiple

public void updateMultiple(@Nonnull
 List<?> entities)

Description copied from interface: StatelessSession

Update multiple records in the same order as the entity instances representing the records occur in the given list.

Specified by:

updateMultiple in interface EntityAgent

Specified by:

updateMultiple in interface StatelessSession

Parameters:

entities - a list of detached instances to be updated

update

public void update(@Nonnull
 String entityName,
 @Nonnull
 Object entity)

Description copied from interface: StatelessSession

Update a record.

The PostUpdate callback will be triggered if the operation is successful.

Specified by:

update in interface StatelessSession

Parameters:

entityName - The entityName for the entity to be updated

entity - a detached entity instance

delete

public void delete(@Nonnull
 Object entity)

Description copied from interface: StatelessSession

Delete a record.

The PostRemove callback will be triggered if the operation is successful.

Specified by:

delete in interface EntityAgent

Specified by:

delete in interface StatelessSession

Parameters:

entity - a detached entity instance

deleteMultiple

public void deleteMultiple(@Nonnull
 List<?> entities)

Description copied from interface: StatelessSession

Delete multiple records in the same order as the entity instances representing the records occur in the given list.

Specified by:

deleteMultiple in interface EntityAgent

Specified by:

deleteMultiple in interface StatelessSession

Parameters:

entities - a list of detached instances to be deleted

delete

public void delete(@Nonnull
 String entityName,
 @Nonnull
 Object entity)

Description copied from interface: StatelessSession

Delete a record.

The PostRemove callback will be triggered if the operation is successful.

Specified by:

delete in interface StatelessSession

Parameters:

entityName - The entity name for the entity to be deleted

entity - a detached entity instance

upsert

public void upsert(@Nonnull
 Object entity)

Description copied from interface: StatelessSession

Use a SQL merge into statement to perform an upsert, that is, to insert the record if it does not exist, or update it if it already exists.

This method never performs id generation, and does not accept an entity instance with a null identifier. When id generation is required, use StatelessSession.insert(Object).

On the other hand, upsert() does accept an entity instance with an assigned identifier value, even if the entity @Id field is declared to be generated, for example, if it is annotated @GeneratedValue. Thus, this method may be used to import data from an external source.

Specified by:

upsert in interface EntityAgent

Specified by:

upsert in interface StatelessSession

Parameters:

entity - a detached entity instance, or a new instance with an assigned identifier

upsertMultiple

public void upsertMultiple(@Nonnull
 List<?> entities)

Description copied from interface: StatelessSession

Upsert multiple records, that is, for a given record, insert the record if it does not exist or update the record if it already exists, in the same order as the entity instances representing the records occur in the given list.

Specified by:

upsertMultiple in interface EntityAgent

Specified by:

upsertMultiple in interface StatelessSession

Parameters:

entities - a list of detached instances and new instances with assigned identifiers

upsert

public void upsert(@Nonnull
 String entityName,
 @Nonnull
 Object entity)

Description copied from interface: StatelessSession

Use a SQL merge into statement to perform an upsert.

Specified by:

upsert in interface StatelessSession

Parameters:

entityName - The entity name for the entity to be merged

entity - a detached entity instance

get

@Deprecated(forRemoval=true,
            since="8.0")
@Nonnull
public Object get(@Nonnull
 String entityName,
 @Nonnull
 Object id,
 @Nonnull
 LockMode lockMode)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: StatelessSession

Retrieve a record, obtaining the specified lock mode.

Specified by:

get in interface StatelessSession

Parameters:

entityName - The name of the entity to retrieve

id - The id of the entity to retrieve

lockMode - The lock mode to apply to the entity

Returns:

a detached entity instance, or null if there is no instance with the given id

get

@Deprecated(forRemoval=true,
            since="8.0")
@Nonnull
public <T> T get(@Nonnull
 EntityGraph<T> graph,
 @Nonnull
 GraphSemantic graphSemantic,
 @Nonnull
 Object id)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: StatelessSession

Retrieve a record, fetching associations specified by the given EntityGraph.

Specified by:

get in interface StatelessSession

Parameters:

graph - The EntityGraph

graphSemantic - a GraphSemantic specifying how the graph should be interpreted

id - The id of the entity to retrieve

Returns:

a detached entity instance, or null if there is no instance with the given id

get

@Deprecated(forRemoval=true,
            since="8.0")
@Nonnull
public <T> T get(@Nonnull
 EntityGraph<T> graph,
 @Nonnull
 GraphSemantic graphSemantic,
 @Nonnull
 Object id,
 @Nonnull
 LockMode lockMode)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: StatelessSession

Retrieve a record, fetching associations specified by the given EntityGraph, and obtaining the specified lock mode.

Specified by:

get in interface StatelessSession

Parameters:

graph - The EntityGraph

graphSemantic - a GraphSemantic specifying how the graph should be interpreted

id - The id of the entity to retrieve

lockMode - The lock mode to apply to the entity

Returns:

a detached entity instance, or null if there is no instance with the given id

getMultiple

@Deprecated(forRemoval=true,
            since="8.0")
@Nonnull
public <T> List<T> getMultiple(@Nonnull
 EntityGraph<T> entityGraph,
 @Nonnull
 GraphSemantic graphSemantic,
 @Nonnull
 List<?> ids)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: StatelessSession

Retrieve multiple rows, returning instances of the root entity of the given EntityGraph with the fetched associations specified by the graph, in a list where the position of an instance in the list matches the position of its identifier in the given array, and the list contains a null value if there is no persistent instance matching a given identifier.

Specified by:

getMultiple in interface StatelessSession

Parameters:

entityGraph - The EntityGraph

graphSemantic - a GraphSemantic specifying how the graph should be interpreted

ids - The ids of the entities to retrieve

Returns:

an ordered list of detached entity instances, with null elements representing missing entities

refresh

public void refresh(@Nonnull
 Object entity)

Description copied from interface: StatelessSession

Refresh the entity instance state from the database.

Specified by:

refresh in interface EntityAgent

Specified by:

refresh in interface StatelessSession

Parameters:

entity - The entity to be refreshed.

refresh

public void refresh(@Nonnull
 String entityName,
 @Nonnull
 Object entity)

Description copied from interface: StatelessSession

Refresh the entity instance state from the database.

Specified by:

refresh in interface StatelessSession

Parameters:

entityName - The entity name for the entity to be refreshed.

entity - The entity to be refreshed.

refresh

public void refresh(@Nonnull
 Object entity,
 @Nonnull
 LockMode lockMode)

Description copied from interface: StatelessSession

Refresh the entity instance state from the database.

Specified by:

refresh in interface StatelessSession

Parameters:

entity - The entity to be refreshed.

lockMode - The LockMode to be applied.

refresh

public void refresh(@Nonnull
 String entityName,
 @Nonnull
 Object entity,
 @Nonnull
 LockMode lockMode)

Description copied from interface: StatelessSession

Refresh the entity instance state from the database.

Specified by:

refresh in interface StatelessSession

Parameters:

entityName - The entity name for the entity to be refreshed.

entity - The entity to be refreshed.

lockMode - The LockMode to be applied.

refresh

public void refresh(@Nonnull
 Object entity,
 @Nonnull
 LockModeType lockModeType)

Specified by:

refresh in interface EntityAgent

refreshMultiple

public void refreshMultiple(@Nonnull
 List<?> entities)

Specified by:

refreshMultiple in interface EntityAgent

fetch

@Nonnull
public <T> T fetch(@Nonnull
 T association)

Description copied from interface: StatelessSession

Fetch an association or collection that's configured for lazy loading.

Book book = session.get(Book.class, isbn);  // book is immediately detached
session.fetch(book.getAuthors());           // fetch the associated authors
book.getAuthors().forEach(author -> ... );  // iterate the collection

Warning: this operation in a stateless session is quite sensitive to data aliasing effects and should be used with great care. It's usually better to fetch associations using eager join fetching.

Specified by:

fetch in interface EntityAgent

Specified by:

fetch in interface StatelessSession

Parameters:

association - a lazy-loaded association

See Also:

• Hibernate.initialize(Object)

getIdentifier

@Nullable
public Object getIdentifier(@Nonnull
 Object entity)

Description copied from interface: StatelessSession

Return the identifier value of the given entity, which may be detached.

Specified by:

getIdentifier in interface StatelessSession

Parameters:

entity - a persistent instance associated with this session

Returns:

the identifier

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

getCacheMode

@Nonnull
public CacheMode getCacheMode()

Description copied from interface: SharedSessionContract

Get the current cache mode for this session.

Specified by:

getCacheMode in interface SharedSessionContract

Returns:

the current cache mode

setCacheMode

public void setCacheMode(@Nonnull
 CacheMode cacheMode)

Description copied from interface: SharedSessionContract

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 SharedSessionContract

Parameters:

cacheMode - the new cache mode

setCacheRetrieveMode

public void setCacheRetrieveMode(@Nonnull
 CacheRetrieveMode cacheRetrieveMode)

Specified by:

setCacheRetrieveMode in interface EntityHandler

setCacheStoreMode

public void setCacheStoreMode(@Nonnull
 CacheStoreMode cacheStoreMode)

Specified by:

setCacheStoreMode in interface EntityHandler

getCacheStoreMode

@Nonnull
public CacheStoreMode getCacheStoreMode()

Specified by:

getCacheStoreMode in interface EntityHandler

getCacheRetrieveMode

@Nonnull
public CacheRetrieveMode getCacheRetrieveMode()

Specified by:

getCacheRetrieveMode in interface EntityHandler

addOption

public void addOption(@Nonnull
 EntityAgent.Option option)

Specified by:

addOption in interface EntityAgent

getOptions

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

Specified by:

getOptions in interface EntityAgent

close

public void close()

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

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()

joinTransaction

public void joinTransaction()

Description copied from interface: SharedSessionContract

Join the currently active JTA transaction.

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 SharedSessionContract

See Also:

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

find

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

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

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

findOptions - Options for the load operation.

Returns:

The persistent instance, or null

See Also:

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

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...)

findMultiple

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

Specified by:

findMultiple in interface EntityHandler

findMultiple

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

Specified by:

findMultiple in interface EntityHandler

find

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

Specified by:

find in interface EntityHandler

find

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

Specified by:

find in interface EntityHandler

find

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

Specified by:

find in interface EntityHandler

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

createQuery

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

Description copied from interface: SharedSessionContract

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

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

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

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

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

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

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

Specified by:

createQuery in interface EntityHandler

Specified by:

createQuery in interface SharedSessionContract

Parameters:

queryString - The HQL query

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

Returns:

The Query instance for manipulation and execution

See Also:

• EntityHandler.createQuery(String,Class)

createQuery

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

Specified by:

createQuery in interface EntityHandler

Specified by:

createQuery in interface SharedSessionContract

See Also:

• EntityHandler.createQuery(String,EntityGraph)

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)

createMutationQuery

public MutationQuery createMutationQuery(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

createQuery

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

Description copied from interface: SharedSessionContract

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

Specified by:

createQuery in interface EntityHandler

Specified by:

createQuery in interface SharedSessionContract

Parameters:

typedQueryReference - the type query reference

Returns:

The Query instance for execution

See Also:

• EntityHandler.createQuery(TypedQueryReference)

createQuery

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

Description copied from interface: SharedSessionContract

Specified by:

createQuery in interface EntityHandler

Specified by:

createQuery in interface SharedSessionContract

See Also:

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

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)

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)

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
 CriteriaStatement<?> criteriaStatement)

Description copied from interface: SharedSessionContract

Create a MutationQuery from the given update criteria tree

Specified by:

createMutationQuery in interface SharedSessionContract

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

createNativeQuery

@Nonnull
public NativeQuery<?> createNativeQuery(@Nonnull
 String sqlString)

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

Description copied from interface: SharedSessionContract

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

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

Specified by:

createNativeQuery in interface EntityHandler

Specified by:

createNativeQuery in interface SharedSessionContract

Parameters:

sqlString - The native (SQL) query string

resultClass - The Java type to map results to

Returns:

The NativeQuery instance for manipulation and execution

See Also:

• EntityHandler.createNativeQuery(String,Class)

createNativeQuery

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

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

createNativeMutationQuery

public MutationQuery createNativeMutationQuery(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

createNamedQuery

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

Description copied from interface: SharedSessionContract

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

Specified by:

createNamedQuery in interface EntityHandler

Specified by:

createNamedQuery in interface SharedSessionContract

Parameters:

name - the name of a query defined in metadata

resultClass - the type of the query result

Returns:

The Query instance for manipulation and execution

See Also:

• EntityHandler.createNamedQuery(String,Class)

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

createNativeQuery

@Nonnull
public NativeQuery<?> createNativeQuery(@Nonnull
 String sql,
 @Nonnull
 String resultSetMapping)

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

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

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

@Nullable
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(@Nullable
 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)

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)

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.

doReturningWork

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

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).

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

createEntityGraph

@Nonnull
public <T> RootGraph<T> createEntityGraph(@Nonnull
 Class<T> rootType)

Description copied from interface: SharedSessionContract

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

Specified by:

createEntityGraph in interface EntityHandler

Specified by:

createEntityGraph in interface SharedSessionContract

Parameters:

rootType - the root entity class of the graph

See Also:

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

createEntityGraph

@Deprecated(since="8.0",
            forRemoval=true)
@Nullable
public RootGraph<?> createEntityGraph(@Nonnull
 String graphName)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: SharedSessionContract

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

Specified by:

createEntityGraph in interface SharedSessionContract

Parameters:

graphName - the name of the graph

createEntityGraph

@Deprecated(since="8.0",
            forRemoval=true)
@Nullable
public <T> RootGraph<T> createEntityGraph(@Nonnull
 Class<T> rootType,
 @Nonnull
 String graphName)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: SharedSessionContract

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

Specified by:

createEntityGraph in interface SharedSessionContract

Parameters:

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: SharedSessionContract

Obtain a mutable copy of a predefined named entity graph.

Specified by:

getEntityGraph in interface EntityHandler

Specified by:

getEntityGraph in interface SharedSessionContract

Parameters:

graphName - the name of the predefined named entity graph

See Also:

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

getEntityGraph

@Nonnull
public <T> RootGraph<T> getEntityGraph(@Nonnull
 Class<T> rootType,
 @Nonnull
 String graphName)

Description copied from interface: SharedSessionContract

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 SharedSessionContract

Parameters:

rootType - the root entity class of the graph

graphName - the name of the predefined named entity graph

See Also:

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

getEntityGraphs

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

Description copied from interface: SharedSessionContract

Retrieve all named EntityGraphs with the given root entity type.

Specified by:

getEntityGraphs in interface EntityHandler

Specified by:

getEntityGraphs in interface SharedSessionContract

See Also:

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

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.

getFactory

@Nonnull
public SessionFactory getFactory()

Description copied from interface: SharedSessionContract

The factory which created this session.

Specified by:

getFactory in interface SharedSessionContract

getEntityManagerFactory

@Nonnull
public EntityManagerFactory getEntityManagerFactory()

Specified by:

getEntityManagerFactory in interface EntityHandler

getMetamodel

@Nonnull
public Metamodel getMetamodel()

Specified by:

getMetamodel in interface EntityHandler

unwrap

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

Specified by:

unwrap in interface EntityHandler

getProperties

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

Specified by:

getProperties in interface EntityHandler

setProperty

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

Specified by:

setProperty in interface EntityHandler

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

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

createQuery

@Nonnull
public MutationOrSelectionQuery createQuery(@Nonnull
 String queryString)

Description copied from interface: SharedSessionContract

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 SharedSessionContract

createNamedQuery

@Nonnull
public MutationOrSelectionQuery createNamedQuery(@Nonnull
 String name)

Description copied from interface: SharedSessionContract

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 SharedSessionContract