Class EntityManagerFactoryUtils
Mainly intended for internal use within the framework.
- Since:
- 2.0
- Author:
- Juergen Hoeller
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Order value for TransactionSynchronization objects that clean up JPA EntityManagers. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
applyTransactionTimeout
(Query query, EntityManagerFactory emf) Apply the current transaction timeout, if any, to the given JPA Query object.static void
Close the given JPA EntityManager, catching and logging any cleanup exceptions thrown.static DataAccessException
Convert the given runtime exception to an appropriate exception from theorg.springframework.dao
hierarchy.static EntityManager
doGetTransactionalEntityManager
(EntityManagerFactory emf, Map<?, ?> properties) Obtain a JPA EntityManager from the given factory.static EntityManager
doGetTransactionalEntityManager
(EntityManagerFactory emf, Map<?, ?> properties, boolean synchronizedWithTransaction) Obtain a JPA EntityManager from the given factory.static EntityManagerFactory
findEntityManagerFactory
(ListableBeanFactory beanFactory, String unitName) Find an EntityManagerFactory with the given name in the given Spring application context (represented as ListableBeanFactory).static EntityManager
Obtain a JPA EntityManager from the given factory.static EntityManager
getTransactionalEntityManager
(EntityManagerFactory emf, Map<?, ?> properties) Obtain a JPA EntityManager from the given factory.
-
Field Details
-
ENTITY_MANAGER_SYNCHRONIZATION_ORDER
public static final int ENTITY_MANAGER_SYNCHRONIZATION_ORDEROrder 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.
-
-
Constructor Details
-
EntityManagerFactoryUtils
public EntityManagerFactoryUtils()
-
-
Method Details
-
findEntityManagerFactory
public static EntityManagerFactory findEntityManagerFactory(ListableBeanFactory beanFactory, @Nullable 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 persistence 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.If no unit name has been given, this method will search for a default EntityManagerFactory through
BeanFactory.getBean(Class)
.- Parameters:
beanFactory
- the ListableBeanFactory to searchunitName
- the name of the persistence unit (may benull
or empty, in which case a single bean of type EntityManagerFactory will be searched for)- Returns:
- the EntityManagerFactory
- Throws:
NoSuchBeanDefinitionException
- if there is no such EntityManagerFactory in the context- See Also:
-
getTransactionalEntityManager
@Nullable public static EntityManager getTransactionalEntityManager(EntityManagerFactory emf) throws DataAccessResourceFailureException Obtain a JPA EntityManager from the given factory. Is aware of a corresponding EntityManager bound to the current thread, e.g. when using JpaTransactionManager.Note: Will return
null
if no thread-bound EntityManager found!- Parameters:
emf
- the 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:
-
getTransactionalEntityManager
@Nullable public static EntityManager getTransactionalEntityManager(EntityManagerFactory emf, @Nullable Map<?, ?> properties) throws DataAccessResourceFailureExceptionObtain a JPA EntityManager from the given factory. Is aware of a corresponding EntityManager bound to the current thread, e.g. when using JpaTransactionManager.Note: Will return
null
if no thread-bound EntityManager found!- Parameters:
emf
- the EntityManagerFactory to create the EntityManager withproperties
- the properties to be passed into thecreateEntityManager
call (may benull
)- Returns:
- the EntityManager, or
null
if none found - Throws:
DataAccessResourceFailureException
- if the EntityManager couldn't be obtained- See Also:
-
doGetTransactionalEntityManager
@Nullable public static EntityManager doGetTransactionalEntityManager(EntityManagerFactory emf, Map<?, ?> properties) throws PersistenceExceptionObtain a JPA EntityManager from the given factory. Is aware of a corresponding EntityManager bound to the current thread, e.g. when using JpaTransactionManager.Same as
getEntityManager
, but throwing the original PersistenceException.- Parameters:
emf
- the EntityManagerFactory to create the EntityManager withproperties
- the properties to be passed into thecreateEntityManager
call (may benull
)- Returns:
- the EntityManager, or
null
if none found - Throws:
PersistenceException
- if the EntityManager couldn't be created- See Also:
-
doGetTransactionalEntityManager
@Nullable public static EntityManager doGetTransactionalEntityManager(EntityManagerFactory emf, @Nullable Map<?, ?> properties, boolean synchronizedWithTransaction) throws PersistenceExceptionObtain a JPA EntityManager from the given factory. Is aware of a corresponding EntityManager bound to the current thread, e.g. when using JpaTransactionManager.Same as
getEntityManager
, but throwing the original PersistenceException.- Parameters:
emf
- the EntityManagerFactory to create the EntityManager withproperties
- the properties to be passed into thecreateEntityManager
call (may benull
)synchronizedWithTransaction
- whether to automatically join ongoing transactions (according to the JPA 2.1 SynchronizationType rules)- Returns:
- the EntityManager, or
null
if none found - Throws:
PersistenceException
- if the EntityManager couldn't be created- See Also:
-
applyTransactionTimeout
Apply the current transaction timeout, if any, to the given JPA Query object.This method sets the JPA query hint "jakarta.persistence.query.timeout" accordingly.
- Parameters:
query
- the JPA Query objectemf
- the JPA EntityManagerFactory that the Query was created for
-
convertJpaAccessExceptionIfPossible
@Nullable public static DataAccessException convertJpaAccessExceptionIfPossible(RuntimeException ex) Convert the given runtime exception to an appropriate exception from theorg.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, JpaTransactionManager etc support sophisticated translation of exceptions via a JpaDialect.
- Parameters:
ex
- runtime exception that occurred- Returns:
- the corresponding DataAccessException instance,
or
null
if the exception should not be translated
-
closeEntityManager
Close the given JPA EntityManager, catching and logging any cleanup exceptions thrown.- Parameters:
em
- the JPA EntityManager to close (may benull
)- See Also:
-