Package org.hibernate.engine.spi

Class SharedSessionDelegatorBaseImpl

java.lang.Object

org.hibernate.engine.spi.SharedSessionDelegatorBaseImpl

All Implemented Interfaces:

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

public class SharedSessionDelegatorBaseImpl
extends Object
implements SharedSessionContractImplementor

A wrapper class that delegates all method invocations to a delegate instance of SharedSessionContractImplementor. This is useful for custom implementations of that API, so that only some methods need to be overridden

See Also:

• Serialized Form

Nested Class Summary

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

LobCreationContext.Callback<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final SharedSessionContractImplementor	delegate

Constructor Summary

Constructors

Constructor	Description
SharedSessionDelegatorBaseImpl(SessionImplementor delegate)

Method Summary

Modifier and Type	Method	Description
Transaction	accessTransaction()	Retrieves the current Transaction, or creates a new transaction if there is no transaction active.
void	afterObtainConnection(Connection connection)	Called after a managed JDBC connection is obtained.
void	afterOperation(boolean success)	Check if there is a Hibernate or JTA transaction in progress and, if there is not, flush if necessary, making sure that the connection has been committed (if it is not in autocommit mode), and finally run the after completion processing.
void	afterScrollOperation()	Called after each operation on a ScrollableResults, providing an opportunity for a stateless session to clear its temporary persistence context.
void	afterTransactionBegin()	An after-begin callback from the coordinator to its owner.
void	afterTransactionCompletion(boolean successful, boolean delayed)	An after-completion callback to the owner.
boolean	autoFlushIfRequired(Set<String> querySpaces)	detect in-memory changes, determine if the changes are to tables named in the query and, if so, complete execution the flush
boolean	autoFlushIfRequired(Set<String> querySpaces, boolean skipPreFlush)	detect in-memory changes, determine if the changes are to tables named in the query and, if so, complete execution the flush
void	autoPreFlush()
void	beforeReleaseConnection(Connection connection)	Called right before a managed JDBC connection is released.
void	beforeTransactionCompletion()	A before-completion callback to the owner.
Transaction	beginTransaction()	Begin a unit of work and return the associated Transaction object.
String	bestGuessEntityName(Object object)	Obtain the best estimate of the entity name of the given entity instance, which is not involved in an association, by also considering information held in the proxy, and whether the object is already associated with this session.
void	checkOpen(boolean markForRollbackIfClosed)	Check whether the session is open, and if not: if markForRollbackIfClosed = true, mark the current transaction, if any, for rollback only, and throw an IllegalStateException.
void	close()	End the session by releasing the JDBC connection and cleaning up.
<T> RootGraphImplementor<T>	createEntityGraph(Class<T> rootType)	Create a new mutable instance of EntityGraph, with only a root node, allowing programmatic definition of the graph from scratch.
<T> RootGraph<T>	createEntityGraph(Class<T> rootType, String graphName)	Create a new mutable instance of EntityGraph, based on a predefined named entity graph, allowing customization of the graph, or return null if there is no predefined graph with the given name.
RootGraphImplementor<?>	createEntityGraph(String graphName)	Create a new mutable instance of EntityGraph, based on a predefined named entity graph, allowing customization of the graph, or return null if there is no predefined graph with the given name.
MutationQuery	createMutationQuery(CriteriaDelete deleteQuery)	Create a MutationQuery from the given delete criteria tree
MutationQuery	createMutationQuery(CriteriaUpdate updateQuery)	Create a MutationQuery from the given update criteria tree
MutationQuery	createMutationQuery(String statementString)	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.
QueryImplementor	createNamedQuery(String name)	Create a typed Query instance for the given named query.
<T> QueryImplementor<T>	createNamedQuery(String name, Class<T> resultClass)	Create a typed Query instance for the given named query.
SelectionQuery<?>	createNamedSelectionQuery(String name)	Create a SelectionQuery instance for the named NamedQuery.
<R> SelectionQuery<R>	createNamedSelectionQuery(String name, Class<R> resultType)	Create a SelectionQuery instance for the named NamedQuery with the given result type.
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.
NativeQueryImplementor	createNativeQuery(String sqlString)	Create a NativeQuery instance for the given native SQL query.
NativeQueryImplementor	createNativeQuery(String sqlString, Class resultClass)	Create a NativeQuery instance for the given native SQL query using an implicit mapping to the specified Java type.
<T> NativeQueryImplementor<T>	createNativeQuery(String sqlString, Class<T> resultClass, String tableAlias)	Create a NativeQuery instance for the given native SQL query using an implicit mapping to the specified Java entity type.
NativeQueryImplementor	createNativeQuery(String sqlString, String resultSetMappingName)	Create a NativeQuery instance for the given native SQL query using an explicit mapping to the specified Java type.
<T> NativeQueryImplementor<T>	createNativeQuery(String sqlString, String resultSetMappingName, Class<T> resultClass)	Create a NativeQuery instance for the given native SQL query using an explicit mapping to the specified Java type.
QueryImplementor	createQuery(CriteriaDelete deleteQuery)	Create a MutationQuery for the given JPA CriteriaDelete
<T> QueryImplementor<T>	createQuery(CriteriaQuery<T> criteriaQuery)	Create a Query for the given JPA CriteriaQuery.
QueryImplementor	createQuery(CriteriaUpdate updateQuery)	Create a MutationQuery for the given JPA CriteriaUpdate
<R> QueryImplementor<R>	createQuery(TypedQueryReference<R> typedQueryReference)	Create a typed Query instance for the given typed query reference.
QueryImplementor	createQuery(String queryString)	Create a Query instance for the given HQL query, or HQL insert, update, or delete statement.
<T> QueryImplementor<T>	createQuery(String queryString, Class<T> resultType)	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.
SelectionQuery<?>	createSelectionQuery(String hqlString)	Create a SelectionQuery reference for the given HQL select statement.
<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.
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.
protected SharedSessionContract	delegate()	Returns the delegate 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.
Filter	enableFilter(String filterName)	Enable the named filter for this current session.
<T> T	execute(LobCreationContext.Callback<T> callback)	Execute the given callback, making sure it has access to a viable JDBC Connection.
void	flush()	Flush this session.
void	flushBeforeTransactionCompletion()
EntityKey	generateEntityKey(Object id, EntityPersister persister)	Instantiate an EntityKey with the given id and for the entity represented by the given EntityPersister.
CacheMode	getCacheMode()	Get the current cache mode for this session.
CacheTransactionSynchronization	getCacheTransactionSynchronization()	The current CacheTransactionSynchronization associated with this session.
Object	getContextEntityIdentifier(Object object)	Return the identifier of the persistent object, or null if it is not associated with this session.
HibernateCriteriaBuilder	getCriteriaBuilder()	Obtain a HibernateCriteriaBuilder which may be used to construct criteria queries.
Filter	getEnabledFilter(String filterName)	Retrieve a currently enabled filter by name.
RootGraphImplementor<?>	getEntityGraph(String graphName)	Obtain an immutable reference to a predefined named entity graph.
<T> List<EntityGraph<? super T>>	getEntityGraphs(Class<T> entityClass)	Retrieve all named EntityGraphs with the given root entity type.
EntityPersister	getEntityPersister(@Nullable String entityName, Object object)	Get the EntityPersister for the given entity instance.
Object	getEntityUsingInterceptor(EntityKey key)	Get the entity instance associated with the given EntityKey, calling the Interceptor if necessary.
SessionEventListenerManager	getEventListenerManager()	Get the SessionEventListenerManager associated with this session.
EventMonitor	getEventMonitor()	Obtain a reference to the EventMonitor.
ExceptionConverter	getExceptionConverter()	Obtain an ExceptionConverter for reporting an error.
SessionFactoryImplementor	getFactory()	Obtain the factory which created this session.
FlushMode	getHibernateFlushMode()	Get the current FlushMode for this session.
Interceptor	getInterceptor()	Retrieves the Interceptor associated with this session.
Integer	getJdbcBatchSize()	Get the session-level JDBC batch size for the current session.
JdbcConnectionAccess	getJdbcConnectionAccess()
JdbcCoordinator	getJdbcCoordinator()	Obtain the JdbcCoordinator for this session.
JdbcServices	getJdbcServices()	Obtain the JdbcServices for the factory which created this session.
JdbcSessionContext	getJdbcSessionContext()
TimeZone	getJdbcTimeZone()	The JDBC TimeZone used when writing a value of type Time or Timestamp to a JDBC PreparedStatement, or when reading from a JDBC ResultSet.
FormatMapper	getJsonFormatMapper()	Obtain the JSON FormatMapper.
LoadQueryInfluencers	getLoadQueryInfluencers()	Get the LoadQueryInfluencers associated with this session.
LobCreator	getLobCreator()	Obtain access to the LobCreator.
NativeQueryImplementor	getNamedNativeQuery(String name)	Get a NativeQuery instance for a named native SQL query
NativeQueryImplementor	getNamedNativeQuery(String name, String resultSetMapping)	Get a NativeQuery instance for a named native SQL query
ProcedureCall	getNamedProcedureCall(String name)	Obtain a ProcedureCall based on a named template
QueryImplementor	getNamedQuery(String name)	Create a Query instance for the named query.
boolean	getNativeJdbcParametersIgnored()
PersistenceContext	getPersistenceContext()	Get the persistence context for this session.
PersistenceContext	getPersistenceContextInternal()	Similar to SharedSessionContractImplementor.getPersistenceContext(), with two differences: this version performs better as it allows for inlining and probably better prediction, and it skips some checks of the current state of the session.
int	getPreferredSqlTypeCodeForBoolean()	The JDBC type code used to bind a null boolean value.
SessionAssociationMarkers	getSessionAssociationMarkers()	Wrap all state that lazy loading interceptors might need to manage association with this session, or to handle lazy loading after detachment via the UUID of the SessionFactory.
UUID	getSessionIdentifier()	Obtain a UUID which uniquely identifies 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.
TransactionCoordinator	getTransactionCoordinator()	Obtain the TransactionCoordinator.
FormatMapper	getXmlFormatMapper()	Obtain the XML FormatMapper.
String	guessEntityName(Object entity)	Obtain an estimate of the entity name of the given entity instance, which is not involved in an association, using only the EntityNameResolver.
Object	immediateLoad(String entityName, Object id)	Load an instance immediately.
void	initializeCollection(PersistentCollection<?> collection, boolean writing)	Initialize the given collection (if not already initialized).
Object	instantiate(String entityName, Object id)	Deprecated.
Object	instantiate(EntityPersister persister, Object id)	Instantiate the entity class of the given EntityPersister, initializing the new instance with the given identifier.
Object	internalLoad(String entityName, Object id, boolean eager, boolean nullable)	Obtain an entity instance with the given id, without checking if it was deleted or scheduled for deletion.
boolean	isClosed()	Determines whether the session is closed.
boolean	isConnected()	Check if the session is currently connected.
boolean	isCriteriaCopyTreeEnabled()
boolean	isCriteriaPlanCacheEnabled()
boolean	isDefaultReadOnly()	Are entities and proxies loaded by this session read-only by default?
boolean	isIdentifierRollbackEnabled()
boolean	isJoinedToTransaction()	Check if the session is joined to the current transaction.
boolean	isOpen()	Check if the session is still open.
boolean	isTransactionInProgress()	Does this session have an active Hibernate transaction, or is it associated with a JTA transaction currently in progress?
void	joinTransaction()	Join the currently-active JTA transaction.
Object	loadFromSecondLevelCache(EntityPersister persister, EntityKey entityKey, Object instanceToLoad, LockMode lockMode)	Attempts to load the entity from the second-level cache.
void	lock(String entityName, Object child, LockOptions lockOptions)	Cascade the lock operation to the given child entity.
void	markForRollbackOnly()	Marks current transaction, if any, for rollback only.
void	prepareForQueryExecution(boolean requiresTxn)	Prepare for the execution of a Query or ProcedureCall
void	registerProcess(AfterTransactionCompletionProcess process)	Registers the given process for execution after transaction completion.
void	setCacheMode(CacheMode cacheMode)	Set the current cache mode for this session.
void	setCriteriaCopyTreeEnabled(boolean jpaCriteriaCopyComplianceEnabled)
void	setCriteriaPlanCacheEnabled(boolean jpaCriteriaCacheEnabled)
void	setJdbcBatchSize(Integer jdbcBatchSize)	Set the session-level JDBC batch size.
void	setNativeJdbcParametersIgnored(boolean nativeJdbcParametersIgnored)
boolean	shouldAutoJoinTransaction()	Indicates whether an active transaction should be automatically joined.
void	startTransactionBoundary()	Callback indicating recognition of entering into a transactional context whether that is explicitly via the Hibernate Transaction API or via registration of Hibernate's JTA Synchronization impl with a JTA Transaction
boolean	useStreamForLobBinding()	Determines whether streams should be used for binding LOB values.

Methods inherited from class java.lang.Object

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

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

getEventManager, getSqlExceptionHelper

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

fromContext

Methods inherited from interface org.hibernate.SharedSessionContract

fromTransaction, inTransaction, unwrap

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

asEventSource, asSessionImplementor, asStatelessSession, bestGuessEntityName, checkOpen, checkTransactionNeededForUpdateOperation, getConfiguredJdbcBatchSize, getDialect, getSession, getSessionFactory, getSessionToken, getTypeConfiguration, isEventSource, isOpenOrWaitingForAutoClose, isSessionImplementor, isStatelessSession

Field Details

delegate

protected final SharedSessionContractImplementor delegate

Constructor Details

SharedSessionDelegatorBaseImpl

public SharedSessionDelegatorBaseImpl(SessionImplementor delegate)

Method Details

delegate

protected SharedSessionContract delegate()

Returns the delegate session.

getTenantIdentifier

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)

getTenantIdentifierValue

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)

createMutationQuery

public MutationQuery createMutationQuery(CriteriaUpdate updateQuery)

Description copied from interface: QueryProducer

Create a MutationQuery from the given update criteria tree

Specified by:

createMutationQuery in interface QueryProducer

Specified by:

createMutationQuery in interface QueryProducerImplementor

createMutationQuery

public MutationQuery createMutationQuery(CriteriaDelete deleteQuery)

Description copied from interface: QueryProducer

Create a MutationQuery from the given delete criteria tree

Specified by:

createMutationQuery in interface QueryProducer

Specified by:

createMutationQuery in interface QueryProducerImplementor

createMutationQuery

public MutationQuery createMutationQuery(JpaCriteriaInsert insert)

Description copied from interface: QueryProducer

Create a MutationQuery from the given insert criteria tree

Specified by:

createMutationQuery in interface QueryProducer

createQuery

public <T> QueryImplementor<T> createQuery(CriteriaQuery<T> criteriaQuery)

Description copied from interface: QueryProducer

Create a Query for the given JPA CriteriaQuery.

Specified by:

createQuery in interface QueryProducer

Specified by:

createQuery in interface QueryProducerImplementor

createQuery

public QueryImplementor createQuery(CriteriaUpdate updateQuery)

Description copied from interface: QueryProducer

Create a MutationQuery for the given JPA CriteriaUpdate

Specified by:

createQuery in interface QueryProducer

Specified by:

createQuery in interface QueryProducerImplementor

createQuery

public QueryImplementor createQuery(CriteriaDelete deleteQuery)

Description copied from interface: QueryProducer

Create a MutationQuery for the given JPA CriteriaDelete

Specified by:

createQuery in interface QueryProducer

Specified by:

createQuery in interface QueryProducerImplementor

getNamedQuery

public QueryImplementor getNamedQuery(String name)

Description copied from interface: QueryProducer

Create a Query instance for the named query.

Specified by:

getNamedQuery in interface QueryProducer

Specified by:

getNamedQuery in interface QueryProducerImplementor

Parameters:

name - the name of a predefined named query

Returns:

The Query instance for manipulation and execution

getNamedNativeQuery

public NativeQueryImplementor getNamedNativeQuery(String name)

Description copied from interface: QueryProducer

Get a NativeQuery instance for a named native SQL query

Specified by:

getNamedNativeQuery in interface QueryProducer

Specified by:

getNamedNativeQuery in interface QueryProducerImplementor

Parameters:

name - The name of the predefined query

Returns:

The NativeQuery instance for manipulation and execution

getNamedNativeQuery

public NativeQueryImplementor getNamedNativeQuery(String name,
 String resultSetMapping)

Description copied from interface: QueryProducer

Get a NativeQuery instance for a named native SQL query

Specified by:

getNamedNativeQuery in interface QueryProducer

Specified by:

getNamedNativeQuery in interface QueryProducerImplementor

Parameters:

name - The name of the predefined query

Returns:

The NativeQuery instance for manipulation and execution

createQuery

public QueryImplementor createQuery(String queryString)

Description copied from interface: QueryProducer

Create a Query instance for the given HQL query, or HQL insert, update, or delete statement.

If a query has no explicit select list, the select list is inferred:

• if there is exactly one root entity in the from clause, and it has no non-fetch joins, then that root entity is the only element of the select list, or
• if there is an entity with the alias this, then that entity is the only element of the select list, or
• otherwise, the query is considered ambiguous, and this method throws a SemanticException.

The query must have an explicit from clause, which can never be inferred.

Specified by:

createQuery in interface QueryProducer

Specified by:

createQuery in interface QueryProducerImplementor

Parameters:

queryString - The HQL query

Returns:

The Query instance for manipulation and execution

See Also:

• EntityManager.createQuery(String)

createSelectionQuery

public SelectionQuery<?> createSelectionQuery(String hqlString)

Description copied from interface: QueryProducer

Create a SelectionQuery reference for the given HQL select statement.

If the statement has no explicit select list, the select list is inferred:

• if there is exactly one root entity in the from clause, and it has no non-fetch joins, then that root entity is the only element of the select list, or
• if there is an entity with the alias this, then that entity is the only element of the select list, or
• otherwise, the query is considered ambiguous, and this method throws a SemanticException.

The query must have an explicit from clause, which can never be inferred.

Specified by:

createSelectionQuery in interface QueryProducer

createSelectionQuery

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

Description copied from interface: QueryProducer

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. In this special case, this method has the same semantics as the overload QueryProducer.createSelectionQuery(String).

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

Specified by:

createSelectionQuery in interface QueryProducer

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:

• EntityManager.createQuery(String)

createSelectionQuery

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

Description copied from interface: QueryProducer

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 Query.getResultList() or Query.getSingleResult().

Specified by:

createSelectionQuery in interface QueryProducer

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:

• EntityManager.createQuery(String)

createSelectionQuery

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

Description copied from interface: QueryProducer

Create a SelectionQuery reference for the given CriteriaQuery.

Specified by:

createSelectionQuery in interface QueryProducer

See Also:

• EntityManager.createQuery(CriteriaQuery)

createQuery

public <T> QueryImplementor<T> createQuery(String queryString,
 Class<T> resultType)

Description copied from interface: QueryProducer

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. In this special case, this method has the same semantics as the overload QueryProducer.createQuery(String).

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

Specified by:

createQuery in interface QueryProducer

Specified by:

createQuery in interface QueryProducerImplementor

Parameters:

queryString - The HQL query

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

Returns:

The Query instance for manipulation and execution

See Also:

• EntityManager.createQuery(String,Class)

createQuery

public <R> QueryImplementor<R> createQuery(TypedQueryReference<R> typedQueryReference)

Description copied from interface: QueryProducer

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

Specified by:

createQuery in interface QueryProducer

Specified by:

createQuery in interface QueryProducerImplementor

Parameters:

typedQueryReference - the type query reference

Returns:

The Query instance for execution

See Also:

• EntityManager.createQuery(TypedQueryReference)

createNamedQuery

public QueryImplementor createNamedQuery(String name)

Description copied from interface: QueryProducer

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 QueryProducer

Specified by:

createNamedQuery in interface QueryProducerImplementor

Parameters:

name - the name of a predefined named query

Returns:

The Query instance for manipulation and execution

See Also:

• EntityManager.createNamedQuery(String)

createNamedQuery

public <T> QueryImplementor<T> createNamedQuery(String name,
 Class<T> resultClass)

Description copied from interface: QueryProducer

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 QueryProducer

Specified by:

createNamedQuery in interface QueryProducerImplementor

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:

• EntityManager.createNamedQuery(String,Class)

createNamedSelectionQuery

public SelectionQuery<?> createNamedSelectionQuery(String name)

Description copied from interface: QueryProducer

Create a SelectionQuery instance for the named NamedQuery.

Specified by:

createNamedSelectionQuery in interface QueryProducer

createNamedSelectionQuery

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

Description copied from interface: QueryProducer

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

Specified by:

createNamedSelectionQuery in interface QueryProducer

createNativeQuery

public NativeQueryImplementor createNativeQuery(String sqlString)

Description copied from interface: QueryProducer

Create a NativeQuery instance for the given native SQL query.

Specified by:

createNativeQuery in interface QueryProducer

Specified by:

createNativeQuery in interface QueryProducerImplementor

Parameters:

sqlString - a native SQL query string

Returns:

The NativeQuery instance for manipulation and execution

See Also:

• EntityManager.createNativeQuery(String)

createNativeQuery

public NativeQueryImplementor createNativeQuery(String sqlString,
 Class resultClass)

Description copied from interface: QueryProducer

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 QueryProducer

Specified by:

createNativeQuery in interface QueryProducerImplementor

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:

• EntityManager.createNativeQuery(String,Class)

createNativeQuery

public <T> NativeQueryImplementor<T> createNativeQuery(String sqlString,
 Class<T> resultClass,
 String tableAlias)

Description copied from interface: QueryProducer

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 QueryProducer

Specified by:

createNativeQuery in interface QueryProducerImplementor

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:

• EntityManager.createNativeQuery(String,Class)

createNativeQuery

public NativeQueryImplementor createNativeQuery(String sqlString,
 String resultSetMappingName)

Description copied from interface: QueryProducer

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 QueryProducer

Specified by:

createNativeQuery in interface QueryProducerImplementor

Parameters:

sqlString - The native (SQL) query string

resultSetMappingName - The explicit result mapping name

Returns:

The NativeQuery instance for manipulation and execution

See Also:

• EntityManager.createNativeQuery(String,Class)
• SqlResultSetMapping

createNativeQuery

public <T> NativeQueryImplementor<T> createNativeQuery(String sqlString,
 String resultSetMappingName,
 Class<T> resultClass)

Description copied from interface: QueryProducer

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 QueryProducer

Specified by:

createNativeQuery in interface QueryProducerImplementor

Parameters:

sqlString - The native (SQL) query string

resultSetMappingName - The explicit result mapping name

Returns:

The NativeQuery instance for manipulation and execution

See Also:

• EntityManager.createNativeQuery(String,Class)
• SqlResultSetMapping

createMutationQuery

public MutationQuery createMutationQuery(String statementString)

Description copied from interface: QueryProducer

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

Specified by:

createMutationQuery in interface QueryProducer

Specified by:

createMutationQuery in interface QueryProducerImplementor

Parameters:

statementString - The HQL insert, update, or delete statement

createNamedMutationQuery

public MutationQuery createNamedMutationQuery(String name)

Description copied from interface: QueryProducer

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 QueryProducer

Specified by:

createNamedMutationQuery in interface QueryProducerImplementor

createNativeMutationQuery

public MutationQuery createNativeMutationQuery(String sqlString)

Description copied from interface: QueryProducer

Create a NativeQuery instance for the given native SQL statement.

Specified by:

createNativeMutationQuery in interface QueryProducer

Specified by:

createNativeMutationQuery in interface QueryProducerImplementor

Parameters:

sqlString - a native SQL statement string

Returns:

The NativeQuery instance for manipulation and execution

createNamedStoredProcedureQuery

public ProcedureCall createNamedStoredProcedureQuery(String name)

Description copied from interface: SharedSessionContract

Obtain a ProcedureCall based on a named template

Specified by:

createNamedStoredProcedureQuery in interface SharedSessionContract

Parameters:

name - The name given to the template

Returns:

The ProcedureCall

See Also:

• NamedStoredProcedureQuery

createStoredProcedureQuery

public ProcedureCall createStoredProcedureQuery(String procedureName)

Description copied from interface: SharedSessionContract

Create a ProcedureCall to a stored procedure.

Specified by:

createStoredProcedureQuery in interface SharedSessionContract

Parameters:

procedureName - The name of the procedure.

Returns:

The representation of the procedure call.

createStoredProcedureQuery

public ProcedureCall createStoredProcedureQuery(String procedureName,
 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 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

public ProcedureCall createStoredProcedureQuery(String procedureName,
 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 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.

getNamedProcedureCall

public ProcedureCall getNamedProcedureCall(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

public ProcedureCall createStoredProcedureCall(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

public ProcedureCall createStoredProcedureCall(String procedureName,
 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

public ProcedureCall createStoredProcedureCall(String procedureName,
 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.

doWork

public void doWork(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(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(java.sql.Connection).

Throws:

HibernateException - Generally indicates wrapped SQLException

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

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

public Transaction getTransaction()

Description copied from interface: SharedSessionContract

Get the Transaction instance associated with this session.

Specified by:

getTransaction in interface SharedSessionContract

Returns:

an instance of Transaction representing the transaction associated with this session

See Also:

• EntityManager.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()

getCriteriaBuilder

public HibernateCriteriaBuilder getCriteriaBuilder()

Description copied from interface: SharedSessionContract

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

Specified by:

getCriteriaBuilder in interface SharedSessionContract

Returns:

an instance of HibernateCriteriaBuilder

See Also:

• SessionFactory.getCriteriaBuilder()

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 JdbcSessionOwner

Specified by:

getJdbcBatchSize in interface SharedSessionContract

Returns:

the current session-level JDBC batch size

See Also:

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

getEventMonitor

public EventMonitor getEventMonitor()

Description copied from interface: JdbcSessionOwner

Obtain a reference to the EventMonitor.

Specified by:

getEventMonitor in interface JdbcSessionOwner

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)

execute

public <T> T execute(LobCreationContext.Callback<T> callback)

Description copied from interface: LobCreationContext

Execute the given callback, making sure it has access to a viable JDBC Connection.

Specified by:

execute in interface LobCreationContext

Type Parameters:

T - The Java type of the type of LOB being created. One of Blob, Clob, NClob

Parameters:

callback - The callback to execute .

Returns:

The LOB created by the callback.

getFactory

public SessionFactoryImplementor getFactory()

Description copied from interface: SharedSessionContractImplementor

Obtain the factory which created this session.

Specified by:

getFactory in interface QueryProducerImplementor

Specified by:

getFactory in interface SharedSessionContract

Specified by:

getFactory in interface SharedSessionContractImplementor

getEventListenerManager

public SessionEventListenerManager getEventListenerManager()

Description copied from interface: SharedSessionContractImplementor

Get the SessionEventListenerManager associated with this session.

Specified by:

getEventListenerManager in interface SharedSessionContractImplementor

getPersistenceContext

public PersistenceContext getPersistenceContext()

Description copied from interface: SharedSessionContractImplementor

Get the persistence context for this session.

See SharedSessionContractImplementor.getPersistenceContextInternal() for a faster alternative.

Specified by:

getPersistenceContext in interface SharedSessionContractImplementor

getJdbcCoordinator

public JdbcCoordinator getJdbcCoordinator()

Description copied from interface: SharedSessionContractImplementor

Obtain the JdbcCoordinator for this session.

Specified by:

getJdbcCoordinator in interface SharedSessionContractImplementor

getJdbcServices

public JdbcServices getJdbcServices()

Description copied from interface: SharedSessionContractImplementor

Obtain the JdbcServices for the factory which created this session.

Specified by:

getJdbcServices in interface SharedSessionContractImplementor

getSessionIdentifier

public UUID getSessionIdentifier()

Description copied from interface: SharedSessionContractImplementor

Obtain a UUID which uniquely identifies this session.

The UUID is useful mainly for logging.

Specified by:

getSessionIdentifier in interface SharedSessionContractImplementor

isClosed

public boolean isClosed()

Description copied from interface: SharedSessionContractImplementor

Determines whether the session is closed.

Specified by:

isClosed in interface SharedSessionContractImplementor

Returns:

true if the session is closed; false otherwise.

checkOpen

public void checkOpen(boolean markForRollbackIfClosed)

Description copied from interface: SharedSessionContractImplementor

Check whether the session is open, and if not:

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

Specified by:

checkOpen in interface SharedSessionContractImplementor

prepareForQueryExecution

public void prepareForQueryExecution(boolean requiresTxn)

Description copied from interface: SharedSessionContractImplementor

Prepare for the execution of a Query or ProcedureCall

Specified by:

prepareForQueryExecution in interface SharedSessionContractImplementor

markForRollbackOnly

public void markForRollbackOnly()

Description copied from interface: SharedSessionContractImplementor

Marks current transaction, if any, for rollback only.

Specified by:

markForRollbackOnly in interface SharedSessionContractImplementor

getCacheTransactionSynchronization

public CacheTransactionSynchronization getCacheTransactionSynchronization()

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

getCacheTransactionSynchronization in interface SharedSessionContractImplementor

isTransactionInProgress

public boolean isTransactionInProgress()

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

isTransactionInProgress in interface SharedSessionContractImplementor

accessTransaction

public Transaction accessTransaction()

Description copied from interface: SharedSessionContractImplementor

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

This method is primarily for internal or integrator use.

Specified by:

accessTransaction in interface SharedSessionContractImplementor

Returns:

the Transaction

generateEntityKey

public EntityKey generateEntityKey(Object id,
 EntityPersister persister)

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

generateEntityKey in interface SharedSessionContractImplementor

Parameters:

id - The entity id

persister - The entity persister

Returns:

The entity key

getInterceptor

public Interceptor getInterceptor()

Description copied from interface: SharedSessionContractImplementor

Retrieves the Interceptor associated with this session.

Specified by:

getInterceptor in interface SharedSessionContractImplementor

initializeCollection

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

Description copied from interface: SharedSessionContractImplementor

Initialize the given collection (if not already initialized).

Specified by:

initializeCollection in interface SharedSessionContractImplementor

Throws:

HibernateException

internalLoad

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

Description copied from interface: SharedSessionContractImplementor

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

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

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

Specified by:

internalLoad in interface SharedSessionContractImplementor

Throws:

HibernateException

immediateLoad

public Object immediateLoad(String entityName,
 Object id)
                     throws HibernateException

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

immediateLoad in interface SharedSessionContractImplementor

Throws:

HibernateException

getEntityPersister

public EntityPersister getEntityPersister(@Nullable String entityName,
 Object object)
                                   throws HibernateException

Description copied from interface: SharedSessionContractImplementor

Get the EntityPersister for the given entity instance.

Specified by:

getEntityPersister in interface SharedSessionContractImplementor

Parameters:

entityName - optional entity name

object - the entity instance

Throws:

HibernateException

getEntityUsingInterceptor

public Object getEntityUsingInterceptor(EntityKey key)
                                 throws HibernateException

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

getEntityUsingInterceptor in interface SharedSessionContractImplementor

Throws:

HibernateException

getContextEntityIdentifier

public Object getContextEntityIdentifier(Object object)

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

getContextEntityIdentifier in interface SharedSessionContractImplementor

bestGuessEntityName

public String bestGuessEntityName(Object object)

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

bestGuessEntityName in interface SharedSessionContractImplementor

guessEntityName

public String guessEntityName(Object entity)
                       throws HibernateException

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

guessEntityName in interface SharedSessionContractImplementor

Throws:

HibernateException

instantiate

@Deprecated
public Object instantiate(String entityName,
 Object id)
                   throws HibernateException

Deprecated.

Description copied from interface: SharedSessionContractImplementor

Instantiate the entity class, initializing with the given identifier.

Specified by:

instantiate in interface SharedSessionContractImplementor

Throws:

HibernateException

instantiate

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

Description copied from interface: SharedSessionContractImplementor

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

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

Specified by:

instantiate in interface SharedSessionContractImplementor

Throws:

HibernateException

isDefaultReadOnly

public boolean isDefaultReadOnly()

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

isDefaultReadOnly in interface SharedSessionContractImplementor

getCacheMode

public CacheMode getCacheMode()

Description copied from interface: SharedSessionContract

Get the current cache mode for this session.

Specified by:

getCacheMode in interface QueryProducerImplementor

Specified by:

getCacheMode in interface SharedSessionContract

Returns:

the current cache mode

setCacheMode

public void setCacheMode(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

setCriteriaCopyTreeEnabled

public void setCriteriaCopyTreeEnabled(boolean jpaCriteriaCopyComplianceEnabled)

Specified by:

setCriteriaCopyTreeEnabled in interface SharedSessionContractImplementor

isCriteriaCopyTreeEnabled

public boolean isCriteriaCopyTreeEnabled()

Specified by:

isCriteriaCopyTreeEnabled in interface SharedSessionContractImplementor

isCriteriaPlanCacheEnabled

public boolean isCriteriaPlanCacheEnabled()

Specified by:

isCriteriaPlanCacheEnabled in interface SharedSessionContractImplementor

setCriteriaPlanCacheEnabled

public void setCriteriaPlanCacheEnabled(boolean jpaCriteriaCacheEnabled)

Specified by:

setCriteriaPlanCacheEnabled in interface SharedSessionContractImplementor

getNativeJdbcParametersIgnored

public boolean getNativeJdbcParametersIgnored()

Specified by:

getNativeJdbcParametersIgnored in interface SharedSessionContractImplementor

setNativeJdbcParametersIgnored

public void setNativeJdbcParametersIgnored(boolean nativeJdbcParametersIgnored)

Specified by:

setNativeJdbcParametersIgnored in interface SharedSessionContractImplementor

getHibernateFlushMode

public FlushMode getHibernateFlushMode()

Description copied from interface: SharedSessionContractImplementor

Get the current FlushMode for this session.

Specified by:

getHibernateFlushMode in interface QueryProducerImplementor

Specified by:

getHibernateFlushMode in interface SharedSessionContractImplementor

Returns:

The flush mode

flush

public void flush()

Description copied from interface: SharedSessionContractImplementor

Flush this session.

Specified by:

flush in interface SharedSessionContractImplementor

afterScrollOperation

public void afterScrollOperation()

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

afterScrollOperation in interface SharedSessionContractImplementor

getLoadQueryInfluencers

public LoadQueryInfluencers getLoadQueryInfluencers()

Description copied from interface: SharedSessionContractImplementor

Get the LoadQueryInfluencers associated with this session.

Specified by:

getLoadQueryInfluencers in interface SharedSessionContractImplementor

Returns:

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

getExceptionConverter

public ExceptionConverter getExceptionConverter()

Description copied from interface: SharedSessionContractImplementor

Obtain an ExceptionConverter for reporting an error.

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

Specified by:

getExceptionConverter in interface SharedSessionContractImplementor

Returns:

the ExceptionConverter for this Session.

getPersistenceContextInternal

public PersistenceContext getPersistenceContextInternal()

Description copied from interface: SharedSessionContractImplementor

Similar to SharedSessionContractImplementor.getPersistenceContext(), with two differences:

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

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

Specified by:

getPersistenceContextInternal in interface SharedSessionContractImplementor

Returns:

the PersistenceContext associated to this session.

autoFlushIfRequired

public boolean autoFlushIfRequired(Set<String> querySpaces)
                            throws HibernateException

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

autoFlushIfRequired in interface SharedSessionContractImplementor

Parameters:

querySpaces - the tables named in the query.

Returns:

true if flush is required, false otherwise.

Throws:

HibernateException

autoFlushIfRequired

public boolean autoFlushIfRequired(Set<String> querySpaces,
 boolean skipPreFlush)
                            throws HibernateException

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

autoFlushIfRequired in interface SharedSessionContractImplementor

Parameters:

querySpaces - the tables named in the query.

skipPreFlush - see AutoFlushEvent.isSkipPreFlush()

Returns:

true if flush is required, false otherwise.

Throws:

HibernateException

autoPreFlush

public void autoPreFlush()

Specified by:

autoPreFlush in interface SharedSessionContractImplementor

afterOperation

public void afterOperation(boolean success)

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

afterOperation in interface SharedSessionContractImplementor

Parameters:

success - true if the operation a success

getJdbcSessionContext

public JdbcSessionContext getJdbcSessionContext()

Specified by:

getJdbcSessionContext in interface JdbcSessionOwner

getJdbcConnectionAccess

public JdbcConnectionAccess getJdbcConnectionAccess()

Specified by:

getJdbcConnectionAccess in interface JdbcSessionOwner

getTransactionCoordinator

public TransactionCoordinator getTransactionCoordinator()

Description copied from interface: JdbcSessionOwner

Obtain the TransactionCoordinator.

Specified by:

getTransactionCoordinator in interface JdbcSessionOwner

Returns:

The TransactionCoordinator

startTransactionBoundary

public void startTransactionBoundary()

Description copied from interface: JdbcSessionOwner

Callback indicating recognition of entering into a transactional context whether that is explicitly via the Hibernate Transaction API or via registration of Hibernate's JTA Synchronization impl with a JTA Transaction

Specified by:

startTransactionBoundary in interface JdbcSessionOwner

afterTransactionBegin

public void afterTransactionBegin()

Description copied from interface: JdbcSessionOwner

An after-begin callback from the coordinator to its owner.

Specified by:

afterTransactionBegin in interface JdbcSessionOwner

beforeTransactionCompletion

public void beforeTransactionCompletion()

Description copied from interface: JdbcSessionOwner

A before-completion callback to the owner.

Specified by:

beforeTransactionCompletion in interface JdbcSessionOwner

afterTransactionCompletion

public void afterTransactionCompletion(boolean successful,
 boolean delayed)

Description copied from interface: JdbcSessionOwner

An after-completion callback to the owner.

Specified by:

afterTransactionCompletion in interface JdbcSessionOwner

Parameters:

successful - Was the transaction successful?

delayed - Is this a delayed after transaction completion call (aka after a timeout)?

flushBeforeTransactionCompletion

public void flushBeforeTransactionCompletion()

Specified by:

flushBeforeTransactionCompletion in interface JdbcSessionOwner

shouldAutoJoinTransaction

public boolean shouldAutoJoinTransaction()

Description copied from interface: TransactionCoordinatorBuilder.Options

Indicates whether an active transaction should be automatically joined. Only relevant for JTA-based TransactionCoordinator instances.

Specified by:

shouldAutoJoinTransaction in interface TransactionCoordinatorBuilder.Options

Returns:

true indicates the active transaction should be auto joined; false indicates it should not (until TransactionCoordinator.explicitJoin() is called).

useStreamForLobBinding

public boolean useStreamForLobBinding()

Description copied from interface: WrapperOptions

Determines whether streams should be used for binding LOB values.

Specified by:

useStreamForLobBinding in interface WrapperOptions

Returns:

true/false

See Also:

• Dialect.useInputStreamToInsertBlob()

getPreferredSqlTypeCodeForBoolean

public int getPreferredSqlTypeCodeForBoolean()

Description copied from interface: WrapperOptions

The JDBC type code used to bind a null boolean value.

Specified by:

getPreferredSqlTypeCodeForBoolean in interface WrapperOptions

See Also:

• MappingSettings.PREFERRED_BOOLEAN_JDBC_TYPE
• Dialect.getPreferredSqlTypeCodeForBoolean()

getLobCreator

public LobCreator getLobCreator()

Description copied from interface: WrapperOptions

Obtain access to the LobCreator.

Specified by:

getLobCreator in interface WrapperOptions

Returns:

The LOB creator

See Also:

• JdbcSettings.NON_CONTEXTUAL_LOB_CREATION
• Dialect.getDefaultNonContextualLobCreation()

getJdbcTimeZone

public TimeZone getJdbcTimeZone()

Description copied from interface: WrapperOptions

The JDBC TimeZone used when writing a value of type Time or Timestamp to a JDBC PreparedStatement, or when reading from a JDBC ResultSet.

• When getJdbcTimeZone() is null, the method PreparedStatement.setTimestamp(int, java.sql.Timestamp) is called to write a timestamp, and ResultSet.getTimestamp(int) is called to read a timestamp.
• But when not null, the method PreparedStatement.setTimestamp(int, java.sql.Timestamp, java.util.Calendar) is called to write a timestamp, and ResultSet.getTimestamp(int, java.util.Calendar) is called to read a timestamp.

Thus, the storage TimeZone can differ from the default JVM TimeZone given by TimeZone.getDefault().

Specified by:

getJdbcTimeZone in interface WrapperOptions

Returns:

the JDBC TimeZone, or null if no JDBC timezone was explicitly set

See Also:

• JdbcSettings.JDBC_TIME_ZONE

createEntityGraph

public <T> RootGraphImplementor<T> createEntityGraph(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 SharedSessionContract

Specified by:

createEntityGraph in interface SharedSessionContractImplementor

Parameters:

rootType - the root entity class of the graph

See Also:

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

createEntityGraph

public RootGraphImplementor<?> createEntityGraph(String graphName)

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

Specified by:

createEntityGraph in interface SharedSessionContractImplementor

Parameters:

graphName - the name of the graph

See Also:

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

createEntityGraph

public <T> RootGraph<T> createEntityGraph(Class<T> rootType,
 String graphName)

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

See Also:

• EntityManagerFactory.addNamedEntityGraph(String, EntityGraph)
• EntityManager.createEntityGraph(String)

getEntityGraph

public RootGraphImplementor<?> getEntityGraph(String graphName)

Description copied from interface: SharedSessionContract

Obtain an immutable reference to a predefined named entity graph.

Specified by:

getEntityGraph in interface SharedSessionContract

Specified by:

getEntityGraph in interface SharedSessionContractImplementor

Parameters:

graphName - the name of the predefined named entity graph

See Also:

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

getEntityGraphs

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

Description copied from interface: SharedSessionContract

Retrieve all named EntityGraphs with the given root entity type.

Specified by:

getEntityGraphs in interface SharedSessionContract

See Also:

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

enableFilter

public Filter enableFilter(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

public Filter getEnabledFilter(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(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.

getJsonFormatMapper

public FormatMapper getJsonFormatMapper()

Description copied from interface: WrapperOptions

Obtain the JSON FormatMapper.

Specified by:

getJsonFormatMapper in interface WrapperOptions

getXmlFormatMapper

public FormatMapper getXmlFormatMapper()

Description copied from interface: WrapperOptions

Obtain the XML FormatMapper.

Specified by:

getXmlFormatMapper in interface WrapperOptions

lock

public void lock(String entityName,
 Object child,
 LockOptions lockOptions)

Description copied from interface: SharedSessionContractImplementor

Cascade the lock operation to the given child entity.

Specified by:

lock in interface SharedSessionContractImplementor

registerProcess

public void registerProcess(AfterTransactionCompletionProcess process)

Description copied from interface: SharedSessionContractImplementor

Registers the given process for execution after transaction completion.

Specified by:

registerProcess in interface SharedSessionContractImplementor

Parameters:

process - The process to register

loadFromSecondLevelCache

public Object loadFromSecondLevelCache(EntityPersister persister,
 EntityKey entityKey,
 Object instanceToLoad,
 LockMode lockMode)

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

loadFromSecondLevelCache in interface SharedSessionContractImplementor

Parameters:

persister - The persister for the entity being requested for load

entityKey - The entity key

instanceToLoad - The instance that is being initialized, or null

lockMode - The lock mode

Returns:

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

getSessionAssociationMarkers

public SessionAssociationMarkers getSessionAssociationMarkers()

Description copied from interface: SharedSessionContractImplementor

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

Specified by:

getSessionAssociationMarkers in interface SharedSessionContractImplementor

isIdentifierRollbackEnabled

public boolean isIdentifierRollbackEnabled()

Specified by:

isIdentifierRollbackEnabled in interface SharedSessionContractImplementor

afterObtainConnection

public void afterObtainConnection(Connection connection)
                           throws SQLException

Description copied from interface: JdbcSessionOwner

Called after a managed JDBC connection is obtained.

Sets the schema to the schema belonging to the current tenant if:

1. "hibernate.multi_tenant.schema_mapper" is enabled, and
2. this session has an active tenant id.

Specified by:

afterObtainConnection in interface JdbcSessionOwner

Parameters:

connection - A JDBC connection which was just acquired

Throws:

SQLException

beforeReleaseConnection

public void beforeReleaseConnection(Connection connection)
                             throws SQLException

Description copied from interface: JdbcSessionOwner

Called right before a managed JDBC connection is released.

Unset the schema which was set by JdbcSessionOwner.afterObtainConnection(java.sql.Connection), if any. .

Specified by:

beforeReleaseConnection in interface JdbcSessionOwner

Parameters:

connection - The JDBC connection which is about to be released

Throws:

SQLException