org.springframework.orm.jpa
Class EntityManagerFactoryUtils

java.lang.Object
  extended by org.springframework.orm.jpa.EntityManagerFactoryUtils

public abstract class EntityManagerFactoryUtils
extends java.lang.Object

Helper class featuring methods for JPA EntityManager handling, allowing for reuse of EntityManager instances within transactions. Also provides support for exception translation.

Mainly intended for internal use within the framework.

Since:
2.0
Author:
Juergen Hoeller

Field Summary
static int ENTITY_MANAGER_SYNCHRONIZATION_ORDER
          Order value for TransactionSynchronization objects that clean up JPA EntityManagers.
 
Constructor Summary
EntityManagerFactoryUtils()
           
 
Method Summary
static void closeEntityManager(javax.persistence.EntityManager em)
          Close the given JPA EntityManager, catching and logging any cleanup exceptions thrown.
static DataAccessException convertJpaAccessExceptionIfPossible(java.lang.RuntimeException ex)
          Convert the given runtime exception to an appropriate exception from the org.springframework.dao hierarchy.
static javax.persistence.EntityManager doGetTransactionalEntityManager(javax.persistence.EntityManagerFactory emf, java.util.Map properties)
          Obtain a JPA EntityManager from the given factory.
static javax.persistence.EntityManagerFactory findEntityManagerFactory(ListableBeanFactory beanFactory, java.lang.String unitName)
          Find an EntityManagerFactory with the given name in the given Spring application context (represented as ListableBeanFactory).
static javax.persistence.EntityManager getTransactionalEntityManager(javax.persistence.EntityManagerFactory emf)
          Obtain a JPA EntityManager from the given factory.
static javax.persistence.EntityManager getTransactionalEntityManager(javax.persistence.EntityManagerFactory emf, java.util.Map properties)
          Obtain a JPA EntityManager from the given factory.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ENTITY_MANAGER_SYNCHRONIZATION_ORDER

public static final int ENTITY_MANAGER_SYNCHRONIZATION_ORDER
Order value for TransactionSynchronization objects that clean up JPA EntityManagers. Return DataSourceUtils.CONNECTION_SYNCHRONIZATION_ORDER - 100 to execute EntityManager cleanup before JDBC Connection cleanup, if any.

See Also:
DataSourceUtils.CONNECTION_SYNCHRONIZATION_ORDER, Constant Field Values
Constructor Detail

EntityManagerFactoryUtils

public EntityManagerFactoryUtils()
Method Detail

findEntityManagerFactory

public static javax.persistence.EntityManagerFactory findEntityManagerFactory(ListableBeanFactory beanFactory,
                                                                              java.lang.String unitName)
                                                                       throws NoSuchBeanDefinitionException
Find an EntityManagerFactory with the given name in the given Spring application context (represented as ListableBeanFactory).

The specified unit name will be matched against the configured peristence unit, provided that a discovered EntityManagerFactory implements the EntityManagerFactoryInfo interface. If not, the persistence unit name will be matched against the Spring bean name, assuming that the EntityManagerFactory bean names follow that convention.

Parameters:
beanFactory - the ListableBeanFactory to search
unitName - the name of the persistence unit (never empty)
Returns:
the EntityManagerFactory
Throws:
NoSuchBeanDefinitionException - if there is no such EntityManagerFactory in the context
See Also:
EntityManagerFactoryInfo.getPersistenceUnitName()

getTransactionalEntityManager

public static javax.persistence.EntityManager getTransactionalEntityManager(javax.persistence.EntityManagerFactory emf)
                                                                     throws DataAccessResourceFailureException
Obtain a JPA EntityManager from the given factory. Is aware of a corresponding EntityManager bound to the current thread, for example when using JpaTransactionManager.

Note: Will return null if no thread-bound EntityManager found!

Parameters:
emf - EntityManagerFactory to create the EntityManager with
Returns:
the EntityManager, or null if none found
Throws:
DataAccessResourceFailureException - if the EntityManager couldn't be obtained
See Also:
JpaTransactionManager

getTransactionalEntityManager

public static javax.persistence.EntityManager getTransactionalEntityManager(javax.persistence.EntityManagerFactory emf,
                                                                            java.util.Map properties)
                                                                     throws DataAccessResourceFailureException
Obtain a JPA EntityManager from the given factory. Is aware of a corresponding EntityManager bound to the current thread, for example when using JpaTransactionManager.

Note: Will return null if no thread-bound EntityManager found!

Parameters:
emf - EntityManagerFactory to create the EntityManager with
properties - the properties to be passed into the createEntityManager call (may be null)
Returns:
the EntityManager, or null if none found
Throws:
DataAccessResourceFailureException - if the EntityManager couldn't be obtained
See Also:
JpaTransactionManager

doGetTransactionalEntityManager

public static javax.persistence.EntityManager doGetTransactionalEntityManager(javax.persistence.EntityManagerFactory emf,
                                                                              java.util.Map properties)
                                                                       throws javax.persistence.PersistenceException
Obtain a JPA EntityManager from the given factory. Is aware of a corresponding EntityManager bound to the current thread, for example when using JpaTransactionManager.

Same as getEntityManager, but throwing the original PersistenceException.

Parameters:
emf - EntityManagerFactory to create the EntityManager with
properties - the properties to be passed into the createEntityManager call (may be null)
Returns:
the EntityManager, or null if none found
Throws:
javax.persistence.PersistenceException - if the EntityManager couldn't be created
See Also:
getTransactionalEntityManager(javax.persistence.EntityManagerFactory), JpaTransactionManager

convertJpaAccessExceptionIfPossible

public static DataAccessException convertJpaAccessExceptionIfPossible(java.lang.RuntimeException ex)
Convert the given runtime exception to an appropriate exception from the org.springframework.dao hierarchy. Return null if no translation is appropriate: any other exception may have resulted from user code, and should not be translated.

The most important cases like object not found or optimistic locking failure are covered here. For more fine-granular conversion, JpaAccessor and JpaTransactionManager support sophisticated translation of exceptions via a JpaDialect.

Parameters:
ex - runtime exception that occured
Returns:
the corresponding DataAccessException instance, or null if the exception should not be translated

closeEntityManager

public static void closeEntityManager(javax.persistence.EntityManager em)
Close the given JPA EntityManager, catching and logging any cleanup exceptions thrown.

Parameters:
em - the JPA EntityManager to close (may be null)
See Also:
EntityManager.close()