Class AbstractEntityManagerFactoryBean
- All Implemented Interfaces:
Serializable
,org.springframework.beans.factory.Aware
,org.springframework.beans.factory.BeanClassLoaderAware
,org.springframework.beans.factory.BeanFactoryAware
,org.springframework.beans.factory.BeanNameAware
,org.springframework.beans.factory.DisposableBean
,org.springframework.beans.factory.FactoryBean<EntityManagerFactory>
,org.springframework.beans.factory.InitializingBean
,org.springframework.dao.support.PersistenceExceptionTranslator
,EntityManagerFactoryInfo
- Direct Known Subclasses:
LocalContainerEntityManagerFactoryBean
,LocalEntityManagerFactoryBean
FactoryBean
that creates
a local JPA EntityManagerFactory
instance within
a Spring application context.
Encapsulates the common functionality between the different JPA bootstrap contracts (standalone as well as container).
Implements support for standard JPA configuration conventions as well as
Spring's customizable JpaVendorAdapter
mechanism, and controls the
EntityManagerFactory's lifecycle.
This class also implements the
PersistenceExceptionTranslator
interface, as autodetected by Spring's
PersistenceExceptionTranslationPostProcessor
,
for AOP-based translation of native exceptions to Spring DataAccessExceptions.
Hence, the presence of e.g. LocalEntityManagerFactoryBean automatically enables
a PersistenceExceptionTranslationPostProcessor to translate JPA exceptions.
- Since:
- 2.0
- Author:
- Juergen Hoeller, Rod Johnson
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected final org.apache.commons.logging.Log
Logger available to subclasses.Fields inherited from interface org.springframework.beans.factory.FactoryBean
OBJECT_TYPE_ATTRIBUTE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
protected EntityManagerFactory
Create a proxy for the givenEntityManagerFactory
.createNativeEntityManager
(Map<?, ?> properties) Create a native JPA EntityManager to be used as the framework-managed resource behind an application-level EntityManager handle.protected abstract EntityManagerFactory
Subclasses must implement this method to create the EntityManagerFactory that will be returned by thegetObject()
method.void
destroy()
Close the EntityManagerFactory on bean factory shutdown.Return the ClassLoader that the application's beans are loaded with.org.springframework.core.task.AsyncTaskExecutor
Return the asynchronous executor for background bootstrapping, if any.Return the JDBC DataSource that this EntityManagerFactory obtains its JDBC Connections from.Class<? extends EntityManager>
Return the (potentially vendor-specific) EntityManager interface that this factory's EntityManagers will implement.Return the vendor-specific JpaDialect implementation for this EntityManagerFactory, ornull
if not known.AllowMap
access to the JPA properties to be passed to the persistence provider, with the option to add or override specific entries.Return the JpaVendorAdapter implementation for this EntityManagerFactory, ornull
if not known.Return the raw underlying EntityManagerFactory.Return the singleton EntityManagerFactory.Class<? extends EntityManagerFactory>
Return the underlying PersistenceProvider that the underlying EntityManagerFactory was created with.Return the PersistenceUnitInfo used to create this EntityManagerFactory, if the in-container API was used.Return the name of the persistence unit used to create this EntityManagerFactory, ornull
if it is an unnamed default.boolean
protected void
postProcessEntityManager
(EntityManager rawEntityManager) Optional callback for post-processing the native EntityManager before active use.void
setBeanClassLoader
(ClassLoader classLoader) void
setBeanFactory
(org.springframework.beans.factory.BeanFactory beanFactory) void
setBeanName
(String name) void
setBootstrapExecutor
(org.springframework.core.task.AsyncTaskExecutor bootstrapExecutor) Specify an asynchronous executor for background bootstrapping, e.g.void
setEntityManagerFactoryInterface
(Class<? extends EntityManagerFactory> emfInterface) Specify the (potentially vendor-specific) EntityManagerFactory interface that this EntityManagerFactory proxy is supposed to implement.void
setEntityManagerInitializer
(Consumer<EntityManager> entityManagerInitializer) Specify a callback for customizing everyEntityManager
created by the exposedEntityManagerFactory
.void
setEntityManagerInterface
(Class<? extends EntityManager> emInterface) Specify the (potentially vendor-specific) EntityManager interface that this factory's EntityManagers are supposed to implement.void
setJpaDialect
(JpaDialect jpaDialect) Specify the vendor-specific JpaDialect implementation to associate with this EntityManagerFactory.void
setJpaProperties
(Properties jpaProperties) Specify JPA properties, to be passed intoPersistence.createEntityManagerFactory
(if any).void
setJpaPropertyMap
(Map<String, ?> jpaProperties) Specify JPA properties as a Map, to be passed intoPersistence.createEntityManagerFactory
(if any).void
setJpaVendorAdapter
(JpaVendorAdapter jpaVendorAdapter) Specify the JpaVendorAdapter implementation for the desired JPA provider, if any.void
setPersistenceProvider
(PersistenceProvider persistenceProvider) Set the PersistenceProvider instance to use for creating the EntityManagerFactory.void
setPersistenceProviderClass
(Class<? extends PersistenceProvider> persistenceProviderClass) Set the PersistenceProvider implementation class to use for creating the EntityManagerFactory.void
setPersistenceUnitName
(String persistenceUnitName) Specify the name of the EntityManagerFactory configuration.org.springframework.dao.DataAccessException
Implementation of the PersistenceExceptionTranslator interface, as autodetected by Spring's PersistenceExceptionTranslationPostProcessor.protected Object
-
Field Details
-
logger
protected final org.apache.commons.logging.Log loggerLogger available to subclasses.
-
-
Constructor Details
-
AbstractEntityManagerFactoryBean
public AbstractEntityManagerFactoryBean()
-
-
Method Details
-
setPersistenceProviderClass
public void setPersistenceProviderClass(Class<? extends PersistenceProvider> persistenceProviderClass) Set the PersistenceProvider implementation class to use for creating the EntityManagerFactory. If not specified, the persistence provider will be taken from the JpaVendorAdapter (if any) or retrieved through scanning (as far as possible). -
setPersistenceProvider
Set the PersistenceProvider instance to use for creating the EntityManagerFactory. If not specified, the persistence provider will be taken from the JpaVendorAdapter (if any) or determined by the persistence unit deployment descriptor (as far as possible). -
getPersistenceProvider
Description copied from interface:EntityManagerFactoryInfo
Return the underlying PersistenceProvider that the underlying EntityManagerFactory was created with.- Specified by:
getPersistenceProvider
in interfaceEntityManagerFactoryInfo
- Returns:
- the PersistenceProvider used to create this EntityManagerFactory,
or
null
if the standard JPA provider autodetection process was used to configure the EntityManagerFactory
-
setPersistenceUnitName
Specify the name of the EntityManagerFactory configuration.Default is none, indicating the default EntityManagerFactory configuration. The persistence provider will throw an exception if ambiguous EntityManager configurations are found.
-
getPersistenceUnitName
Description copied from interface:EntityManagerFactoryInfo
Return the name of the persistence unit used to create this EntityManagerFactory, ornull
if it is an unnamed default.If
getPersistenceUnitInfo()
returns non-null, the result ofgetPersistenceUnitName()
must be equal to the value returned byPersistenceUnitInfo.getPersistenceUnitName()
.- Specified by:
getPersistenceUnitName
in interfaceEntityManagerFactoryInfo
- See Also:
-
setJpaProperties
Specify JPA properties, to be passed intoPersistence.createEntityManagerFactory
(if any).Can be populated with a String "value" (parsed via PropertiesEditor) or a "props" element in XML bean definitions.
-
setJpaPropertyMap
Specify JPA properties as a Map, to be passed intoPersistence.createEntityManagerFactory
(if any).Can be populated with a "map" or "props" element in XML bean definitions.
-
getJpaPropertyMap
AllowMap
access to the JPA properties to be passed to the persistence provider, with the option to add or override specific entries.Useful for specifying entries directly, for example via
jpaPropertyMap[myKey]
. -
setEntityManagerFactoryInterface
Specify the (potentially vendor-specific) EntityManagerFactory interface that this EntityManagerFactory proxy is supposed to implement.The default will be taken from the specific JpaVendorAdapter, if any, or set to the standard
jakarta.persistence.EntityManagerFactory
interface else. -
setEntityManagerInterface
Specify the (potentially vendor-specific) EntityManager interface that this factory's EntityManagers are supposed to implement.The default will be taken from the specific JpaVendorAdapter, if any, or set to the standard
jakarta.persistence.EntityManager
interface else. -
getEntityManagerInterface
Description copied from interface:EntityManagerFactoryInfo
Return the (potentially vendor-specific) EntityManager interface that this factory's EntityManagers will implement.A
null
return value suggests that autodetection is supposed to happen: either based on a targetEntityManager
instance or simply defaulting tojakarta.persistence.EntityManager
.- Specified by:
getEntityManagerInterface
in interfaceEntityManagerFactoryInfo
-
setJpaDialect
Specify the vendor-specific JpaDialect implementation to associate with this EntityManagerFactory. This will be exposed through the EntityManagerFactoryInfo interface, to be picked up as default dialect by accessors that intend to use JpaDialect functionality.- See Also:
-
getJpaDialect
Description copied from interface:EntityManagerFactoryInfo
Return the vendor-specific JpaDialect implementation for this EntityManagerFactory, ornull
if not known.- Specified by:
getJpaDialect
in interfaceEntityManagerFactoryInfo
-
setJpaVendorAdapter
Specify the JpaVendorAdapter implementation for the desired JPA provider, if any. This will initialize appropriate defaults for the given provider, such as persistence provider class and JpaDialect, unless locally overridden in this FactoryBean. -
getJpaVendorAdapter
Return the JpaVendorAdapter implementation for this EntityManagerFactory, ornull
if not known. -
setEntityManagerInitializer
Specify a callback for customizing everyEntityManager
created by the exposedEntityManagerFactory
.This is an alternative to a
JpaVendorAdapter
-levelpostProcessEntityManager
implementation, enabling convenient customizations for application purposes, e.g. setting Hibernate filters. -
setBootstrapExecutor
public void setBootstrapExecutor(@Nullable org.springframework.core.task.AsyncTaskExecutor bootstrapExecutor) Specify an asynchronous executor for background bootstrapping, e.g. aSimpleAsyncTaskExecutor
.EntityManagerFactory
initialization will then switch into background bootstrap mode, with aEntityManagerFactory
proxy immediately returned for injection purposes instead of waiting for the JPA provider's bootstrapping to complete. However, note that the first actual call to aEntityManagerFactory
method will then block until the JPA provider's bootstrapping completed, if not ready by then. For maximum benefit, make sure to avoid earlyEntityManagerFactory
calls in init methods of related beans, even for metadata introspection purposes.- Since:
- 4.3
-
getBootstrapExecutor
@Nullable public org.springframework.core.task.AsyncTaskExecutor getBootstrapExecutor()Return the asynchronous executor for background bootstrapping, if any.- Since:
- 4.3
-
setBeanClassLoader
- Specified by:
setBeanClassLoader
in interfaceorg.springframework.beans.factory.BeanClassLoaderAware
-
getBeanClassLoader
Description copied from interface:EntityManagerFactoryInfo
Return the ClassLoader that the application's beans are loaded with.Proxies will be generated in this ClassLoader.
- Specified by:
getBeanClassLoader
in interfaceEntityManagerFactoryInfo
-
setBeanFactory
public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) - Specified by:
setBeanFactory
in interfaceorg.springframework.beans.factory.BeanFactoryAware
-
setBeanName
- Specified by:
setBeanName
in interfaceorg.springframework.beans.factory.BeanNameAware
-
afterPropertiesSet
- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Throws:
PersistenceException
-
createEntityManagerFactoryProxy
Create a proxy for the givenEntityManagerFactory
. We do this to be able to return a transaction-aware proxy for an application-managedEntityManager
.- Parameters:
emf
- the EntityManagerFactory as returned by the persistence provider, if initialized already- Returns:
- the EntityManagerFactory proxy
-
createNativeEntityManagerFactory
protected abstract EntityManagerFactory createNativeEntityManagerFactory() throws PersistenceExceptionSubclasses must implement this method to create the EntityManagerFactory that will be returned by thegetObject()
method.- Returns:
- the EntityManagerFactory instance returned by this FactoryBean
- Throws:
PersistenceException
- if the EntityManager cannot be created
-
translateExceptionIfPossible
@Nullable public org.springframework.dao.DataAccessException translateExceptionIfPossible(RuntimeException ex) Implementation of the PersistenceExceptionTranslator interface, as autodetected by Spring's PersistenceExceptionTranslationPostProcessor.Uses the dialect's conversion if possible; otherwise falls back to standard JPA exception conversion.
- Specified by:
translateExceptionIfPossible
in interfaceorg.springframework.dao.support.PersistenceExceptionTranslator
- See Also:
-
PersistenceExceptionTranslationPostProcessor
PersistenceExceptionTranslator.translateExceptionIfPossible(java.lang.RuntimeException)
EntityManagerFactoryUtils.convertJpaAccessExceptionIfPossible(java.lang.RuntimeException)
-
getNativeEntityManagerFactory
Description copied from interface:EntityManagerFactoryInfo
Return the raw underlying EntityManagerFactory.- Specified by:
getNativeEntityManagerFactory
in interfaceEntityManagerFactoryInfo
- Returns:
- the unadorned EntityManagerFactory (never
null
)
-
createNativeEntityManager
Description copied from interface:EntityManagerFactoryInfo
Create a native JPA EntityManager to be used as the framework-managed resource behind an application-level EntityManager handle.This exposes a native
EntityManager
from the underlyingnative EntityManagerFactory
, takingJpaVendorAdapter.postProcessEntityManager(EntityManager)
into account.- Specified by:
createNativeEntityManager
in interfaceEntityManagerFactoryInfo
- See Also:
-
postProcessEntityManager
Optional callback for post-processing the native EntityManager before active use.The default implementation delegates to
JpaVendorAdapter.postProcessEntityManager(jakarta.persistence.EntityManager)
, if available.- Parameters:
rawEntityManager
- the EntityManager to post-process- Since:
- 5.3
- See Also:
-
getPersistenceUnitInfo
Description copied from interface:EntityManagerFactoryInfo
Return the PersistenceUnitInfo used to create this EntityManagerFactory, if the in-container API was used.- Specified by:
getPersistenceUnitInfo
in interfaceEntityManagerFactoryInfo
- Returns:
- the PersistenceUnitInfo used to create this EntityManagerFactory,
or
null
if the in-container contract was not used to configure the EntityManagerFactory
-
getDataSource
Description copied from interface:EntityManagerFactoryInfo
Return the JDBC DataSource that this EntityManagerFactory obtains its JDBC Connections from.- Specified by:
getDataSource
in interfaceEntityManagerFactoryInfo
- Returns:
- the JDBC DataSource, or
null
if not known
-
getObject
Return the singleton EntityManagerFactory.- Specified by:
getObject
in interfaceorg.springframework.beans.factory.FactoryBean<EntityManagerFactory>
-
getObjectType
- Specified by:
getObjectType
in interfaceorg.springframework.beans.factory.FactoryBean<EntityManagerFactory>
-
isSingleton
public boolean isSingleton()- Specified by:
isSingleton
in interfaceorg.springframework.beans.factory.FactoryBean<EntityManagerFactory>
-
destroy
public void destroy()Close the EntityManagerFactory on bean factory shutdown.- Specified by:
destroy
in interfaceorg.springframework.beans.factory.DisposableBean
-
writeReplace
- Throws:
ObjectStreamException
-