org.hibernate.engine.spi

Interface SessionImplementor

All Superinterfaces:

AutoCloseable, Closeable, EntityManager, HibernateEntityManager, HibernateEntityManagerFactoryAware, HibernateEntityManagerImplementor, JdbcSessionOwner, LobCreationContext, QueryProducer, QueryProducerImplementor, Serializable, Session, SharedSessionContract, SharedSessionContractImplementor, TransactionCoordinatorBuilder.Options, WrapperOptions

All Known Subinterfaces:

EventSource

All Known Implementing Classes:

AbstractDelegateSessionImplementor, AbstractSessionImpl, SessionDelegatorBaseImpl, SessionImpl, ToOneDelegateSessionImplementor

public interface SessionImplementor
extends Session, SharedSessionContractImplementor, HibernateEntityManagerImplementor

Defines the "internal contract" for Session and other parts of Hibernate such as Type, EntityPersister and CollectionPersister implementations. A Session, through this interface and SharedSessionContractImplementor, implements:

• JdbcSessionOwner to drive the behavior of the JdbcSessionContext delegate
• TransactionCoordinatorBuilder.Options to drive the creation of the TransactionCoordinator delegate
• LobCreationContext to act as the context for JDBC LOB instance creation
• WrapperOptions to fulfill the behavior needed while binding/extracting values to/from JDBC as part of the Type contracts

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

Author:

Gavin King, Steve Ebersole

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.Session

Session.LockRequest

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

LobCreationContext.Callback<T>

Nested classes/interfaces inherited from interface org.hibernate.jpa.spi.HibernateEntityManagerImplementor

HibernateEntityManagerImplementor.QueryOptions

Method Summary

Modifier and Type	Method and Description
QueryImplementor	createNamedQuery(String name) The JPA-defined named query creation method.
<T> QueryImplementor<T>	createNamedQuery(String name, Class<T> resultType) The JPA-defined named, typed query creation method.
NativeQueryImplementor	createNativeQuery(String sqlString) Create a NativeQuery instance for the given native (SQL) query
NativeQueryImplementor	createNativeQuery(String sqlString, Class resultClass) Create a NativeQuery instance for the given native (SQL) query using implicit mapping to the specified Java type.
NativeQueryImplementor	createNativeQuery(String sqlString, String resultSetMapping) Create a NativeQuery instance for the given native (SQL) query using implicit mapping to the specified Java type.
QueryImplementor	createQuery(CriteriaDelete deleteQuery) Create an instance of Query for executing a criteria delete query.
<T> QueryImplementor<T>	createQuery(CriteriaQuery<T> criteriaQuery) Create an instance of TypedQuery for executing a criteria query.
QueryImplementor	createQuery(CriteriaUpdate updateQuery) Create an instance of Query for executing a criteria update query.
QueryImplementor	createQuery(String queryString) Create a Query instance for the given HQL/JPQL query string.
<T> QueryImplementor<T>	createQuery(String queryString, Class<T> resultType) Create a typed Query instance for the given HQL/JPQL query string.
<T> QueryImplementor<T>	createQuery(String jpaqlString, Class<T> resultClass, Selection selection, HibernateEntityManagerImplementor.QueryOptions queryOptions) Deprecated. (since 5.2) - see deprecation note on super
NativeQueryImplementor	createSQLQuery(String sqlString) Create a NativeQuery instance for the given SQL query string.
void	delete(String entityName, Object child, boolean isCascadeDeleteEnabled, Set transientEntities) Deprecated. OperationalContext should cover this overload I believe; Gail?
void	forceFlush(EntityEntry e)
ActionQueue	getActionQueue()
NativeQueryImplementor	getNamedNativeQuery(String name) Get a NativeQuery instance for a named native SQL query
QueryImplementor	getNamedQuery(String queryName) Create a Query instance for the named query.
NativeQueryImplementor	getNamedSQLQuery(String name) Get a NativeQuery instance for a named native SQL query
SessionFactoryImplementor	getSessionFactory() Get the session factory which created this session.
Object	instantiate(EntityPersister persister, Serializable id)
boolean	isFlushBeforeCompletionEnabled() Deprecated. (since 5.2) use Session.getHibernateFlushMode() instead.
void	merge(String entityName, Object object, Map copiedAlready) Deprecated. OperationalContext should cover this overload I believe; Gail?
void	persist(String entityName, Object object, Map createdAlready) Deprecated. OperationalContext should cover this overload I believe; Gail?
void	persistOnFlush(String entityName, Object object, Map copiedAlready) Deprecated. OperationalContext should cover this overload I believe; Gail?
void	refresh(String entityName, Object object, Map refreshedAlready) Deprecated. OperationalContext should cover this overload I believe; Gail?
void	removeOrphanBeforeUpdates(String entityName, Object child) Deprecated. OperationalContext should cover this overload I believe; Gail?

Methods inherited from interface org.hibernate.Session

addEventListeners, buildLockRequest, byId, byId, byMultipleIds, byMultipleIds, byNaturalId, byNaturalId, bySimpleNaturalId, bySimpleNaturalId, cancelQuery, clear, contains, createFilter, delete, delete, disableFetchProfile, disableFilter, disconnect, doReturningWork, doWork, enableFetchProfile, enableFilter, evict, flush, get, get, get, get, get, get, getCacheMode, getCurrentLockMode, getEnabledFilter, getEntityName, getFlushMode, getHibernateFlushMode, getIdentifier, getLobHelper, getStatistics, getTypeHelper, isDefaultReadOnly, isDirty, isFetchProfileEnabled, isReadOnly, load, load, load, load, load, load, load, lock, lock, merge, merge, persist, persist, reconnect, refresh, refresh, refresh, refresh, refresh, replicate, replicate, save, save, saveOrUpdate, saveOrUpdate, sessionWithOptions, setCacheMode, setDefaultReadOnly, setFlushMode, setHibernateFlushMode, setReadOnly, update, update

Methods inherited from interface java.io.Closeable

close

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

accessTransaction, afterScrollOperation, bestGuessEntityName, checkOpen, checkOpen, connection, executeNativeUpdate, executeUpdate, flush, generateEntityKey, getCacheMode, getCacheTransactionSynchronization, getConfiguredJdbcBatchSize, getContextEntityIdentifier, getDontFlushFromFind, getEntityPersister, getEntityUsingInterceptor, getEventListenerManager, getExceptionConverter, getFactory, getFlushMode, getHibernateFlushMode, getInterceptor, getJdbcCoordinator, getJdbcServices, getLoadQueryInfluencers, getPersistenceContext, getSessionIdentifier, getTenantIdentifier, getTimestamp, getTransactionStartTimestamp, guessEntityName, immediateLoad, initializeCollection, instantiate, internalLoad, isAutoCloseSessionEnabled, isClosed, isEventSource, isOpenOrWaitingForAutoClose, isQueryParametersValidationEnabled, isTransactionInProgress, iterate, iterateFilter, list, list, list, listCustomQuery, listFilter, markForRollbackOnly, scroll, scroll, scroll, scrollCustomQuery, setAutoClear, setCacheMode, setFlushMode, setHibernateFlushMode, shouldAutoClose

Methods inherited from interface org.hibernate.SharedSessionContract

beginTransaction, close, createCriteria, createCriteria, createCriteria, createCriteria, createStoredProcedureCall, createStoredProcedureCall, createStoredProcedureCall, getJdbcBatchSize, getNamedProcedureCall, getTransaction, isConnected, isOpen, setJdbcBatchSize

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

afterTransactionBegin, afterTransactionCompletion, beforeTransactionCompletion, flushBeforeTransactionCompletion, getJdbcBatchSize, getJdbcConnectionAccess, getJdbcSessionContext, getTransactionCoordinator, startTransactionBoundary

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

shouldAutoJoinTransaction

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

execute

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

getJdbcTimeZone, getLobCreator, remapSqlTypeDescriptor, useStreamForLobBinding

Methods inherited from interface org.hibernate.jpa.spi.HibernateEntityManagerImplementor

buildLockOptions, checkOpen, getLockRequest, getSession, isTransactionInProgress, markForRollbackOnly

Methods inherited from interface javax.persistence.EntityManager

close, contains, createEntityGraph, createEntityGraph, createNamedStoredProcedureQuery, createStoredProcedureQuery, createStoredProcedureQuery, createStoredProcedureQuery, detach, find, find, find, find, getCriteriaBuilder, getDelegate, getEntityGraph, getEntityGraphs, getEntityManagerFactory, getLockMode, getMetamodel, getProperties, getReference, getTransaction, isJoinedToTransaction, isOpen, joinTransaction, lock, lock, refresh, refresh, refresh, remove, setFlushMode, setProperty, unwrap

Methods inherited from interface org.hibernate.jpa.spi.HibernateEntityManagerFactoryAware

getFactory

Method Detail

getSessionFactory

SessionFactoryImplementor getSessionFactory()

Description copied from interface: Session

Get the session factory which created this session.

Specified by:

getSessionFactory in interface Session

Returns:

The session factory.

See Also:

SessionFactory

isFlushBeforeCompletionEnabled

@Deprecated
boolean isFlushBeforeCompletionEnabled()

Deprecated. (since 5.2) use Session.getHibernateFlushMode() instead.

getActionQueue

ActionQueue getActionQueue()

instantiate

Object instantiate(EntityPersister persister,
                   Serializable id)
            throws HibernateException

Throws:

HibernateException

forceFlush

void forceFlush(EntityEntry e)
         throws HibernateException

Throws:

HibernateException

createQuery

QueryImplementor createQuery(String queryString)

Description copied from interface: QueryProducer

Create a Query instance for the given HQL/JPQL query string.

Specified by:

createQuery in interface EntityManager

Specified by:

createQuery in interface QueryProducer

Specified by:

createQuery in interface QueryProducerImplementor

Specified by:

createQuery in interface Session

Parameters:

queryString - The HQL/JPQL query

Returns:

The Query instance for manipulation and execution

See Also:

EntityManager.createQuery(String)

createQuery

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

Description copied from interface: QueryProducer

Create a typed Query instance for the given HQL/JPQL query string.

Specified by:

createQuery in interface EntityManager

Specified by:

createQuery in interface QueryProducer

Specified by:

createQuery in interface QueryProducerImplementor

Specified by:

createQuery in interface Session

Parameters:

queryString - The HQL/JPQL query

resultType - the type of the query result

Returns:

The Query instance for manipulation and execution

See Also:

EntityManager.createQuery(String,Class)

createNamedQuery

<T> QueryImplementor<T> createNamedQuery(String name,
                                         Class<T> resultType)

Description copied from interface: QueryProducer

The JPA-defined named, typed query creation method. This form can only represent an HQL/JPQL query (not a native query).

Specified by:

createNamedQuery in interface EntityManager

Specified by:

createNamedQuery in interface QueryProducer

Specified by:

createNamedQuery in interface QueryProducerImplementor

Specified by:

createNamedQuery in interface Session

Parameters:

name - the name of a query defined in metadata

resultType - the type of the query result

Returns:

The Query instance for manipulation and execution

See Also:

EntityManager.createNamedQuery(String,Class)

createNamedQuery

QueryImplementor createNamedQuery(String name)

Description copied from interface: QueryProducer

The JPA-defined named query creation method. This form can represent an HQL/JPQL query or a native query.

Specified by:

createNamedQuery in interface EntityManager

Specified by:

createNamedQuery in interface QueryProducer

Specified by:

createNamedQuery in interface QueryProducerImplementor

Parameters:

name - the name of a pre-defined, named query

Returns:

The Query instance for manipulation and execution

See Also:

EntityManager.createNamedQuery(String)

createNativeQuery

NativeQueryImplementor createNativeQuery(String sqlString)

Description copied from interface: QueryProducer

Create a NativeQuery instance for the given native (SQL) query

Specified by:

createNativeQuery in interface EntityManager

Specified by:

createNativeQuery in interface QueryProducer

Specified by:

createNativeQuery in interface QueryProducerImplementor

Parameters:

sqlString - a native SQL query string

Returns:

The NativeQuery instance for manipulation and execution

See Also:

EntityManager.createNativeQuery(String)

createNativeQuery

NativeQueryImplementor createNativeQuery(String sqlString,
                                         Class resultClass)

Description copied from interface: QueryProducer

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

Specified by:

createNativeQuery in interface EntityManager

Specified by:

createNativeQuery in interface QueryProducer

Specified by:

createNativeQuery in interface QueryProducerImplementor

Parameters:

sqlString - Native (SQL) query string

resultClass - The Java type to map results to

Returns:

The NativeQuery instance for manipulation and execution

See Also:

EntityManager.createNativeQuery(String,Class)

createNativeQuery

NativeQueryImplementor createNativeQuery(String sqlString,
                                         String resultSetMapping)

Description copied from interface: QueryProducer

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

Specified by:

createNativeQuery in interface EntityManager

Specified by:

createNativeQuery in interface QueryProducer

Specified by:

createNativeQuery in interface QueryProducerImplementor

Parameters:

sqlString - Native (SQL) query string

resultSetMapping - The explicit (named) result mapping

Returns:

The NativeQuery instance for manipulation and execution

See Also:

EntityManager.createNativeQuery(String,Class), SqlResultSetMapping

createSQLQuery

NativeQueryImplementor createSQLQuery(String sqlString)

Description copied from interface: QueryProducer

Create a NativeQuery instance for the given SQL query string.

Specified by:

createSQLQuery in interface QueryProducer

Specified by:

createSQLQuery in interface QueryProducerImplementor

Specified by:

createSQLQuery in interface Session

Parameters:

sqlString - The SQL query

Returns:

The query instance for manipulation and execution

getNamedNativeQuery

NativeQueryImplementor getNamedNativeQuery(String name)

Description copied from interface: QueryProducer

Get a NativeQuery instance for a named native SQL query

Specified by:

getNamedNativeQuery in interface QueryProducer

Specified by:

getNamedNativeQuery in interface QueryProducerImplementor

Parameters:

name - The name of the pre-defined query

Returns:

The NativeQuery instance for manipulation and execution

getNamedQuery

QueryImplementor getNamedQuery(String queryName)

Description copied from interface: QueryProducer

Create a Query instance for the named query.

Specified by:

getNamedQuery in interface QueryProducer

Specified by:

getNamedQuery in interface QueryProducerImplementor

Specified by:

getNamedQuery in interface Session

Parameters:

queryName - the name of a pre-defined, named query

Returns:

The Query instance for manipulation and execution

getNamedSQLQuery

NativeQueryImplementor getNamedSQLQuery(String name)

Description copied from interface: QueryProducer

Get a NativeQuery instance for a named native SQL query

Specified by:

getNamedSQLQuery in interface QueryProducer

Specified by:

getNamedSQLQuery in interface QueryProducerImplementor

Parameters:

name - The name of the pre-defined query

Returns:

The NativeQuery instance for manipulation and execution

createQuery

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

Description copied from interface: EntityManager

Create an instance of TypedQuery for executing a criteria query.

Specified by:

createQuery in interface EntityManager

Specified by:

createQuery in interface Session

Parameters:

criteriaQuery - a criteria query object

Returns:

the new query instance

createQuery

QueryImplementor createQuery(CriteriaUpdate updateQuery)

Description copied from interface: EntityManager

Create an instance of Query for executing a criteria update query.

Specified by:

createQuery in interface EntityManager

Specified by:

createQuery in interface Session

Parameters:

updateQuery - a criteria update query object

Returns:

the new query instance

createQuery

QueryImplementor createQuery(CriteriaDelete deleteQuery)

Description copied from interface: EntityManager

Create an instance of Query for executing a criteria delete query.

Specified by:

createQuery in interface EntityManager

Specified by:

createQuery in interface Session

Parameters:

deleteQuery - a criteria delete query object

Returns:

the new query instance

createQuery

@Deprecated
<T> QueryImplementor<T> createQuery(String jpaqlString,
                                                Class<T> resultClass,
                                                Selection selection,
                                                HibernateEntityManagerImplementor.QueryOptions queryOptions)

Deprecated. (since 5.2) - see deprecation note on super

Used during "compiling" a JPA criteria query.

Specified by:

createQuery in interface HibernateEntityManagerImplementor

Type Parameters:

T - The query type

Parameters:

jpaqlString - The criteria query rendered as a JPA QL string

resultClass - The result type (the type expected in the result list)

selection - The selection(s)

queryOptions - The options to use to build the query.

Returns:

The typed query

merge

@Deprecated
void merge(String entityName,
                       Object object,
                       Map copiedAlready)
                throws HibernateException

Deprecated. OperationalContext should cover this overload I believe; Gail?

Throws:

HibernateException

persist

@Deprecated
void persist(String entityName,
                         Object object,
                         Map createdAlready)
                  throws HibernateException

Deprecated. OperationalContext should cover this overload I believe; Gail?

Throws:

HibernateException

persistOnFlush

@Deprecated
void persistOnFlush(String entityName,
                                Object object,
                                Map copiedAlready)

Deprecated. OperationalContext should cover this overload I believe; Gail?

refresh

@Deprecated
void refresh(String entityName,
                         Object object,
                         Map refreshedAlready)
                  throws HibernateException

Deprecated. OperationalContext should cover this overload I believe; Gail?

Throws:

HibernateException

delete

@Deprecated
void delete(String entityName,
                        Object child,
                        boolean isCascadeDeleteEnabled,
                        Set transientEntities)

Deprecated. OperationalContext should cover this overload I believe; Gail?

removeOrphanBeforeUpdates

@Deprecated
void removeOrphanBeforeUpdates(String entityName,
                                           Object child)

Deprecated. OperationalContext should cover this overload I believe; Gail?