org.hibernate.jpa.spi

Interface HibernateEntityManagerImplementor

All Superinterfaces:

EntityManager, HibernateEntityManager, HibernateEntityManagerFactoryAware

All Known Subinterfaces:

HibernateEntityManagerImplementor

All Known Implementing Classes:

AbstractEntityManagerImpl, AbstractEntityManagerImpl, EntityManagerImpl

public interface HibernateEntityManagerImplementor
extends HibernateEntityManager, HibernateEntityManagerFactoryAware

Additional internal contracts for the Hibernate EntityManager implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HibernateEntityManagerImplementor.QueryOptions

Method Summary

Modifier and Type	Method and Description
void	checkOpen(boolean markForRollbackIfClosed) Used to ensure the EntityManager is open, throwing IllegalStateException if it is closed.
RuntimeException	convert(HibernateException e) Converts a Hibernate-specific exception into a JPA-specified exception; note that the JPA sepcification makes use of exceptions outside its exception hierarchy, though they are all runtime exceptions.
RuntimeException	convert(HibernateException e, LockOptions lockOptions) Converts a Hibernate-specific exception into a JPA-specified exception; note that the JPA sepcification makes use of exceptions outside its exception hierarchy, though they are all runtime exceptions.
<T> QueryImpl<T>	createQuery(String jpaqlString, Class<T> resultClass, Selection selection, HibernateEntityManagerImplementor.QueryOptions queryOptions) Used during "compiling" a JPA criteria query.
LockOptions	getLockRequest(LockModeType lockModeType, Map<String,Object> properties) Convert from JPA 2 LockModeType & properties into LockOptions
void	handlePersistenceException(PersistenceException e) Handles marking for rollback and other such operations that need to occur depending on the type of exception being handled.
boolean	isTransactionInProgress() Provides access to whether a transaction is currently in progress.
void	markForRollbackOnly() Used to mark a transaction for rollback only (when that is the JPA spec defined behavior).
void	throwPersistenceException(HibernateException e) Delegates to convert(org.hibernate.HibernateException, org.hibernate.LockOptions) and then throws the given exception.
void	throwPersistenceException(PersistenceException e) Delegates to handlePersistenceException(javax.persistence.PersistenceException) and then throws the given exception.
PersistenceException	wrapStaleStateException(StaleStateException e)

Methods inherited from interface org.hibernate.jpa.HibernateEntityManager

getSession

Methods inherited from interface javax.persistence.EntityManager

clear, close, contains, createEntityGraph, createEntityGraph, createNamedQuery, createNamedQuery, createNamedStoredProcedureQuery, createNativeQuery, createNativeQuery, createNativeQuery, createQuery, createQuery, createQuery, createQuery, createQuery, createStoredProcedureQuery, createStoredProcedureQuery, createStoredProcedureQuery, detach, find, find, find, find, flush, getCriteriaBuilder, getDelegate, getEntityGraph, getEntityGraphs, getEntityManagerFactory, getFlushMode, getLockMode, getMetamodel, getProperties, getReference, getTransaction, isJoinedToTransaction, isOpen, joinTransaction, lock, lock, merge, persist, refresh, refresh, refresh, refresh, remove, setFlushMode, setProperty, unwrap

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

getFactory

Method Detail

checkOpen

void checkOpen(boolean markForRollbackIfClosed)
        throws IllegalStateException

Used to ensure the EntityManager is open, throwing IllegalStateException if it is closed. Depending on the value of markForRollbackIfClosed, may also rollback any enlisted-in transaction. This distinction is made across various sections of the spec. Most failed checks should rollback. Section 3.10.7 (per 2.1 spec) lists cases related to calls on related query objects that should not rollback.

Parameters:

markForRollbackIfClosed - If the EM is closed, should the transaction (if one) be marked for rollback?

Throws:

IllegalStateException - Thrown if the EM is closed

isTransactionInProgress

boolean isTransactionInProgress()

Provides access to whether a transaction is currently in progress.

Returns:

True if a transaction is considered currently in progress; false otherwise.

markForRollbackOnly

void markForRollbackOnly()

Used to mark a transaction for rollback only (when that is the JPA spec defined behavior).

handlePersistenceException

void handlePersistenceException(PersistenceException e)

Handles marking for rollback and other such operations that need to occur depending on the type of exception being handled.

Parameters:

e - The exception being handled.

throwPersistenceException

void throwPersistenceException(PersistenceException e)

Delegates to handlePersistenceException(javax.persistence.PersistenceException) and then throws the given exception.

Parameters:

e - The exception being handled and finally thrown.

convert

RuntimeException convert(HibernateException e,
                         LockOptions lockOptions)

Converts a Hibernate-specific exception into a JPA-specified exception; note that the JPA sepcification makes use of exceptions outside its exception hierarchy, though they are all runtime exceptions.

Any appropriate/needed calls to handlePersistenceException(javax.persistence.PersistenceException) are also made.

Parameters:

e - The Hibernate excepton.

lockOptions - The lock options in effect at the time of exception (can be null)

Returns:

The JPA-specified exception

convert

RuntimeException convert(HibernateException e)

Converts a Hibernate-specific exception into a JPA-specified exception; note that the JPA sepcification makes use of exceptions outside its exception hierarchy, though they are all runtime exceptions.

Any appropriate/needed calls to handlePersistenceException(javax.persistence.PersistenceException) are also made.

Parameters:

e - The Hibernate excepton.

Returns:

The JPA-specified exception

throwPersistenceException

void throwPersistenceException(HibernateException e)

Delegates to convert(org.hibernate.HibernateException, org.hibernate.LockOptions) and then throws the given exception.

Parameters:

e - The exception being handled and finally thrown.

wrapStaleStateException

PersistenceException wrapStaleStateException(StaleStateException e)

getLockRequest

LockOptions getLockRequest(LockModeType lockModeType,
                           Map<String,Object> properties)

Convert from JPA 2 LockModeType & properties into LockOptions

Parameters:

lockModeType - is the requested lock type

properties - are the lock properties

Returns:

the LockOptions

createQuery

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

Used during "compiling" a JPA criteria query.

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