org.hibernate.internal

Class AbstractSessionImpl

java.lang.Object

org.hibernate.internal.AbstractSessionImpl

All Implemented Interfaces:

Serializable, LobCreationContext, SessionImplementor, JdbcSessionOwner, TransactionCoordinatorBuilder.TransactionCoordinatorOptions, SharedSessionContract, WrapperOptionsContext

Direct Known Subclasses:

SessionImpl, StatelessSessionImpl

public abstract class AbstractSessionImpl
extends Object
implements Serializable, SharedSessionContract, SessionImplementor, JdbcSessionOwner, TransactionCoordinatorBuilder.TransactionCoordinatorOptions

Functionality common to stateless and stateful sessions

Author:

Gavin King

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractSessionImpl.JdbcObserverImpl
class	AbstractSessionImpl.JdbcSessionContextImpl

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

LobCreationContext.Callback<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected Transaction	currentHibernateTransaction
protected SessionFactoryImpl	factory
protected WrapperOptionsImpl	wrapperOptions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSessionImpl(SessionFactoryImpl factory, String tenantIdentifier)

Method Summary

Modifier and Type	Method and Description
Query	createQuery(NamedQueryDefinition namedQueryDefinition) Used from EntityManager
Query	createQuery(String queryString) Create a Query instance for the given HQL query string.
SQLQuery	createSQLQuery(NamedSQLQueryDefinition namedQueryDefinition) Used from EntityManager
SQLQuery	createSQLQuery(String sql) Create a SQLQuery instance for the given SQL query string.
ProcedureCall	createStoredProcedureCall(String procedureName) Creates a call to a stored procedure.
ProcedureCall	createStoredProcedureCall(String procedureName, Class... resultClasses) Creates a call to a stored procedure with specific result set entity mappings.
ProcedureCall	createStoredProcedureCall(String procedureName, String... resultSetMappings) Creates a call to a stored procedure with specific result set entity mappings.
protected void	errorIfClosed()
<T> T	execute(LobCreationContext.Callback<T> callback) Execute the given callback, making sure it has access to a viable JDBC Connection.
EntityKey	generateEntityKey(Serializable id, EntityPersister persister) Hide the changing requirements of entity key creation
SessionFactoryImplementor	getFactory() Get the creating SessionFactoryImplementor
protected HQLQueryPlan	getHQLQueryPlan(String query, boolean shallow)
JdbcConnectionAccess	getJdbcConnectionAccess() Provides access to JDBC connections
ProcedureCall	getNamedProcedureCall(String name) Gets a ProcedureCall based on a named template
Query	getNamedQuery(String queryName) Create a Query instance for the named query string defined in the metadata.
Query	getNamedSQLQuery(String queryName) Get a Query instance for a named native SQL query
protected NativeSQLQueryPlan	getNativeSQLQueryPlan(NativeSQLQuerySpecification spec)
UUID	getSessionIdentifier()
String	getTenantIdentifier() Obtain the tenant identifier associated with this session.
Transaction	getTransaction() Get the Transaction instance associated with this session.
TransactionCoordinatorBuilder	getTransactionCoordinatorBuilder() Obtain the builder for TransactionCoordinator instances
WrapperOptions	getWrapperOptions() Obtain the WrapperOptions for this context.
boolean	isClosed() Determine whether the session is closed.
List	list(NativeSQLQuerySpecification spec, QueryParameters queryParameters) Execute a native SQL query, and return the results as a fully built list.
ScrollableResults	scroll(NativeSQLQuerySpecification spec, QueryParameters queryParameters) Execute a native SQL query, and return the results as a scrollable result.
protected void	setClosed()
abstract boolean	shouldAutoJoinTransaction() Indicates whether an active transaction should be automatically joined.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.SharedSessionContract

beginTransaction, createCriteria, createCriteria, createCriteria, createCriteria

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

afterScrollOperation, bestGuessEntityName, connection, disableTransactionAutoJoin, executeNativeUpdate, executeUpdate, flush, getCacheMode, getContextEntityIdentifier, getDontFlushFromFind, getEntityPersister, getEntityUsingInterceptor, getEventListenerManager, getFlushMode, getInterceptor, getJdbcCoordinator, getLoadQueryInfluencers, getPersistenceContext, getTimestamp, getTransactionCoordinator, guessEntityName, immediateLoad, initializeCollection, instantiate, internalLoad, isAutoCloseSessionEnabled, isConnected, isEventSource, isOpen, isTransactionInProgress, iterate, iterateFilter, list, list, listCustomQuery, listFilter, scroll, scroll, scrollCustomQuery, setAutoClear, setCacheMode, setFlushMode, shouldAutoClose

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

afterTransactionBegin, afterTransactionCompletion, beforeTransactionCompletion, flushBeforeTransactionCompletion, getJdbcSessionContext

Field Detail

factory

protected transient SessionFactoryImpl factory

currentHibernateTransaction

protected transient Transaction currentHibernateTransaction

wrapperOptions

protected transient WrapperOptionsImpl wrapperOptions

Constructor Detail

AbstractSessionImpl

protected AbstractSessionImpl(SessionFactoryImpl factory,
                              String tenantIdentifier)

Method Detail

getFactory

public SessionFactoryImplementor getFactory()

Description copied from interface: SessionImplementor

Get the creating SessionFactoryImplementor

Specified by:

getFactory in interface SessionImplementor

shouldAutoJoinTransaction

public abstract boolean shouldAutoJoinTransaction()

Description copied from interface: TransactionCoordinatorBuilder.TransactionCoordinatorOptions

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

Specified by:

shouldAutoJoinTransaction in interface TransactionCoordinatorBuilder.TransactionCoordinatorOptions

Returns:

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

execute

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

Description copied from interface: LobCreationContext

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

Specified by:

execute in interface LobCreationContext

Type Parameters:

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

Parameters:

callback - The callback to execute .

Returns:

The LOB created by the callback.

isClosed

public boolean isClosed()

Description copied from interface: SessionImplementor

Determine whether the session is closed. Provided separately from SessionImplementor.isOpen() as this method does not attempt any JTA synchronization registration, where as SessionImplementor.isOpen() does; which makes this one nicer to use for most internal purposes.

Specified by:

isClosed in interface SessionImplementor

Returns:

True if the session is closed; false otherwise.

setClosed

protected void setClosed()

errorIfClosed

protected void errorIfClosed()

createQuery

public Query createQuery(NamedQueryDefinition namedQueryDefinition)

Description copied from interface: SessionImplementor

Used from EntityManager

Specified by:

createQuery in interface SessionImplementor

Parameters:

namedQueryDefinition - The named query definition

Returns:

The basic HQL/JPQL query (without saved settings applied)

createSQLQuery

public SQLQuery createSQLQuery(NamedSQLQueryDefinition namedQueryDefinition)

Description copied from interface: SessionImplementor

Used from EntityManager

Specified by:

createSQLQuery in interface SessionImplementor

Parameters:

namedQueryDefinition - The named query definition

Returns:

The basic SQL query (without saved settings applied)

getNamedQuery

public Query getNamedQuery(String queryName)
                    throws MappingException

Description copied from interface: SharedSessionContract

Create a Query instance for the named query string defined in the metadata.

Specified by:

getNamedQuery in interface SessionImplementor

Specified by:

getNamedQuery in interface SharedSessionContract

Parameters:

queryName - the name of a query defined externally

Returns:

The query instance for manipulation and execution

Throws:

MappingException

getNamedSQLQuery

public Query getNamedSQLQuery(String queryName)
                       throws MappingException

Description copied from interface: SessionImplementor

Get a Query instance for a named native SQL query

Specified by:

getNamedSQLQuery in interface SessionImplementor

Throws:

MappingException

createQuery

public Query createQuery(String queryString)

Description copied from interface: SharedSessionContract

Create a Query instance for the given HQL query string.

Specified by:

createQuery in interface SharedSessionContract

Parameters:

queryString - The HQL query

Returns:

The query instance for manipulation and execution

createSQLQuery

public SQLQuery createSQLQuery(String sql)

Description copied from interface: SharedSessionContract

Create a SQLQuery instance for the given SQL query string.

Specified by:

createSQLQuery in interface SharedSessionContract

Parameters:

sql - The SQL query

Returns:

The query instance for manipulation and execution

getNamedProcedureCall

public ProcedureCall getNamedProcedureCall(String name)

Description copied from interface: SharedSessionContract

Gets a ProcedureCall based on a named template

Specified by:

getNamedProcedureCall in interface SharedSessionContract

Parameters:

name - The name given to the template

Returns:

The ProcedureCall

See Also:

NamedStoredProcedureQuery

createStoredProcedureCall

public ProcedureCall createStoredProcedureCall(String procedureName)

Description copied from interface: SharedSessionContract

Creates a call to a stored procedure.

Specified by:

createStoredProcedureCall in interface SharedSessionContract

Parameters:

procedureName - The name of the procedure.

Returns:

The representation of the procedure call.

createStoredProcedureCall

public ProcedureCall createStoredProcedureCall(String procedureName,
                                               Class... resultClasses)

Description copied from interface: SharedSessionContract

Creates a call to a stored procedure with specific result set entity mappings. Each class named is considered a "root return".

Specified by:

createStoredProcedureCall in interface SharedSessionContract

Parameters:

procedureName - The name of the procedure.

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

Returns:

The representation of the procedure call.

createStoredProcedureCall

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

Description copied from interface: SharedSessionContract

Creates a call to a stored procedure with specific result set entity mappings.

Specified by:

createStoredProcedureCall in interface SharedSessionContract

Parameters:

procedureName - The name of the procedure.

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

Returns:

The representation of the procedure call.

getHQLQueryPlan

protected HQLQueryPlan getHQLQueryPlan(String query,
                                       boolean shallow)
                                throws HibernateException

Throws:

HibernateException

getNativeSQLQueryPlan

protected NativeSQLQueryPlan getNativeSQLQueryPlan(NativeSQLQuerySpecification spec)
                                            throws HibernateException

Throws:

HibernateException

getTransaction

public Transaction getTransaction()
                           throws HibernateException

Description copied from interface: SharedSessionContract

Get the Transaction instance associated with this session. The concrete type of the returned Transaction object is determined by the hibernate.transaction_factory property.

Specified by:

getTransaction in interface SharedSessionContract

Returns:

a Transaction instance

Throws:

HibernateException

list

public List list(NativeSQLQuerySpecification spec,
                 QueryParameters queryParameters)
          throws HibernateException

Description copied from interface: SessionImplementor

Execute a native SQL query, and return the results as a fully built list.

Specified by:

list in interface SessionImplementor

Parameters:

spec - The specification of the native SQL query to execute.

queryParameters - The parameters by which to perform the execution.

Returns:

The result list.

Throws:

HibernateException

scroll

public ScrollableResults scroll(NativeSQLQuerySpecification spec,
                                QueryParameters queryParameters)
                         throws HibernateException

Description copied from interface: SessionImplementor

Execute a native SQL query, and return the results as a scrollable result.

Specified by:

scroll in interface SessionImplementor

Parameters:

spec - The specification of the native SQL query to execute.

queryParameters - The parameters by which to perform the execution.

Returns:

The resulting scrollable result.

Throws:

HibernateException

getTenantIdentifier

public String getTenantIdentifier()

Description copied from interface: SharedSessionContract

Obtain the tenant identifier associated with this session.

Specified by:

getTenantIdentifier in interface SessionImplementor

Specified by:

getTenantIdentifier in interface SharedSessionContract

Returns:

The tenant identifier associated with this session, or null

generateEntityKey

public EntityKey generateEntityKey(Serializable id,
                                   EntityPersister persister)

Description copied from interface: SessionImplementor

Hide the changing requirements of entity key creation

Specified by:

generateEntityKey in interface SessionImplementor

Parameters:

id - The entity id

persister - The entity persister

Returns:

The entity key

getJdbcConnectionAccess

public JdbcConnectionAccess getJdbcConnectionAccess()

Description copied from interface: SessionImplementor

Provides access to JDBC connections

Specified by:

getJdbcConnectionAccess in interface SessionImplementor

Specified by:

getJdbcConnectionAccess in interface JdbcSessionOwner

Returns:

The contract for accessing JDBC connections.

getSessionIdentifier

public UUID getSessionIdentifier()

getTransactionCoordinatorBuilder

public TransactionCoordinatorBuilder getTransactionCoordinatorBuilder()

Description copied from interface: JdbcSessionOwner

Obtain the builder for TransactionCoordinator instances

Specified by:

getTransactionCoordinatorBuilder in interface JdbcSessionOwner

Returns:

The TransactionCoordinatorBuilder

getWrapperOptions

public WrapperOptions getWrapperOptions()

Description copied from interface: WrapperOptionsContext

Obtain the WrapperOptions for this context.

Specified by:

getWrapperOptions in interface WrapperOptionsContext

Returns:

The WrapperOptions