org.hibernate.engine.spi

Interface SharedSessionContractImplementor

All Superinterfaces:

JdbcSessionOwner, LobCreationContext, QueryProducer, QueryProducerImplementor, Serializable, SharedSessionContract, TransactionCoordinatorBuilder.Options, WrapperOptions

All Known Subinterfaces:

EventSource, SessionImplementor

All Known Implementing Classes:

AbstractDelegateSessionImplementor, AbstractSessionImpl, AbstractSharedSessionContract, SessionDelegatorBaseImpl, SessionImpl, StatelessSessionImpl, ToOneDelegateSessionImplementor

public interface SharedSessionContractImplementor
extends SharedSessionContract, JdbcSessionOwner, TransactionCoordinatorBuilder.Options, LobCreationContext, WrapperOptions, QueryProducerImplementor

Defines the internal contract shared between Session and StatelessSession as used by other parts of Hibernate (such as Type, EntityPersister and CollectionPersister implementors A Session, through this interface and SharedSessionContractImplementor, implements:

• JdbcSessionOwner to drive the behavior of a "JDBC session". Can therefor be used to construct a JdbcCoordinator, which (for now) models a "JDBC session"
• TransactionCoordinatorBuilder.Options to drive the creation of the TransactionCoordinator delegate. This allows it to be passed along to TransactionCoordinatorBuilder.buildTransactionCoordinator(org.hibernate.resource.transaction.spi.TransactionCoordinatorOwner, org.hibernate.resource.transaction.spi.TransactionCoordinatorBuilder.Options)
• 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

Author:

Gavin King, Steve Ebersole

Nested Class Summary

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

LobCreationContext.Callback<T>

Method Summary

Modifier and Type	Method and Description
Transaction	accessTransaction() Provides access to the underlying transaction or creates a new transaction if one does not already exist or is active.
void	afterScrollOperation()
String	bestGuessEntityName(Object object) The best guess entity name for an entity not in an association
default void	checkOpen() Performs a check whether the Session is open, and if not: marks current transaction (if one) for rollback only throws an IllegalStateException (JPA defines the exception type)
void	checkOpen(boolean markForRollbackIfClosed) Performs a check whether the Session is open, and if not: if markForRollbackIfClosed is true, marks current transaction (if one) for rollback only throws an IllegalStateException (JPA defines the exception type)
Connection	connection()
int	executeNativeUpdate(NativeSQLQuerySpecification specification, QueryParameters queryParameters) Execute a native SQL update or delete query
int	executeUpdate(String query, QueryParameters queryParameters) Execute a HQL update or delete query
void	flush()
EntityKey	generateEntityKey(Serializable id, EntityPersister persister) Hide the changing requirements of entity key creation
CacheMode	getCacheMode()
CacheTransactionSynchronization	getCacheTransactionSynchronization() The current CacheTransactionContext associated with the Session.
default Integer	getConfiguredJdbcBatchSize() Get the currently configured JDBC batch size either at the Session-level or SessionFactory-level.
Serializable	getContextEntityIdentifier(Object object) Return the identifier of the persistent object, or null if not associated with the session
int	getDontFlushFromFind()
EntityPersister	getEntityPersister(String entityName, Object object) Get the EntityPersister for any instance
Object	getEntityUsingInterceptor(EntityKey key) Get the entity instance associated with the given Key, calling the Interceptor if necessary
SessionEventListenerManager	getEventListenerManager()
ExceptionConverter	getExceptionConverter()
SessionFactoryImplementor	getFactory() Get the creating SessionFactoryImplementor
FlushModeType	getFlushMode() Get the flush mode for this session.
FlushMode	getHibernateFlushMode() Get the current flush mode for this session.
Interceptor	getInterceptor() Retrieves the interceptor currently in use by this event source.
JdbcCoordinator	getJdbcCoordinator()
JdbcServices	getJdbcServices()
LoadQueryInfluencers	getLoadQueryInfluencers() Get the load query influencers associated with this session.
PersistenceContext	getPersistenceContext() Get the persistence context for this session
UUID	getSessionIdentifier() A UUID associated with each Session.
String	getTenantIdentifier() The multi-tenancy tenant identifier, if one.
default long	getTimestamp() Deprecated. (since 5.3) Use
long	getTransactionStartTimestamp() A "timestamp" at or before the start of the current transaction.
String	guessEntityName(Object entity) The guessed entity name for an entity not in an association
Object	immediateLoad(String entityName, Serializable id) Load an instance immediately.
void	initializeCollection(PersistentCollection collection, boolean writing) Initialize the collection (if not already initialized)
Object	instantiate(String entityName, Serializable id) Instantiate the entity class, initializing with the given identifier
Object	internalLoad(String entityName, Serializable id, boolean eager, boolean nullable) Load an instance without checking if it was deleted.
boolean	isAutoCloseSessionEnabled()
boolean	isClosed() Checks whether the session is closed.
boolean	isEventSource()
default boolean	isOpenOrWaitingForAutoClose() Checks whether the session is open or is waiting for auto-close
default boolean	isQueryParametersValidationEnabled()
boolean	isTransactionInProgress() Does this Session have an active Hibernate transaction or is there a JTA transaction in progress?
Iterator	iterate(String query, QueryParameters queryParameters) Execute an iterate() query
Iterator	iterateFilter(Object collection, String filter, QueryParameters queryParameters) Iterate a filter
List	list(Criteria criteria) Execute a criteria query
List	list(NativeSQLQuerySpecification spec, QueryParameters queryParameters) Execute a native SQL query, and return the results as a fully built list.
List	list(String query, QueryParameters queryParameters) Execute a find() query
List	listCustomQuery(CustomQuery customQuery, QueryParameters queryParameters) Execute an SQL Query
List	listFilter(Object collection, String filter, QueryParameters queryParameters) Execute a filter
void	markForRollbackOnly() Marks current transaction (if one) for rollback only
ScrollableResultsImplementor	scroll(Criteria criteria, ScrollMode scrollMode) Execute a criteria query
ScrollableResultsImplementor	scroll(NativeSQLQuerySpecification spec, QueryParameters queryParameters) Execute a native SQL query, and return the results as a scrollable result.
ScrollableResultsImplementor	scroll(String query, QueryParameters queryParameters) Execute a scroll() query
ScrollableResultsImplementor	scrollCustomQuery(CustomQuery customQuery, QueryParameters queryParameters) Execute an SQL Query
void	setAutoClear(boolean enabled) Enable/disable automatic cache clearing from after transaction completion (for EJB3)
void	setCacheMode(CacheMode cm)
void	setFlushMode(FlushMode flushMode) Deprecated. (since 5.2) use setHibernateFlushMode(FlushMode) instead
void	setHibernateFlushMode(FlushMode flushMode) Set the flush mode for this session.
boolean	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.query.spi.QueryProducerImplementor

createNamedQuery, createNamedQuery, createNativeQuery, createNativeQuery, createNativeQuery, createQuery, createQuery, createSQLQuery, getNamedNativeQuery, getNamedQuery, getNamedSQLQuery

Method Detail

getFactory

SessionFactoryImplementor getFactory()

Get the creating SessionFactoryImplementor

Specified by:

getFactory in interface QueryProducerImplementor

getEventListenerManager

SessionEventListenerManager getEventListenerManager()

getPersistenceContext

PersistenceContext getPersistenceContext()

Get the persistence context for this session

getJdbcCoordinator

JdbcCoordinator getJdbcCoordinator()

getJdbcServices

JdbcServices getJdbcServices()

getTenantIdentifier

String getTenantIdentifier()

The multi-tenancy tenant identifier, if one.

Specified by:

getTenantIdentifier in interface SharedSessionContract

Returns:

The tenant identifier; may be null

getSessionIdentifier

UUID getSessionIdentifier()

A UUID associated with each Session. Useful mainly for logging.

Returns:

The UUID

isClosed

boolean isClosed()

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

Returns:

true if the session is closed; false otherwise.

isOpenOrWaitingForAutoClose

default boolean isOpenOrWaitingForAutoClose()

Checks whether the session is open or is waiting for auto-close

Returns:

true if the session is closed or if it's waiting for auto-close; false otherwise.

checkOpen

default void checkOpen()

Performs a check whether the Session is open, and if not:

• marks current transaction (if one) for rollback only
• throws an IllegalStateException (JPA defines the exception type)

checkOpen

void checkOpen(boolean markForRollbackIfClosed)

Performs a check whether the Session is open, and if not:

• if markForRollbackIfClosed is true, marks current transaction (if one) for rollback only
• throws an IllegalStateException (JPA defines the exception type)

markForRollbackOnly

void markForRollbackOnly()

Marks current transaction (if one) for rollback only

getTransactionStartTimestamp

long getTransactionStartTimestamp()

A "timestamp" at or before the start of the current transaction.

getTimestamp

@Deprecated
default long getTimestamp()

Deprecated. (since 5.3) Use

getCacheTransactionSynchronization

CacheTransactionSynchronization getCacheTransactionSynchronization()

The current CacheTransactionContext associated with the Session. This may return null when the Session is not currently part of a transaction.

isTransactionInProgress

boolean isTransactionInProgress()

Does this Session have an active Hibernate transaction or is there a JTA transaction in progress?

accessTransaction

Transaction accessTransaction()

Provides access to the underlying transaction or creates a new transaction if one does not already exist or is active. This is primarily for internal or integrator use.

Returns:

the transaction

generateEntityKey

EntityKey generateEntityKey(Serializable id,
                            EntityPersister persister)

Hide the changing requirements of entity key creation

Parameters:

id - The entity id

persister - The entity persister

Returns:

The entity key

getInterceptor

Interceptor getInterceptor()

Retrieves the interceptor currently in use by this event source.

Returns:

The interceptor.

setAutoClear

void setAutoClear(boolean enabled)

Enable/disable automatic cache clearing from after transaction completion (for EJB3)

initializeCollection

void initializeCollection(PersistentCollection collection,
                          boolean writing)
                   throws HibernateException

Initialize the collection (if not already initialized)

Throws:

HibernateException

internalLoad

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

Load an instance without checking if it was deleted.

When nullable is disabled this method may create a new proxy or return an existing proxy; if it does not exist, throw an exception.

When nullable is enabled, the method does not create new proxies (but might return an existing proxy); if it does not exist, return null.

When eager is enabled, the object is eagerly fetched

Throws:

HibernateException

immediateLoad

Object immediateLoad(String entityName,
                     Serializable id)
              throws HibernateException

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

Throws:

HibernateException

list

List list(String query,
          QueryParameters queryParameters)
   throws HibernateException

Execute a find() query

Throws:

HibernateException

iterate

Iterator iterate(String query,
                 QueryParameters queryParameters)
          throws HibernateException

Execute an iterate() query

Throws:

HibernateException

scroll

ScrollableResultsImplementor scroll(String query,
                                    QueryParameters queryParameters)
                             throws HibernateException

Execute a scroll() query

Throws:

HibernateException

scroll

ScrollableResultsImplementor scroll(Criteria criteria,
                                    ScrollMode scrollMode)

Execute a criteria query

list

List list(Criteria criteria)

Execute a criteria query

listFilter

List listFilter(Object collection,
                String filter,
                QueryParameters queryParameters)
         throws HibernateException

Execute a filter

Throws:

HibernateException

iterateFilter

Iterator iterateFilter(Object collection,
                       String filter,
                       QueryParameters queryParameters)
                throws HibernateException

Iterate a filter

Throws:

HibernateException

getEntityPersister

EntityPersister getEntityPersister(String entityName,
                                   Object object)
                            throws HibernateException

Get the EntityPersister for any instance

Parameters:

entityName - optional entity name

object - the entity instance

Throws:

HibernateException

getEntityUsingInterceptor

Object getEntityUsingInterceptor(EntityKey key)
                          throws HibernateException

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

Throws:

HibernateException

getContextEntityIdentifier

Serializable getContextEntityIdentifier(Object object)

Return the identifier of the persistent object, or null if not associated with the session

bestGuessEntityName

String bestGuessEntityName(Object object)

The best guess entity name for an entity not in an association

guessEntityName

String guessEntityName(Object entity)
                throws HibernateException

The guessed entity name for an entity not in an association

Throws:

HibernateException

instantiate

Object instantiate(String entityName,
                   Serializable id)
            throws HibernateException

Instantiate the entity class, initializing with the given identifier

Throws:

HibernateException

listCustomQuery

List listCustomQuery(CustomQuery customQuery,
                     QueryParameters queryParameters)
              throws HibernateException

Execute an SQL Query

Throws:

HibernateException

scrollCustomQuery

ScrollableResultsImplementor scrollCustomQuery(CustomQuery customQuery,
                                               QueryParameters queryParameters)
                                        throws HibernateException

Execute an SQL Query

Throws:

HibernateException

list

List list(NativeSQLQuerySpecification spec,
          QueryParameters queryParameters)
   throws HibernateException

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

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

ScrollableResultsImplementor scroll(NativeSQLQuerySpecification spec,
                                    QueryParameters queryParameters)

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

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

getDontFlushFromFind

int getDontFlushFromFind()

executeUpdate

int executeUpdate(String query,
                  QueryParameters queryParameters)
           throws HibernateException

Execute a HQL update or delete query

Throws:

HibernateException

executeNativeUpdate

int executeNativeUpdate(NativeSQLQuerySpecification specification,
                        QueryParameters queryParameters)
                 throws HibernateException

Execute a native SQL update or delete query

Throws:

HibernateException

getCacheMode

CacheMode getCacheMode()

Specified by:

getCacheMode in interface QueryProducerImplementor

setCacheMode

void setCacheMode(CacheMode cm)

setFlushMode

@Deprecated
void setFlushMode(FlushMode flushMode)

Deprecated. (since 5.2) use setHibernateFlushMode(FlushMode) instead

Set the flush mode for this session.

The flush mode determines the points at which the session is flushed. Flushing is the process of synchronizing the underlying persistent store with persistable state held in memory.

For a logically "read only" session, it is reasonable to set the session's flush mode to FlushMode.MANUAL at the start of the session (in order to achieve some extra performance).

Parameters:

flushMode - the new flush mode

getFlushMode

FlushModeType getFlushMode()

Get the flush mode for this session.

For users of the Hibernate native APIs, we've had to rename this method as defined by Hibernate historically because the JPA contract defines a method of the same name, but returning the JPA FlushModeType rather than Hibernate's FlushMode. For the former behavior, use getHibernateFlushMode() instead.

Returns:

The FlushModeType in effect for this Session.

setHibernateFlushMode

void setHibernateFlushMode(FlushMode flushMode)

Set the flush mode for this session.

The flush mode determines the points at which the session is flushed. Flushing is the process of synchronizing the underlying persistent store with persistable state held in memory.

For a logically "read only" session, it is reasonable to set the session's flush mode to FlushMode.MANUAL at the start of the session (in order to achieve some extra performance).

Parameters:

flushMode - the new flush mode

getHibernateFlushMode

FlushMode getHibernateFlushMode()

Get the current flush mode for this session.

Specified by:

getHibernateFlushMode in interface QueryProducerImplementor

Returns:

The flush mode

connection

Connection connection()

flush

void flush()

isEventSource

boolean isEventSource()

afterScrollOperation

void afterScrollOperation()

shouldAutoClose

boolean shouldAutoClose()

isAutoCloseSessionEnabled

boolean isAutoCloseSessionEnabled()

isQueryParametersValidationEnabled

default boolean isQueryParametersValidationEnabled()

getLoadQueryInfluencers

LoadQueryInfluencers getLoadQueryInfluencers()

Get the load query influencers associated with this session.

Returns:

the load query influencers associated with this session; should never be null.

getExceptionConverter

ExceptionConverter getExceptionConverter()

getConfiguredJdbcBatchSize

default Integer getConfiguredJdbcBatchSize()

Get the currently configured JDBC batch size either at the Session-level or SessionFactory-level. If the Session-level JDBC batch size was not configured, return the SessionFactory-level one.

Returns:

Session-level or or SessionFactory-level JDBC batch size.

Since:

5.2

See Also:

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