Package org.hibernate.internal

Class SessionImpl

java.lang.Object

org.hibernate.internal.AbstractSharedSessionContract

org.hibernate.internal.SessionImpl

All Implemented Interfaces:

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

public class SessionImpl
extends AbstractSharedSessionContract
implements Serializable, SharedSessionContractImplementor, JdbcSessionOwner, SessionImplementor, EventSource, TransactionCoordinatorBuilder.Options, WrapperOptions, LoadAccessContext

Concrete implementation of the Session API.

Exposes two interfaces:

• Session to the application, and
• SessionImplementor and EventSource (both SPI interfaces) to other subsystems.

This class is not thread-safe.

See Also:

• Serialized Form

Implementation Note:

The SessionImpl does not directly perform operations against the database or second-level cache. Instead, it is an EventSource, raising events which are processed by various implementations of the listener interfaces defined by org.hibernate.event.spi. These listeners typically place EntityAction instances on the ActionQueue associated with the session, and such actions are executed asynchronously when the session is flushed. The motivation behind this architecture is two-fold: first, it enables customization by sophisticated extensions to Hibernate ORM, and, second, it enables the transactional write-behind semantics of a stateful session. The stateful session holds its state in an instance of StatefulPersistenceContext, which we may view as the first-level cache associated with the session.

Nested Class Summary

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

LobCreationContext.Callback<T>

Field Summary

Fields inherited from class org.hibernate.internal.AbstractSharedSessionContract

closed, waitingForAutoClose

Constructor Summary

Constructors

Constructor	Description
SessionImpl(SessionFactoryImpl factory, SessionCreationOptions options)

Method Summary

Modifier and Type	Method	Description
void	addEventListeners(SessionEventListener... listeners)	Add one or more listeners to the Session
protected void	addSharedSessionTransactionObserver(TransactionCoordinator transactionCoordinator)
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.
protected void	applyLockOptionsHint(SelectionQuery<?> query)
protected void	applyQuerySettingsAndHints(Query<?> query)
protected void	applyQuerySettingsAndHints(SelectionQuery<?> query)
EventSource	asEventSource()	Cast this session to EventSource if possible.
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	beforeTransactionCompletion()	A before-completion callback to the owner.
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.
String	bestGuessEntityName(Object object, EntityEntry entry)	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.
<T> IdentifierLoadAccessImpl<T>	byId(Class<T> entityClass)	Create an IdentifierLoadAccess instance to retrieve an instance of the given entity type by its primary key.
<T> IdentifierLoadAccessImpl<T>	byId(String entityName)	Create an IdentifierLoadAccess instance to retrieve an instance of the named entity type by its primary key.
<T> MultiIdentifierLoadAccess<T>	byMultipleIds(Class<T> entityClass)	Create a MultiIdentifierLoadAccess instance to retrieve multiple instances of the given entity type by their primary key values, using batching.
<T> MultiIdentifierLoadAccess<T>	byMultipleIds(String entityName)	Create a MultiIdentifierLoadAccess instance to retrieve multiple instances of the named entity type by their primary key values, using batching.
<T> NaturalIdMultiLoadAccess<T>	byMultipleNaturalId(Class<T> entityClass)	Create a MultiIdentifierLoadAccess instance to retrieve multiple instances of the given entity type by their by natural id values, using batching.
<T> NaturalIdMultiLoadAccess<T>	byMultipleNaturalId(String entityName)	Create a MultiIdentifierLoadAccess instance to retrieve multiple instances of the named entity type by their by natural id values, using batching.
<T> NaturalIdLoadAccess<T>	byNaturalId(Class<T> entityClass)	Create a NaturalIdLoadAccess instance to retrieve an instance of the given entity type by its natural id, which may be a composite natural id.
<T> NaturalIdLoadAccess<T>	byNaturalId(String entityName)	Create a NaturalIdLoadAccess instance to retrieve an instance of the named entity type by its natural id, which may be a composite natural id.
<T> SimpleNaturalIdLoadAccess<T>	bySimpleNaturalId(Class<T> entityClass)	Create a SimpleNaturalIdLoadAccess instance to retrieve an instance of the given entity type by its natural id, which must be a simple (non-composite) value.
<T> SimpleNaturalIdLoadAccess<T>	bySimpleNaturalId(String entityName)	Create a SimpleNaturalIdLoadAccess instance to retrieve an instance of the named entity type by its natural id, which must be a simple (non-composite) value.
void	cancelQuery()	Cancel the execution of the current query.
protected void	checkNoUnresolvedActionsAfterOperation()
protected void	checkNoUnresolvedActionsBeforeOperation()
void	checkOpenOrWaitingForAutoClose()	Callback to check whether the session is "active"
protected void	checkSessionFactoryOpen()
protected void	checkTransactionNeededForLock(LockMode lockMode)
protected void	cleanupOnClose()	clear all the internal collections, just to help the garbage collector, does not clear anything that is needed during the afterTransactionCompletion() phase
void	clear()	Completely clear the persistence context.
void	close()	End the session by releasing the JDBC connection and cleaning up.
void	closeWithoutOpenChecks()
boolean	contains(Object object)
boolean	contains(String entityName, Object object)	Determine if the given entity is associated with this session.
protected ActionQueue	createActionQueue()
ProcedureCall	createNamedStoredProcedureQuery(String name)	Obtain a ProcedureCall based on a named template
protected PersistenceContext	createPersistenceContext()
<T> QueryImplementor<T>	createQuery(CriteriaSelect<T> selectQuery)
ProcedureCall	createStoredProcedureCall(String procedureName)	Create a ProcedureCall to a stored procedure.
ProcedureCall	createStoredProcedureCall(String procedureName, Class<?>... resultClasses)	Create a ProcedureCall to a stored procedure with the given result set entity mappings.
ProcedureCall	createStoredProcedureCall(String procedureName, String... resultSetMappings)	Create a ProcedureCall to a stored procedure with the given result set entity mappings.
ProcedureCall	createStoredProcedureQuery(String procedureName)	Create a ProcedureCall to a stored procedure.
ProcedureCall	createStoredProcedureQuery(String procedureName, Class... resultClasses)	Create a ProcedureCall to a stored procedure with the given result set entity mappings.
ProcedureCall	createStoredProcedureQuery(String procedureName, String... resultSetMappings)	Create a ProcedureCall to a stored procedure with the given result set entity mappings.
void	delayedAfterCompletion()
void	delete(String entityName, Object object, boolean isCascadeDeleteEnabled, DeleteContext transientEntities)	Cascade delete an entity instance
void	detach(Object entity)	Remove this instance from the session cache.
protected CacheMode	determineAppropriateLocalCacheMode(Map<String,Object> localProperties)
void	disableFetchProfile(String name)	Disable the fetch profile with the given name in this session.
void	enableFetchProfile(String name)	Enable the fetch profile with the given name in this session.
void	evict(Object object)	remove any hard references to the entity that are held by the infrastructure (references held by application or other persistent instances are okay)
<T> T	find(EntityGraph<T> entityGraph, Object primaryKey, FindOption... options)
<T> T	find(Class<T> entityClass, Object primaryKey)	Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
<T> T	find(Class<T> entityClass, Object primaryKey, FindOption... options)
<T> T	find(Class<T> entityClass, Object primaryKey, LockModeType lockModeType)
<T> T	find(Class<T> entityClass, Object primaryKey, LockModeType lockModeType, Map<String,Object> properties)
<T> T	find(Class<T> entityClass, Object primaryKey, Map<String,Object> properties)
Object	find(String entityName, Object primaryKey)	Return the persistent instance of the named entity type with the given identifier, or null if there is no such persistent instance.
Object	find(String entityName, Object primaryKey, FindOption... options)	Return the persistent instance of the named entity type with the given identifier using the specified options, or null if there is no such persistent instance.
<E> List<E>	findMultiple(EntityGraph<E> entityGraph, List<?> ids, FindOption... options)	Return the persistent instances of the root entity of the given EntityGraph with the given identifiers as a list, fetching the associations specified by the graph, which is interpreted as a load graph.
<E> List<E>	findMultiple(Class<E> entityType, List<?> ids, FindOption... options)	Return the persistent instances of the given entity class with the given identifiers as a list.
void	flush()	Flush this session.
void	flushBeforeTransactionCompletion()
void	forceFlush(EntityEntry entityEntry)	Initiate a flush to force deletion of a re-persisted entity.
void	forceFlush(EntityKey key)	Initiate a flush to force deletion of a re-persisted entity.
<T> T	get(Class<T> entityClass, Object id)	Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
<T> T	get(Class<T> entityClass, Object id, LockMode lockMode)	Deprecated.
<T> T	get(Class<T> entityClass, Object id, LockOptions lockOptions)	Deprecated.
Object	get(String entityName, Object id)	Return the persistent instance of the given named entity with the given identifier, or null if there is no such persistent instance.
Object	get(String entityName, Object id, LockMode lockMode)	Deprecated.
Object	get(String entityName, Object id, LockOptions lockOptions)	Deprecated.
ActionQueue	getActionQueue()	Get the ActionQueue associated with this session.
CacheRetrieveMode	getCacheRetrieveMode()	The JPA-defined CacheRetrieveMode.
CacheStoreMode	getCacheStoreMode()	The JPA-defined CacheStoreMode.
Object	getContextEntityIdentifier(Object object)	Get the id value for an object that is actually associated with the session.
LockMode	getCurrentLockMode(Object object)	Determine the current lock mode held on the given managed instance associated with this session.
Object	getDelegate()
SessionFactoryImplementor	getEntityManagerFactory()
String	getEntityName(Object object)	Return the entity name for the given persistent entity.
EntityPersister	getEntityPersister(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.
int	getFetchBatchSize()	Get the maximum batch size for batch fetching associations by id in this session.
FlushModeType	getFlushMode()	Get the current JPA flush mode for this session.
FlushMode	getHibernateFlushMode()	Get the current FlushMode for this session.
Object	getIdentifier(Object object)	Return the identifier value of the given entity associated with this session.
LoadQueryInfluencers	getLoadQueryInfluencers()	Get the LoadQueryInfluencers associated with this session.
LobHelper	getLobHelper()	Obtain a LobHelper for instances of Blob and Clob.
LockModeType	getLockMode(Object entity)
Collection<?>	getManagedEntities()	Obtain the collection of all managed entities which belong to this persistence context.
<E> Collection<E>	getManagedEntities(EntityType<E> entityType)	Obtain a collection of all managed entities of the given type which belong to this persistence context.
<E> Collection<E>	getManagedEntities(Class<E> entityType)	Obtain a collection of all managed entities of the given type which belong to this persistence context.
Collection<?>	getManagedEntities(String entityName)	Obtain a collection of all managed instances of the entity type with the given entity name which belong to this persistence context.
Metamodel	getMetamodel()
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.
Map<String,Object>	getProperties()
protected Boolean	getReadOnlyFromLoadQueryInfluencers()
<T> T	getReference(Class<T> entityClass, Object id)	Return a reference to the persistent instance with the given class and identifier, making the assumption that the instance is still persistent in the database.
Object	getReference(String entityName, Object id)	Return a reference to the persistent instance of the given named entity with the given identifier, making the assumption that the instance is still persistent in the database.
<T> T	getReference(T object)	Return a reference to the persistent instance with the same identity as the given instance, which might be detached, making the assumption that the instance is still persistent in the database.
SessionImplementor	getSession()	Returns this object, fulfilling the contract of WrapperOptions.
SessionStatistics	getStatistics()	Get the statistics for this session.
String	guessEntityName(Object object)	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 the data for the object with the specified id into a newly created object.
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)	give the interceptor an opportunity to override the default instantiation
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.
protected static LoadEventListener.LoadType	internalLoadType(boolean eager, boolean nullable)
boolean	isAutoCloseSessionEnabled()	Should this session be automatically closed after the current transaction completes?
boolean	isDefaultReadOnly()	Are entities and proxies loaded by this session read-only by default?
boolean	isDirty()	Does this session contain any changes which must be synchronized with the database? In other words, would any DML operations be executed if we flushed this session?
boolean	isEventSource()	Determines if this session implements EventSource.
boolean	isFetchProfileEnabled(String name)	Is the fetch profile with the given name enabled in this session?
boolean	isIdentifierRollbackEnabled()
boolean	isOpen()	Check if the session is still open.
boolean	isReadOnly(Object entityOrProxy)	Is the specified entity or proxy read-only?
boolean	isSubselectFetchingEnabled()	Determine if subselect fetching is enabled in this session.
void	load(Object object, Object id)	Read the persistent state associated with the given identifier into the given transient instance.
Object	load(LoadEventListener.LoadType loadType, Object id, String entityName, LockOptions lockOptions, Boolean readOnly)	Efficiently fire a LoadEvent with the given type and return the resulting entity instance or proxy.
Object	loadFromSecondLevelCache(EntityPersister persister, EntityKey entityKey, Object instanceToLoad, LockMode lockMode)	Attempts to load the entity from the second-level cache.
void	lock(Object entity, LockModeType lockModeType)
void	lock(Object entity, LockModeType lockModeType, LockOption... options)
void	lock(Object entity, LockModeType lockModeType, Map<String,Object> properties)
void	lock(Object object, LockMode lockMode)	Obtain the specified lock level on the given managed instance associated with this session.
void	lock(Object object, LockMode lockMode, LockOption... lockOptions)	Obtain the specified lock level on the given managed instance associated with this session, applying any other specified options.
void	lock(Object object, LockOptions lockOptions)	Obtain a lock on the given managed instance associated with this session, using the given lock options.
void	lock(String entityName, Object object, LockOptions lockOptions)	Cascade the lock operation to the given child entity.
protected static <T> void	logIgnoringEntityNotFound(Class<T> entityClass, Object primaryKey)
protected LoadEvent	makeLoadEvent(String entityName, Object id, Boolean readOnly, boolean isAssociationFetch)	Helper to avoid creating many new instances of LoadEvent.
protected LoadEvent	makeLoadEvent(String entityName, Object id, Boolean readOnly, LockOptions lockOptions)	Helper to avoid creating many new instances of LoadEvent.
protected PostLoadEvent	makePostLoadEvent(EntityPersister persister, Object id, Object entity)	Helper to avoid creating many new instances of PostLoadEvent.
void	merge(String entityName, Object object, MergeContext copiedAlready)	Cascade merge an entity instance
<T> T	merge(String entityName, T object)	Copy the state of the given object onto the persistent object with the same identifier.
<T> T	merge(T object)	Copy the state of the given object onto the persistent object with the same identifier.
<T> T	merge(T object, EntityGraph<?> loadGraph)	Copy the state of the given object onto the persistent object with the same identifier.
void	persist(Object object)	Make a transient instance persistent and mark it for later insertion in the database.
void	persist(String entityName, Object object)	Make a transient instance persistent and mark it for later insertion in the database.
void	persist(String entityName, Object object, PersistContext copiedAlready)	Cascade persist an entity instance
void	persistOnFlush(String entityName, Object object, PersistContext copiedAlready)	Cascade persist an entity instance during the flush process
void	pulseTransactionCoordinator()	Callback to pulse the transaction coordinator
protected static Boolean	readOnlyHint(Map<String,Object> properties)
void	refresh(Object object)	Reread the state of the given managed instance associated with this session from the underlying database.
void	refresh(Object entity, LockModeType lockModeType)
void	refresh(Object entity, LockModeType lockModeType, Map<String,Object> properties)
void	refresh(Object entity, RefreshOption... options)
void	refresh(Object entity, Map<String,Object> properties)
void	refresh(Object object, LockOptions lockOptions)	Reread the state of the given managed instance from the underlying database, obtaining the given LockMode.
void	refresh(String entityName, Object object, RefreshContext refreshedAlready)	Cascade refresh an entity instance
void	registerProcess(AfterTransactionCompletionProcess process)	Registers the given process for execution after transaction completion.
protected void	releaseLoadEvent(LoadEvent event)
protected void	releasePostLoadEvent(PostLoadEvent event)
void	remove(Object entity)	Mark a persistence instance associated with this session for removal from the underlying database.
void	removeOrphanBeforeUpdates(String entityName, Object child)	A specialized type of deletion for orphan removal that must occur prior to queued inserts and updates.
protected void	removeSharedSessionTransactionObserver(TransactionCoordinator transactionCoordinator)
void	replicate(Object obj, ReplicationMode replicationMode)	Persist the state of the given detached instance, reusing the current identifier value.
void	replicate(String entityName, Object obj, ReplicationMode replicationMode)	Persist the state of the given detached instance, reusing the current identifier value.
SharedSessionBuilder	sessionWithOptions()	Obtain a Session builder with the ability to copy certain information from this session.
void	setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)	Enable or disable reads from the second-level cache.
void	setCacheStoreMode(CacheStoreMode cacheStoreMode)	Enable or disable writes to the second-level cache.
void	setDefaultReadOnly(boolean defaultReadOnly)	Change the default for entities and proxies loaded into this session from modifiable to read-only mode, or from modifiable to read-only mode.
void	setFetchBatchSize(int batchSize)	Set the maximum batch size for batch fetching associations by id in this session.
void	setFlushMode(FlushModeType flushModeType)	Set the current JPA flush mode for this session.
void	setHibernateFlushMode(FlushMode flushMode)	Set the current flush mode for this session.
void	setProperty(String propertyName, Object value)	Set a hint.
void	setReadOnly(Object entity, boolean readOnly)	Set an unmodified persistent object to read-only mode, or a read-only object to modifiable mode.
void	setSubselectFetchingEnabled(boolean enabled)	Enable or disable subselect fetching in this session.
boolean	shouldAutoClose()
protected boolean	shouldCloseJdbcCoordinatorOnClose(boolean isTransactionCoordinatorShared)
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
String	toString()
<T> T	unwrap(Class<T> type)	Return an object of the specified type to allow access to a provider-specific API.

Methods inherited from class org.hibernate.internal.AbstractSharedSessionContract

accessTransaction, afterObtainConnection, beforeReleaseConnection, beginTransaction, buildNamedQuery, checkMutationQuery, checkOpen, checkResultType, checkSelectionQuery, checkTransactionNeededForUpdateOperation, checkTransactionSynchStatus, createCriteriaQuery, createEntityGraph, createEntityGraph, createEntityGraph, createMutationQuery, createMutationQuery, createMutationQuery, createMutationQuery, createNamedMutationQuery, createNamedQuery, createNamedQuery, createNamedSelectionQuery, createNamedSelectionQuery, createNativeMutationQuery, createNativeQuery, createNativeQuery, createNativeQuery, createNativeQuery, createNativeQuery, createNativeQueryImplementor, createNativeQueryImplementor, createNativeQueryImplementor, createQuery, createQuery, createQuery, createQuery, createQuery, createQuery, createSelectionQuery, createSelectionQuery, createSelectionQuery, createSelectionQuery, createSqmQueryImplementor, createSqmQueryImplementor, createSqmQueryImplementor, disableFilter, doReturningWork, doWork, enableFilter, execute, generateEntityKey, getCacheMode, getCacheTransactionSynchronization, getConfiguredJdbcBatchSize, getCriteriaBuilder, getCurrentTransaction, getDialect, getEnabledFilter, getEntityGraph, getEntityGraphs, getEntityNameResolver, getEventListenerManager, getEventMonitor, getExceptionConverter, getFactory, getInterceptor, getJdbcBatchSize, getJdbcConnectionAccess, getJdbcCoordinator, getJdbcServices, getJdbcSessionContext, getJdbcTimeZone, getJsonFormatMapper, getLobCreator, getNamedNativeQuery, getNamedNativeQuery, getNamedProcedureCall, getNamedQuery, getNativeJdbcParametersIgnored, getPreferredSqlTypeCodeForBoolean, getResultSetMappingMemento, getSessionAssociationMarkers, getSessionFactory, getSessionIdentifier, getSessionToken, getTenantIdentifier, getTenantIdentifierValue, getTransaction, getTransactionCoordinator, getTypeConfiguration, getXmlFormatMapper, interpretHql, isClosed, isConnected, isCriteriaCopyTreeEnabled, isCriteriaPlanCacheEnabled, isJoinedToTransaction, isOpenOrWaitingForAutoClose, isTransactionInProgress, joinTransaction, markForRollbackOnly, prepareForAutoClose, prepareForQueryExecution, requireCollectionPersister, requireEntityPersister, requireEntityPersister, setCacheMode, setClosed, setCriteriaCopyTreeEnabled, setCriteriaPlanCacheEnabled, setJdbcBatchSize, setNativeJdbcParametersIgnored, setUpMultitenancy, shouldAutoJoinTransaction, useStreamForLobBinding

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.persistence.EntityManager

createNativeQuery, createNativeQuery, createNativeQuery, getCriteriaBuilder, getTransaction, isJoinedToTransaction, joinTransaction

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

afterObtainConnection, beforeReleaseConnection, getEventManager, getEventMonitor, getJdbcBatchSize, getJdbcConnectionAccess, getJdbcSessionContext, getSqlExceptionHelper, getTransactionCoordinator

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

execute, fromContext

Methods inherited from interface org.hibernate.query.QueryProducer

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

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

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

Methods inherited from interface org.hibernate.Session

createEntityGraph, createEntityGraph, createNamedQuery, createNamedQuery, createQuery, createQuery, createQuery, createQuery, createQuery, createQuery, getCacheMode, getEntityGraph, getEntityGraphs, setCacheMode

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

callWithConnection, getSessionFactory, runWithConnection

Methods inherited from interface org.hibernate.SharedSessionContract

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

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

accessTransaction, asSessionImplementor, asStatelessSession, checkOpen, checkOpen, checkTransactionNeededForUpdateOperation, createEntityGraph, createEntityGraph, generateEntityKey, getCacheTransactionSynchronization, getConfiguredJdbcBatchSize, getDialect, getEntityGraph, getEventListenerManager, getExceptionConverter, getFactory, getInterceptor, getJdbcCoordinator, getJdbcServices, getNativeJdbcParametersIgnored, getSessionAssociationMarkers, getSessionFactory, getSessionIdentifier, getSessionToken, getTypeConfiguration, isClosed, isCriteriaCopyTreeEnabled, isCriteriaPlanCacheEnabled, isOpenOrWaitingForAutoClose, isSessionImplementor, isStatelessSession, isTransactionInProgress, markForRollbackOnly, prepareForQueryExecution, setCriteriaCopyTreeEnabled, setCriteriaPlanCacheEnabled, setNativeJdbcParametersIgnored

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

shouldAutoJoinTransaction

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

getJdbcTimeZone, getJsonFormatMapper, getLobCreator, getPreferredSqlTypeCodeForBoolean, getXmlFormatMapper, useStreamForLobBinding

Constructor Details

SessionImpl

public SessionImpl(SessionFactoryImpl factory,
 SessionCreationOptions options)

Method Details

createPersistenceContext

protected PersistenceContext createPersistenceContext()

createActionQueue

protected ActionQueue createActionQueue()

applyQuerySettingsAndHints

protected void applyQuerySettingsAndHints(SelectionQuery<?> query)

Overrides:

applyQuerySettingsAndHints in class AbstractSharedSessionContract

applyLockOptionsHint

protected void applyLockOptionsHint(SelectionQuery<?> query)

applyQuerySettingsAndHints

protected void applyQuerySettingsAndHints(Query<?> query)

Overrides:

applyQuerySettingsAndHints in class AbstractSharedSessionContract

sessionWithOptions

public SharedSessionBuilder sessionWithOptions()

Description copied from interface: Session

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

Specified by:

sessionWithOptions in interface Session

Returns:

the session builder

clear

public void clear()

Description copied from interface: Session

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

Does not close open iterators or instances of ScrollableResults.

Specified by:

clear in interface EntityManager

Specified by:

clear in interface Session

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 EntityManager

Specified by:

close in interface SharedSessionContract

Overrides:

close in class AbstractSharedSessionContract

closeWithoutOpenChecks

public void closeWithoutOpenChecks()

shouldCloseJdbcCoordinatorOnClose

protected boolean shouldCloseJdbcCoordinatorOnClose(boolean isTransactionCoordinatorShared)

Overrides:

shouldCloseJdbcCoordinatorOnClose in class AbstractSharedSessionContract

isAutoCloseSessionEnabled

public boolean isAutoCloseSessionEnabled()

Should this session be automatically closed after the current transaction completes?

isIdentifierRollbackEnabled

public boolean isIdentifierRollbackEnabled()

Specified by:

isIdentifierRollbackEnabled in interface SharedSessionContractImplementor

isOpen

public boolean isOpen()

Description copied from interface: SharedSessionContract

Check if the session is still open.

Specified by:

isOpen in interface EntityManager

Specified by:

isOpen in interface SharedSessionContract

Overrides:

isOpen in class AbstractSharedSessionContract

Returns:

true if it is open

checkSessionFactoryOpen

protected void checkSessionFactoryOpen()

shouldAutoClose

public boolean shouldAutoClose()

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

addEventListeners

public void addEventListeners(SessionEventListener... listeners)

Description copied from interface: Session

Add one or more listeners to the Session

Specified by:

addEventListeners in interface Session

Parameters:

listeners - the listener(s) to add

cleanupOnClose

protected void cleanupOnClose()

clear all the internal collections, just to help the garbage collector, does not clear anything that is needed during the afterTransactionCompletion() phase

Overrides:

cleanupOnClose in class AbstractSharedSessionContract

getCurrentLockMode

public LockMode getCurrentLockMode(Object object)

Description copied from interface: Session

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

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

Specified by:

getCurrentLockMode in interface Session

Parameters:

object - a persistent instance associated with this session

Returns:

the lock mode currently held on the given entity

getEntityUsingInterceptor

public Object getEntityUsingInterceptor(EntityKey key)

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

checkNoUnresolvedActionsBeforeOperation

protected void checkNoUnresolvedActionsBeforeOperation()

checkNoUnresolvedActionsAfterOperation

protected void checkNoUnresolvedActionsAfterOperation()

delayedAfterCompletion

public void delayedAfterCompletion()

Specified by:

delayedAfterCompletion in interface LoadAccessContext

Overrides:

delayedAfterCompletion in class AbstractSharedSessionContract

pulseTransactionCoordinator

public void pulseTransactionCoordinator()

Description copied from interface: LoadAccessContext

Callback to pulse the transaction coordinator

Specified by:

pulseTransactionCoordinator in interface LoadAccessContext

Overrides:

pulseTransactionCoordinator in class AbstractSharedSessionContract

checkOpenOrWaitingForAutoClose

public void checkOpenOrWaitingForAutoClose()

Description copied from interface: LoadAccessContext

Callback to check whether the session is "active"

Specified by:

checkOpenOrWaitingForAutoClose in interface LoadAccessContext

lock

public void lock(Object object,
 LockOptions lockOptions)

Description copied from interface: Session

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

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

Specified by:

lock in interface Session

Parameters:

object - a persistent instance associated with this session

lockOptions - the lock options

lock

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

Description copied from interface: SharedSessionContractImplementor

Cascade the lock operation to the given child entity.

Specified by:

lock in interface SharedSessionContractImplementor

lock

public void lock(Object object,
 LockMode lockMode)

Description copied from interface: Session

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

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

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

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

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

Specified by:

lock in interface Session

Parameters:

object - a persistent instance associated with this session

lockMode - the lock level

See Also:

• EntityManager.lock(Object, LockModeType)

lock

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

Description copied from interface: Session

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

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

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

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

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

Specified by:

lock in interface Session

Parameters:

object - a persistent instance associated with this session

lockMode - the lock level

See Also:

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

persist

public void persist(String entityName,
 Object object)

Description copied from interface: Session

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

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

Specified by:

persist in interface Session

Parameters:

entityName - the entity name

object - a transient instance to be made persistent

persist

public void persist(Object object)

Description copied from interface: Session

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

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

Specified by:

persist in interface EntityManager

Specified by:

persist in interface Session

Parameters:

object - a transient instance to be made persistent

persist

public void persist(String entityName,
 Object object,
 PersistContext copiedAlready)

Description copied from interface: EventSource

Cascade persist an entity instance

Specified by:

persist in interface EventSource

persistOnFlush

public void persistOnFlush(String entityName,
 Object object,
 PersistContext copiedAlready)

Description copied from interface: EventSource

Cascade persist an entity instance during the flush process

Specified by:

persistOnFlush in interface EventSource

merge

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

Description copied from interface: Session

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

Specified by:

merge in interface Session

Parameters:

entityName - the entity name

object - a detached instance with state to be copied

Returns:

an updated persistent instance

merge

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

Description copied from interface: Session

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

Specified by:

merge in interface Session

Parameters:

object - a detached instance with state to be copied

loadGraph - entity graph interpreted as a load graph

Returns:

an updated persistent instance

merge

public <T> T merge(T object)

Description copied from interface: Session

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

Specified by:

merge in interface EntityManager

Specified by:

merge in interface Session

Parameters:

object - a detached instance with state to be copied

Returns:

an updated persistent instance

merge

public void merge(String entityName,
 Object object,
 MergeContext copiedAlready)

Description copied from interface: EventSource

Cascade merge an entity instance

Specified by:

merge in interface EventSource

delete

public void delete(String entityName,
 Object object,
 boolean isCascadeDeleteEnabled,
 DeleteContext transientEntities)

Description copied from interface: EventSource

Cascade delete an entity instance

Specified by:

delete in interface EventSource

removeOrphanBeforeUpdates

public void removeOrphanBeforeUpdates(String entityName,
 Object child)

Description copied from interface: EventSource

A specialized type of deletion for orphan removal that must occur prior to queued inserts and updates.

Specified by:

removeOrphanBeforeUpdates in interface EventSource

load

public void load(Object object,
 Object id)

Description copied from interface: Session

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

Specified by:

load in interface Session

Parameters:

object - a transient instance of an entity class

id - an identifier

findMultiple

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

Description copied from interface: Session

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

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

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

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

For more advanced cases, use Session.byMultipleIds(Class), which returns an instance of MultiIdentifierLoadAccess.

Specified by:

findMultiple in interface Session

Parameters:

entityType - the entity type

ids - the list of identifiers

options - options, if any

Returns:

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

See Also:

• Session.byMultipleIds(Class)

findMultiple

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

Description copied from interface: Session

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

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

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

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

For more advanced cases, use Session.byMultipleIds(Class), which returns an instance of MultiIdentifierLoadAccess.

Specified by:

findMultiple in interface Session

Parameters:

entityGraph - the entity graph interpreted as a load graph

ids - the list of identifiers

options - options, if any

Returns:

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

See Also:

• Session.byMultipleIds(Class)

get

public <T> T get(Class<T> entityClass,
 Object id)

Description copied from interface: Session

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

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

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

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

• call Session.get(Class, Object, LockMode) with the explicit lock mode LockMode.READ, or
• set the cache mode to CacheMode.IGNORE before calling this method.

Specified by:

get in interface Session

Parameters:

entityClass - the entity type

id - an identifier

Returns:

a persistent instance or null

get

public Object get(String entityName,
 Object id)

Description copied from interface: Session

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

Specified by:

get in interface Session

Parameters:

entityName - the entity name

id - an identifier

Returns:

a persistent instance or null

See Also:

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

immediateLoad

public Object immediateLoad(String entityName,
 Object id)

Load the data for the object with the specified id into a newly created object. This is only called when lazily initializing a proxy. Do NOT return a proxy.

Specified by:

immediateLoad in interface SharedSessionContractImplementor

internalLoad

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

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

internalLoadType

protected static LoadEventListener.LoadType internalLoadType(boolean eager,
 boolean nullable)

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.

makePostLoadEvent

protected PostLoadEvent makePostLoadEvent(EntityPersister persister,
 Object id,
 Object entity)

Helper to avoid creating many new instances of PostLoadEvent. It's an allocation hot spot.

makeLoadEvent

protected LoadEvent makeLoadEvent(String entityName,
 Object id,
 Boolean readOnly,
 LockOptions lockOptions)

Helper to avoid creating many new instances of LoadEvent. It's an allocation hot spot.

makeLoadEvent

protected LoadEvent makeLoadEvent(String entityName,
 Object id,
 Boolean readOnly,
 boolean isAssociationFetch)

Helper to avoid creating many new instances of LoadEvent. It's an allocation hot spot.

releasePostLoadEvent

protected void releasePostLoadEvent(PostLoadEvent event)

releaseLoadEvent

protected void releaseLoadEvent(LoadEvent event)

get

@Deprecated
public <T> T get(Class<T> entityClass,
 Object id,
 LockMode lockMode)

Deprecated.

Description copied from interface: Session

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

Specified by:

get in interface Session

Parameters:

entityClass - the entity type

id - an identifier

lockMode - the lock mode

Returns:

a persistent instance or null

get

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

Deprecated.

Description copied from interface: Session

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

Specified by:

get in interface Session

Parameters:

entityName - the entity name

id - an identifier

lockMode - the lock mode

Returns:

a persistent instance or null

See Also:

• Session.get(String, Object, LockOptions)

get

@Deprecated
public <T> T get(Class<T> entityClass,
 Object id,
 LockOptions lockOptions)

Deprecated.

Description copied from interface: Session

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

Specified by:

get in interface Session

Parameters:

entityClass - the entity type

id - an identifier

lockOptions - the lock mode

Returns:

a persistent instance or null

get

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

Deprecated.

Description copied from interface: Session

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

Specified by:

get in interface Session

Parameters:

entityName - the entity name

id - an identifier

lockOptions - contains the lock mode

Returns:

a persistent instance or null

byId

public <T> IdentifierLoadAccessImpl<T> byId(String entityName)

Description copied from interface: Session

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

Specified by:

byId in interface Session

Parameters:

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

Returns:

an instance of IdentifierLoadAccess for executing the lookup

byId

public <T> IdentifierLoadAccessImpl<T> byId(Class<T> entityClass)

Description copied from interface: Session

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

Specified by:

byId in interface Session

Parameters:

entityClass - the entity type to be retrieved

Returns:

an instance of IdentifierLoadAccess for executing the lookup

byMultipleIds

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

Description copied from interface: Session

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

Specified by:

byMultipleIds in interface Session

Parameters:

entityClass - the entity type to be retrieved

Returns:

an instance of MultiIdentifierLoadAccess for executing the lookup

See Also:

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

byMultipleIds

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

Description copied from interface: Session

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

Specified by:

byMultipleIds in interface Session

Parameters:

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

Returns:

an instance of MultiIdentifierLoadAccess for executing the lookup

byNaturalId

public <T> NaturalIdLoadAccess<T> byNaturalId(String entityName)

Description copied from interface: Session

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

Specified by:

byNaturalId in interface Session

Parameters:

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

Returns:

an instance of NaturalIdLoadAccess for executing the lookup

byNaturalId

public <T> NaturalIdLoadAccess<T> byNaturalId(Class<T> entityClass)

Description copied from interface: Session

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

Specified by:

byNaturalId in interface Session

Parameters:

entityClass - the entity type to be retrieved

Returns:

an instance of NaturalIdLoadAccess for executing the lookup

bySimpleNaturalId

public <T> SimpleNaturalIdLoadAccess<T> bySimpleNaturalId(String entityName)

Description copied from interface: Session

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

Specified by:

bySimpleNaturalId in interface Session

Parameters:

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

Returns:

an instance of SimpleNaturalIdLoadAccess for executing the lookup

bySimpleNaturalId

public <T> SimpleNaturalIdLoadAccess<T> bySimpleNaturalId(Class<T> entityClass)

Description copied from interface: Session

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

Specified by:

bySimpleNaturalId in interface Session

Parameters:

entityClass - the entity type to be retrieved

Returns:

an instance of SimpleNaturalIdLoadAccess for executing the lookup

byMultipleNaturalId

public <T> NaturalIdMultiLoadAccess<T> byMultipleNaturalId(Class<T> entityClass)

Description copied from interface: Session

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

Specified by:

byMultipleNaturalId in interface Session

Parameters:

entityClass - the entity type to be retrieved

Returns:

an instance of NaturalIdMultiLoadAccess for executing the lookup

byMultipleNaturalId

public <T> NaturalIdMultiLoadAccess<T> byMultipleNaturalId(String entityName)

Description copied from interface: Session

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

Specified by:

byMultipleNaturalId in interface Session

Parameters:

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

Returns:

an instance of NaturalIdMultiLoadAccess for executing the lookup

load

public Object load(LoadEventListener.LoadType loadType,
 Object id,
 String entityName,
 LockOptions lockOptions,
 Boolean readOnly)

Description copied from interface: LoadAccessContext

Efficiently fire a LoadEvent with the given type and return the resulting entity instance or proxy.

Specified by:

load in interface LoadAccessContext

refresh

public void refresh(Object object)

Description copied from interface: Session

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

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

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

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

Specified by:

refresh in interface EntityManager

Specified by:

refresh in interface Session

Parameters:

object - a persistent instance associated with this session

refresh

public void refresh(Object object,
 LockOptions lockOptions)

Description copied from interface: Session

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

Specified by:

refresh in interface Session

Parameters:

object - a persistent instance associated with this session

lockOptions - contains the lock mode to use

refresh

public void refresh(String entityName,
 Object object,
 RefreshContext refreshedAlready)

Description copied from interface: EventSource

Cascade refresh an entity instance

Specified by:

refresh in interface EventSource

replicate

public void replicate(Object obj,
 ReplicationMode replicationMode)

Description copied from interface: Session

Persist the state of the given detached instance, reusing the current identifier value. This operation cascades to associated instances if the association is mapped with CascadeType.REPLICATE.

Specified by:

replicate in interface Session

Parameters:

obj - a detached instance of a persistent class

replicationMode - the replication mode to use

replicate

public void replicate(String entityName,
 Object obj,
 ReplicationMode replicationMode)

Description copied from interface: Session

Persist the state of the given detached instance, reusing the current identifier value. This operation cascades to associated instances if the association is mapped with CascadeType.REPLICATE.

Specified by:

replicate in interface Session

Parameters:

entityName - the entity name

obj - a detached instance of a persistent class

replicationMode - the replication mode to use

evict

public void evict(Object object)

remove any hard references to the entity that are held by the infrastructure (references held by application or other persistent instances are okay)

Specified by:

evict in interface Session

Parameters:

object - the managed entity to evict

autoFlushIfRequired

public boolean autoFlushIfRequired(Set<String> querySpaces)

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.

autoFlushIfRequired

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

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.

autoPreFlush

public void autoPreFlush()

Specified by:

autoPreFlush in interface SharedSessionContractImplementor

isDirty

public boolean isDirty()

Description copied from interface: Session

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

Specified by:

isDirty in interface Session

Returns:

true if the session contains pending changes; false otherwise.

flush

public void flush()

Description copied from interface: SharedSessionContractImplementor

Flush this session.

Specified by:

flush in interface EntityManager

Specified by:

flush in interface Session

Specified by:

flush in interface SharedSessionContractImplementor

setHibernateFlushMode

public void setHibernateFlushMode(FlushMode flushMode)

Description copied from interface: Session

Set the current flush mode for this session.

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

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

Note that FlushMode defines more options than FlushModeType.

Specified by:

setHibernateFlushMode in interface Session

Parameters:

flushMode - the new FlushMode

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 Session

Specified by:

getHibernateFlushMode in interface SharedSessionContractImplementor

Returns:

The flush mode

getFlushMode

public FlushModeType getFlushMode()

Description copied from interface: Session

Get the current JPA flush mode for this session.

Specified by:

getFlushMode in interface EntityManager

Specified by:

getFlushMode in interface Session

Returns:

the FlushModeType currently in effect

See Also:

• Session.getHibernateFlushMode()

setFlushMode

public void setFlushMode(FlushModeType flushModeType)

Description copied from interface: Session

Set the current JPA flush mode for this session.

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

Specified by:

setFlushMode in interface EntityManager

Specified by:

setFlushMode in interface Session

Parameters:

flushModeType - the new FlushModeType

See Also:

• Session.setHibernateFlushMode(FlushMode)

forceFlush

public void forceFlush(EntityEntry entityEntry)

Description copied from interface: SessionImplementor

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

Specified by:

forceFlush in interface EventSource

Specified by:

forceFlush in interface SessionImplementor

forceFlush

public void forceFlush(EntityKey key)

Description copied from interface: SessionImplementor

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

Specified by:

forceFlush in interface EventSource

Specified by:

forceFlush in interface SessionImplementor

instantiate

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

Deprecated.

Description copied from interface: SharedSessionContractImplementor

Instantiate the entity class, initializing with the given identifier.

Specified by:

instantiate in interface SharedSessionContractImplementor

instantiate

public Object instantiate(EntityPersister persister,
 Object id)

give the interceptor an opportunity to override the default instantiation

Specified by:

instantiate in interface EventSource

Specified by:

instantiate in interface SessionImplementor

Specified by:

instantiate in interface SharedSessionContractImplementor

getEntityPersister

public EntityPersister getEntityPersister(String entityName,
 Object object)

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

getIdentifier

public Object getIdentifier(Object object)

Description copied from interface: Session

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

Specified by:

getIdentifier in interface Session

Parameters:

object - a persistent instance associated with this session

Returns:

the identifier

getContextEntityIdentifier

public Object getContextEntityIdentifier(Object object)

Get the id value for an object that is actually associated with the session. This is a bit stricter than ForeignKeys.getEntityIdentifierIfNotUnsaved(java.lang.String, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor).

Specified by:

getContextEntityIdentifier in interface SharedSessionContractImplementor

contains

public boolean contains(Object object)

Specified by:

contains in interface EntityManager

contains

public boolean contains(String entityName,
 Object object)

Description copied from interface: Session

Determine if the given entity is associated with this session.

Specified by:

contains in interface Session

Parameters:

entityName - the entity name

object - an instance of a persistent class

Returns:

true if the given instance is associated with this Session

createStoredProcedureCall

public ProcedureCall createStoredProcedureCall(String procedureName)

Description copied from interface: SharedSessionContract

Create a ProcedureCall to a stored procedure.

Specified by:

createStoredProcedureCall in interface SharedSessionContract

Overrides:

createStoredProcedureCall in class AbstractSharedSessionContract

Parameters:

procedureName - The name of the procedure.

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

Overrides:

createStoredProcedureCall in class AbstractSharedSessionContract

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.

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

Overrides:

createStoredProcedureCall in class AbstractSharedSessionContract

Parameters:

procedureName - The name of the procedure.

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

Returns:

The representation of the procedure call.

createQuery

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

Specified by:

createQuery in interface EntityManager

Specified by:

createQuery in interface SessionImplementor

initializeCollection

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

Description copied from interface: SharedSessionContractImplementor

Initialize the given collection (if not already initialized).

Specified by:

initializeCollection 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

bestGuessEntityName

public String bestGuessEntityName(Object object,
 EntityEntry entry)

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

getEntityName

public String getEntityName(Object object)

Description copied from interface: Session

Return the entity name for the given persistent entity.

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

Specified by:

getEntityName in interface Session

Parameters:

object - a persistent entity associated with this session

Returns:

the entity name

getReference

public <T> T getReference(T object)

Description copied from interface: Session

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

Specified by:

getReference in interface EntityManager

Specified by:

getReference in interface Session

Parameters:

object - a detached persistent instance

Returns:

the persistent instance or proxy

guessEntityName

public String guessEntityName(Object object)

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

cancelQuery

public void cancelQuery()

Description copied from interface: Session

Cancel the execution of the current query.

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

Specified by:

cancelQuery in interface Session

toString

public String toString()

Overrides:

toString in class Object

getActionQueue

public ActionQueue getActionQueue()

Description copied from interface: SessionImplementor

Get the ActionQueue associated with this session.

Specified by:

getActionQueue in interface EventSource

Specified by:

getActionQueue in interface SessionImplementor

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

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

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.

getStatistics

public SessionStatistics getStatistics()

Description copied from interface: Session

Get the statistics for this session.

Specified by:

getStatistics in interface Session

Returns:

the session statistics being collected for this session

isEventSource

public boolean isEventSource()

Description copied from interface: SharedSessionContractImplementor

Determines if this session implements EventSource.

Only stateful session are sources of events. If this object is a stateless session, this method return false.

Specified by:

isEventSource in interface SharedSessionContractImplementor

asEventSource

public EventSource asEventSource()

Description copied from interface: SharedSessionContractImplementor

Cast this session to EventSource if possible.

Only stateful session are sources of events. If this object is a stateless session, this method throws.

Specified by:

asEventSource in interface SharedSessionContractImplementor

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 Session

Specified by:

isDefaultReadOnly in interface SharedSessionContractImplementor

Returns:

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

See Also:

• Session.isReadOnly(Object)

setDefaultReadOnly

public void setDefaultReadOnly(boolean defaultReadOnly)

Description copied from interface: Session

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

Read-only entities are not dirty-checked and snapshots of persistent state are not maintained. Read-only entities can be modified, but changes are not persisted.

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

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

To override this session's read-only/modifiable setting for all entities and proxies loaded by a certain Query use Query.setReadOnly(boolean).

Specified by:

setDefaultReadOnly in interface Session

Parameters:

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

See Also:

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

isReadOnly

public boolean isReadOnly(Object entityOrProxy)

Description copied from interface: Session

Is the specified entity or proxy read-only?

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

Specified by:

isReadOnly in interface Session

Parameters:

entityOrProxy - an entity or proxy

Returns:

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

See Also:

• Session.isDefaultReadOnly()

setReadOnly

public void setReadOnly(Object entity,
 boolean readOnly)

Description copied from interface: Session

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

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

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

To override this session's read-only/modifiable setting for entities and proxies loaded by a Query use Query.setReadOnly(boolean)

Specified by:

setReadOnly in interface Session

Parameters:

entity - an entity or proxy

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

See Also:

• Session.setDefaultReadOnly(boolean)
• Query.setReadOnly(boolean)
• IdentifierLoadAccess.withReadOnly(boolean)

getCacheStoreMode

public CacheStoreMode getCacheStoreMode()

Description copied from interface: Session

The JPA-defined CacheStoreMode.

Specified by:

getCacheStoreMode in interface EntityManager

Specified by:

getCacheStoreMode in interface Session

See Also:

• Session.getCacheMode()

getCacheRetrieveMode

public CacheRetrieveMode getCacheRetrieveMode()

Description copied from interface: Session

The JPA-defined CacheRetrieveMode.

Specified by:

getCacheRetrieveMode in interface EntityManager

Specified by:

getCacheRetrieveMode in interface Session

See Also:

• Session.getCacheMode()

setCacheStoreMode

public void setCacheStoreMode(CacheStoreMode cacheStoreMode)

Description copied from interface: Session

Enable or disable writes to the second-level cache.

Specified by:

setCacheStoreMode in interface EntityManager

Specified by:

setCacheStoreMode in interface Session

Parameters:

cacheStoreMode - a JPA-defined CacheStoreMode

See Also:

• Session.setCacheMode(CacheMode)

setCacheRetrieveMode

public void setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)

Description copied from interface: Session

Enable or disable reads from the second-level cache.

Specified by:

setCacheRetrieveMode in interface EntityManager

Specified by:

setCacheRetrieveMode in interface Session

Parameters:

cacheRetrieveMode - a JPA-defined CacheRetrieveMode

See Also:

• Session.setCacheMode(CacheMode)

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.

isFetchProfileEnabled

public boolean isFetchProfileEnabled(String name)
                              throws UnknownProfileException

Description copied from interface: Session

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

Specified by:

isFetchProfileEnabled in interface Session

Parameters:

name - the name of the profile

Returns:

True if fetch profile is enabled; false if not.

Throws:

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

See Also:

• FetchProfile

enableFetchProfile

public void enableFetchProfile(String name)
                        throws UnknownProfileException

Description copied from interface: Session

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

Specified by:

enableFetchProfile in interface Session

Parameters:

name - the name of the fetch profile to be enabled

Throws:

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

See Also:

• FetchProfile

disableFetchProfile

public void disableFetchProfile(String name)
                         throws UnknownProfileException

Description copied from interface: Session

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

Specified by:

disableFetchProfile in interface Session

Parameters:

name - the name of the fetch profile to be disabled

Throws:

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

See Also:

• FetchProfile

setSubselectFetchingEnabled

public void setSubselectFetchingEnabled(boolean enabled)

Description copied from interface: Session

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

Specified by:

setSubselectFetchingEnabled in interface Session

Parameters:

enabled - true to enable subselect fetching

See Also:

• FetchSettings.USE_SUBSELECT_FETCH

isSubselectFetchingEnabled

public boolean isSubselectFetchingEnabled()

Description copied from interface: Session

Determine if subselect fetching is enabled in this session.

Specified by:

isSubselectFetchingEnabled in interface Session

Returns:

true is subselect fetching is enabled

setFetchBatchSize

public void setFetchBatchSize(int batchSize)

Description copied from interface: Session

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

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

Specified by:

setFetchBatchSize in interface Session

Parameters:

batchSize - the maximum batch size for batch fetching

See Also:

• FetchSettings.DEFAULT_BATCH_FETCH_SIZE

getFetchBatchSize

public int getFetchBatchSize()

Description copied from interface: Session

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

Specified by:

getFetchBatchSize in interface Session

getLobHelper

public LobHelper getLobHelper()

Description copied from interface: Session

Obtain a LobHelper for instances of Blob and Clob.

Specified by:

getLobHelper in interface Session

Returns:

an instance of LobHelper

beforeTransactionCompletion

public void beforeTransactionCompletion()

Description copied from interface: JdbcSessionOwner

A before-completion callback to the owner.

Specified by:

beforeTransactionCompletion in interface JdbcSessionOwner

Overrides:

beforeTransactionCompletion in class AbstractSharedSessionContract

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

Overrides:

afterTransactionCompletion in class AbstractSharedSessionContract

Parameters:

successful - Was the transaction successful?

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

addSharedSessionTransactionObserver

protected void addSharedSessionTransactionObserver(TransactionCoordinator transactionCoordinator)

Overrides:

addSharedSessionTransactionObserver in class AbstractSharedSessionContract

removeSharedSessionTransactionObserver

protected void removeSharedSessionTransactionObserver(TransactionCoordinator transactionCoordinator)

Overrides:

removeSharedSessionTransactionObserver in class AbstractSharedSessionContract

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

Overrides:

startTransactionBoundary in class AbstractSharedSessionContract

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

flushBeforeTransactionCompletion

public void flushBeforeTransactionCompletion()

Specified by:

flushBeforeTransactionCompletion in interface JdbcSessionOwner

getSession

public SessionImplementor getSession()

Description copied from interface: SharedSessionContractImplementor

Returns this object, fulfilling the contract of WrapperOptions.

Specified by:

getSession in interface LoadAccessContext

Specified by:

getSession in interface SessionImplementor

Specified by:

getSession in interface SharedSessionContractImplementor

Specified by:

getSession in interface WrapperOptions

remove

public void remove(Object entity)

Description copied from interface: Session

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

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

Specified by:

remove in interface EntityManager

Specified by:

remove in interface Session

Parameters:

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

find

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

Description copied from interface: Session

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

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

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

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

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

Specified by:

find in interface EntityManager

Specified by:

find in interface Session

Parameters:

entityClass - the entity type

primaryKey - an identifier

Returns:

a fully-fetched persistent instance or null

find

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

Specified by:

find in interface EntityManager

find

public <T> T find(Class<T> entityClass,
 Object primaryKey,
 LockModeType lockModeType)

Specified by:

find in interface EntityManager

find

public <T> T find(Class<T> entityClass,
 Object primaryKey,
 LockModeType lockModeType,
 Map<String,Object> properties)

Specified by:

find in interface EntityManager

logIgnoringEntityNotFound

protected static <T> void logIgnoringEntityNotFound(Class<T> entityClass,
 Object primaryKey)

find

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

Specified by:

find in interface EntityManager

find

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

Specified by:

find in interface EntityManager

checkTransactionNeededForLock

protected void checkTransactionNeededForLock(LockMode lockMode)

readOnlyHint

protected static Boolean readOnlyHint(Map<String,Object> properties)

determineAppropriateLocalCacheMode

protected CacheMode determineAppropriateLocalCacheMode(Map<String,Object> localProperties)

find

public Object find(String entityName,
 Object primaryKey)

Description copied from interface: Session

Return the persistent instance of the named entity type with the given identifier, or null if there is no such persistent instance.

Differs from Session.find(Class, Object) in that this form accepts the entity name of a dynamic entity.

Specified by:

find in interface Session

See Also:

• Session.find(Class, Object)

find

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

Description copied from interface: Session

Return the persistent instance of the named entity type with the given identifier using the specified options, or null if there is no such persistent instance.

Differs from EntityManager.find(Class, Object, FindOption...) in that this form accepts the entity name of a dynamic entity.

Specified by:

find in interface Session

See Also:

• EntityManager.find(Class, Object, FindOption...)

getReference

public <T> T getReference(Class<T> entityClass,
 Object id)

Description copied from interface: Session

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

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

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

Specified by:

getReference in interface EntityManager

Specified by:

getReference in interface Session

Parameters:

entityClass - the entity type

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

Returns:

the persistent instance or proxy

getReference

public Object getReference(String entityName,
 Object id)

Description copied from interface: Session

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

Specified by:

getReference in interface Session

Parameters:

entityName - the entity name

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

Returns:

the persistent instance or proxy

lock

public void lock(Object entity,
 LockModeType lockModeType)

Specified by:

lock in interface EntityManager

lock

public void lock(Object entity,
 LockModeType lockModeType,
 Map<String,Object> properties)

Specified by:

lock in interface EntityManager

lock

public void lock(Object entity,
 LockModeType lockModeType,
 LockOption... options)

Specified by:

lock in interface EntityManager

refresh

public void refresh(Object entity,
 LockModeType lockModeType)

Specified by:

refresh in interface EntityManager

refresh

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

Specified by:

refresh in interface EntityManager

refresh

public void refresh(Object entity,
 LockModeType lockModeType,
 Map<String,Object> properties)

Specified by:

refresh in interface EntityManager

refresh

public void refresh(Object entity,
 RefreshOption... options)

Specified by:

refresh in interface EntityManager

detach

public void detach(Object entity)

Description copied from interface: Session

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

Specified by:

detach in interface EntityManager

Specified by:

detach in interface Session

Parameters:

entity - the managed instance to detach

getLockMode

public LockModeType getLockMode(Object entity)

Specified by:

getLockMode in interface EntityManager

setProperty

public void setProperty(String propertyName,
 Object value)

Description copied from interface: Session

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

Specified by:

setProperty in interface EntityManager

Specified by:

setProperty in interface Session

See Also:

• HibernateHints
• SpecHints

getProperties

public Map<String,Object> getProperties()

Specified by:

getProperties in interface EntityManager

createNamedStoredProcedureQuery

public ProcedureCall createNamedStoredProcedureQuery(String name)

Description copied from interface: SharedSessionContract

Obtain a ProcedureCall based on a named template

Specified by:

createNamedStoredProcedureQuery in interface EntityManager

Specified by:

createNamedStoredProcedureQuery in interface SharedSessionContract

Overrides:

createNamedStoredProcedureQuery in class AbstractSharedSessionContract

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 EntityManager

Specified by:

createStoredProcedureQuery in interface SharedSessionContract

Overrides:

createStoredProcedureQuery in class AbstractSharedSessionContract

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 EntityManager

Specified by:

createStoredProcedureQuery in interface SharedSessionContract

Overrides:

createStoredProcedureQuery in class AbstractSharedSessionContract

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 EntityManager

Specified by:

createStoredProcedureQuery in interface SharedSessionContract

Overrides:

createStoredProcedureQuery in class AbstractSharedSessionContract

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.

unwrap

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

Description copied from interface: SharedSessionContract

Return an object of the specified type to allow access to a provider-specific API.

Specified by:

unwrap in interface EntityManager

Specified by:

unwrap in interface Session

Specified by:

unwrap in interface SharedSessionContract

Parameters:

type - the class of the object to be returned. This is usually either the underlying class implementing SharedSessionContract or an interface it implements.

Returns:

an instance of the specified class

getDelegate

public Object getDelegate()

Specified by:

getDelegate in interface EntityManager

getEntityManagerFactory

public SessionFactoryImplementor getEntityManagerFactory()

Specified by:

getEntityManagerFactory in interface EntityManager

getMetamodel

public Metamodel getMetamodel()

Specified by:

getMetamodel in interface EntityManager

getManagedEntities

public Collection<?> getManagedEntities()

Description copied from interface: Session

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

Specified by:

getManagedEntities in interface Session

getManagedEntities

public Collection<?> getManagedEntities(String entityName)

Description copied from interface: Session

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

Specified by:

getManagedEntities in interface Session

getManagedEntities

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

Description copied from interface: Session

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

Specified by:

getManagedEntities in interface Session

getManagedEntities

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

Description copied from interface: Session

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

Specified by:

getManagedEntities in interface Session

getReadOnlyFromLoadQueryInfluencers

protected Boolean getReadOnlyFromLoadQueryInfluencers()