public abstract class AbstractEntityManagerFactoryBean extends Object implements org.springframework.beans.factory.FactoryBean<EntityManagerFactory>, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean, EntityManagerFactoryInfo, org.springframework.dao.support.PersistenceExceptionTranslator, Serializable
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 as well as
Spring's JpaVendorAdapter abstraction, and controls the
EntityManagerFactory's lifecycle.
This class also implements the
PersistenceExceptionTranslator
interface, as autodetected by Spring's
org.springframework.dao.annotation.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.
LocalEntityManagerFactoryBean,
LocalContainerEntityManagerFactoryBean,
Serialized Form| Modifier and Type | Field and Description |
|---|---|
protected Log |
logger
Logger available to subclasses
|
EntityManagerFactory |
nativeEntityManagerFactory
Raw EntityManagerFactory as returned by the PersistenceProvider
|
| Constructor and Description |
|---|
AbstractEntityManagerFactoryBean() |
| Modifier and Type | Method and Description |
|---|---|
void |
afterPropertiesSet() |
protected EntityManagerFactory |
createEntityManagerFactoryProxy(EntityManagerFactory emf)
Create a proxy of the given EntityManagerFactory.
|
protected abstract EntityManagerFactory |
createNativeEntityManagerFactory()
Subclasses must implement this method to create the EntityManagerFactory
that will be returned by the
getObject() method. |
void |
destroy()
Close the EntityManagerFactory on bean factory shutdown.
|
ClassLoader |
getBeanClassLoader()
Return the ClassLoader that the application's beans are loaded with.
|
DataSource |
getDataSource()
Return the JDBC DataSource that this EntityManagerFactory
obtains its JDBC Connections from.
|
Class<? extends EntityManager> |
getEntityManagerInterface()
Return the (potentially vendor-specific) EntityManager interface
that this factory's EntityManagers will implement.
|
JpaDialect |
getJpaDialect()
Return the vendor-specific JpaDialect implementation for this
EntityManagerFactory, or
null if not known. |
Map<String,Object> |
getJpaPropertyMap()
Allow Map access to the JPA properties to be passed to the persistence
provider, with the option to add or override specific entries.
|
JpaVendorAdapter |
getJpaVendorAdapter()
Return the JpaVendorAdapter implementation for this
EntityManagerFactory, or
null if not known. |
EntityManagerFactory |
getNativeEntityManagerFactory()
Return the raw underlying EntityManagerFactory.
|
EntityManagerFactory |
getObject()
Return the singleton EntityManagerFactory.
|
Class<? extends EntityManagerFactory> |
getObjectType() |
PersistenceProvider |
getPersistenceProvider()
Return the underlying PersistenceProvider that the underlying
EntityManagerFactory was created with.
|
PersistenceUnitInfo |
getPersistenceUnitInfo()
Return the PersistenceUnitInfo used to create this
EntityManagerFactory, if the in-container API was used.
|
String |
getPersistenceUnitName()
Return the name of the persistence unit used to create this
EntityManagerFactory, or
null if it is an unnamed default. |
boolean |
isSingleton() |
void |
setBeanClassLoader(ClassLoader classLoader) |
void |
setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) |
void |
setBeanName(String name) |
void |
setEntityManagerFactoryInterface(Class<? extends EntityManagerFactory> emfInterface)
Specify the (potentially vendor-specific) EntityManagerFactory interface
that this EntityManagerFactory proxy is supposed to implement.
|
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 into
Persistence.createEntityManagerFactory (if any). |
void |
setJpaPropertyMap(Map<String,?> jpaProperties)
Specify JPA properties as a Map, to be passed into
Persistence.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 |
translateExceptionIfPossible(RuntimeException ex)
Implementation of the PersistenceExceptionTranslator interface, as
autodetected by Spring's PersistenceExceptionTranslationPostProcessor.
|
protected Object |
writeReplace() |
protected final Log logger
public EntityManagerFactory nativeEntityManagerFactory
public void setPersistenceProviderClass(Class<? extends PersistenceProvider> persistenceProviderClass)
public void setPersistenceProvider(PersistenceProvider persistenceProvider)
public PersistenceProvider getPersistenceProvider()
EntityManagerFactoryInfogetPersistenceProvider in interface EntityManagerFactoryInfonull if the standard JPA provider autodetection process
was used to configure the EntityManagerFactorypublic void setPersistenceUnitName(String persistenceUnitName)
Default is none, indicating the default EntityManagerFactory configuration. The persistence provider will throw an exception if ambiguous EntityManager configurations are found.
public String getPersistenceUnitName()
EntityManagerFactoryInfonull if it is an unnamed default.
If getPersistenceUnitInfo() returns non-null, the result of
getPersistenceUnitName() must be equal to the value returned by
PersistenceUnitInfo.getPersistenceUnitName().
getPersistenceUnitName in interface EntityManagerFactoryInfoEntityManagerFactoryInfo.getPersistenceUnitInfo(),
PersistenceUnitInfo.getPersistenceUnitName()public void setJpaProperties(Properties jpaProperties)
Persistence.createEntityManagerFactory (if any).
Can be populated with a String "value" (parsed via PropertiesEditor) or a "props" element in XML bean definitions.
public void setJpaPropertyMap(Map<String,?> jpaProperties)
Persistence.createEntityManagerFactory (if any).
Can be populated with a "map" or "props" element in XML bean definitions.
public Map<String,Object> getJpaPropertyMap()
Useful for specifying entries directly, for example via "jpaPropertyMap[myKey]".
public void setEntityManagerFactoryInterface(Class<? extends EntityManagerFactory> emfInterface)
The default will be taken from the specific JpaVendorAdapter, if any,
or set to the standard javax.persistence.EntityManagerFactory
interface else.
public void setEntityManagerInterface(Class<? extends EntityManager> emInterface)
The default will be taken from the specific JpaVendorAdapter, if any,
or set to the standard javax.persistence.EntityManager
interface else.
public Class<? extends EntityManager> getEntityManagerInterface()
EntityManagerFactoryInfoA null return value suggests that autodetection is supposed
to happen: either based on a target EntityManager instance
or simply defaulting to javax.persistence.EntityManager.
getEntityManagerInterface in interface EntityManagerFactoryInfopublic void setJpaDialect(JpaDialect jpaDialect)
EntityManagerFactoryInfo.getJpaDialect()public JpaDialect getJpaDialect()
EntityManagerFactoryInfonull if not known.getJpaDialect in interface EntityManagerFactoryInfopublic void setJpaVendorAdapter(JpaVendorAdapter jpaVendorAdapter)
public JpaVendorAdapter getJpaVendorAdapter()
null if not known.public void setBeanClassLoader(ClassLoader classLoader)
setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAwarepublic ClassLoader getBeanClassLoader()
EntityManagerFactoryInfoProxies will be generated in this ClassLoader.
getBeanClassLoader in interface EntityManagerFactoryInfopublic void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAwarepublic void setBeanName(String name)
setBeanName in interface org.springframework.beans.factory.BeanNameAwarepublic final void afterPropertiesSet()
throws PersistenceException
afterPropertiesSet in interface org.springframework.beans.factory.InitializingBeanPersistenceExceptionprotected EntityManagerFactory createEntityManagerFactoryProxy(EntityManagerFactory emf)
emf - EntityManagerFactory as returned by the persistence providerprotected abstract EntityManagerFactory createNativeEntityManagerFactory() throws PersistenceException
getObject() method.PersistenceException - if the EntityManager cannot be createdpublic org.springframework.dao.DataAccessException translateExceptionIfPossible(RuntimeException ex)
Uses the dialect's conversion if possible; otherwise falls back to standard JPA exception conversion.
translateExceptionIfPossible in interface org.springframework.dao.support.PersistenceExceptionTranslatororg.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor,
PersistenceExceptionTranslator.translateExceptionIfPossible(java.lang.RuntimeException),
EntityManagerFactoryUtils.convertJpaAccessExceptionIfPossible(java.lang.RuntimeException)public EntityManagerFactory getNativeEntityManagerFactory()
EntityManagerFactoryInfogetNativeEntityManagerFactory in interface EntityManagerFactoryInfonull)public PersistenceUnitInfo getPersistenceUnitInfo()
EntityManagerFactoryInfogetPersistenceUnitInfo in interface EntityManagerFactoryInfonull if the in-container contract was not used to
configure the EntityManagerFactorypublic DataSource getDataSource()
EntityManagerFactoryInfogetDataSource in interface EntityManagerFactoryInfonull if not knownpublic EntityManagerFactory getObject()
getObject in interface org.springframework.beans.factory.FactoryBean<EntityManagerFactory>public Class<? extends EntityManagerFactory> getObjectType()
getObjectType in interface org.springframework.beans.factory.FactoryBean<EntityManagerFactory>public boolean isSingleton()
isSingleton in interface org.springframework.beans.factory.FactoryBean<EntityManagerFactory>public void destroy()
destroy in interface org.springframework.beans.factory.DisposableBeanprotected Object writeReplace() throws ObjectStreamException
ObjectStreamException