|
spring-orm | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.orm.jpa.AbstractEntityManagerFactoryBean
public abstract class AbstractEntityManagerFactoryBean
Abstract 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 FormField Summary | |
---|---|
protected org.apache.commons.logging.Log |
logger
Logger available to subclasses |
javax.persistence.EntityManagerFactory |
nativeEntityManagerFactory
Raw EntityManagerFactory as returned by the PersistenceProvider |
Constructor Summary | |
---|---|
AbstractEntityManagerFactoryBean()
|
Method Summary | |
---|---|
void |
afterPropertiesSet()
|
protected javax.persistence.EntityManagerFactory |
createEntityManagerFactoryProxy(javax.persistence.EntityManagerFactory emf)
Create a proxy of the given EntityManagerFactory. |
protected abstract javax.persistence.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. |
java.lang.ClassLoader |
getBeanClassLoader()
Return the ClassLoader that the application's beans are loaded with. |
javax.sql.DataSource |
getDataSource()
Return the JDBC DataSource that this EntityManagerFactory obtains its JDBC Connections from. |
java.lang.Class<? extends javax.persistence.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. |
java.util.Map<java.lang.String,java.lang.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. |
javax.persistence.EntityManagerFactory |
getNativeEntityManagerFactory()
Return the raw underlying EntityManagerFactory. |
javax.persistence.EntityManagerFactory |
getObject()
Return the singleton EntityManagerFactory. |
java.lang.Class<? extends javax.persistence.EntityManagerFactory> |
getObjectType()
|
javax.persistence.spi.PersistenceProvider |
getPersistenceProvider()
Return the underlying PersistenceProvider that the underlying EntityManagerFactory was created with. |
javax.persistence.spi.PersistenceUnitInfo |
getPersistenceUnitInfo()
Return the PersistenceUnitInfo used to create this EntityManagerFactory, if the in-container API was used. |
java.lang.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(java.lang.ClassLoader classLoader)
|
void |
setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
|
void |
setBeanName(java.lang.String name)
|
void |
setEntityManagerFactoryInterface(java.lang.Class<? extends javax.persistence.EntityManagerFactory> emfInterface)
Specify the (potentially vendor-specific) EntityManagerFactory interface that this EntityManagerFactory proxy is supposed to implement. |
void |
setEntityManagerInterface(java.lang.Class<? extends javax.persistence.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(java.util.Properties jpaProperties)
Specify JPA properties, to be passed into Persistence.createEntityManagerFactory (if any). |
void |
setJpaPropertyMap(java.util.Map<java.lang.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(javax.persistence.spi.PersistenceProvider persistenceProvider)
Set the PersistenceProvider instance to use for creating the EntityManagerFactory. |
void |
setPersistenceProviderClass(java.lang.Class<? extends javax.persistence.spi.PersistenceProvider> persistenceProviderClass)
Set the PersistenceProvider implementation class to use for creating the EntityManagerFactory. |
void |
setPersistenceUnitName(java.lang.String persistenceUnitName)
Specify the name of the EntityManagerFactory configuration. |
org.springframework.dao.DataAccessException |
translateExceptionIfPossible(java.lang.RuntimeException ex)
Implementation of the PersistenceExceptionTranslator interface, as autodetected by Spring's PersistenceExceptionTranslationPostProcessor. |
protected java.lang.Object |
writeReplace()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final org.apache.commons.logging.Log logger
public javax.persistence.EntityManagerFactory nativeEntityManagerFactory
Constructor Detail |
---|
public AbstractEntityManagerFactoryBean()
Method Detail |
---|
public void setPersistenceProviderClass(java.lang.Class<? extends javax.persistence.spi.PersistenceProvider> persistenceProviderClass)
JpaVendorAdapter.getPersistenceProvider()
,
PersistenceProvider
,
Persistence
public void setPersistenceProvider(javax.persistence.spi.PersistenceProvider persistenceProvider)
JpaVendorAdapter.getPersistenceProvider()
,
PersistenceProvider
,
Persistence
public javax.persistence.spi.PersistenceProvider getPersistenceProvider()
EntityManagerFactoryInfo
getPersistenceProvider
in interface EntityManagerFactoryInfo
null
if the standard JPA provider autodetection process
was used to configure the EntityManagerFactorypublic void setPersistenceUnitName(java.lang.String persistenceUnitName)
Default is none, indicating the default EntityManagerFactory configuration. The persistence provider will throw an exception if ambiguous EntityManager configurations are found.
Persistence.createEntityManagerFactory(String)
public java.lang.String getPersistenceUnitName()
EntityManagerFactoryInfo
null
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 EntityManagerFactoryInfo
EntityManagerFactoryInfo.getPersistenceUnitInfo()
,
PersistenceUnitInfo.getPersistenceUnitName()
public void setJpaProperties(java.util.Properties jpaProperties)
Persistence.createEntityManagerFactory
(if any).
Can be populated with a String "value" (parsed via PropertiesEditor) or a "props" element in XML bean definitions.
Persistence.createEntityManagerFactory(String, java.util.Map)
,
PersistenceProvider.createContainerEntityManagerFactory(javax.persistence.spi.PersistenceUnitInfo, java.util.Map)
public void setJpaPropertyMap(java.util.Map<java.lang.String,?> jpaProperties)
Persistence.createEntityManagerFactory
(if any).
Can be populated with a "map" or "props" element in XML bean definitions.
Persistence.createEntityManagerFactory(String, java.util.Map)
,
PersistenceProvider.createContainerEntityManagerFactory(javax.persistence.spi.PersistenceUnitInfo, java.util.Map)
public java.util.Map<java.lang.String,java.lang.Object> getJpaPropertyMap()
Useful for specifying entries directly, for example via "jpaPropertyMap[myKey]".
public void setEntityManagerFactoryInterface(java.lang.Class<? extends javax.persistence.EntityManagerFactory> emfInterface)
The default will be taken from the specific JpaVendorAdapter, if any,
or set to the standard javax.persistence.EntityManagerFactory
interface else.
JpaVendorAdapter.getEntityManagerFactoryInterface()
public void setEntityManagerInterface(java.lang.Class<? extends javax.persistence.EntityManager> emInterface)
The default will be taken from the specific JpaVendorAdapter, if any,
or set to the standard javax.persistence.EntityManager
interface else.
JpaVendorAdapter.getEntityManagerInterface()
,
EntityManagerFactoryInfo.getEntityManagerInterface()
public java.lang.Class<? extends javax.persistence.EntityManager> getEntityManagerInterface()
EntityManagerFactoryInfo
A 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 EntityManagerFactoryInfo
public void setJpaDialect(JpaDialect jpaDialect)
EntityManagerFactoryInfo.getJpaDialect()
public JpaDialect getJpaDialect()
EntityManagerFactoryInfo
null
if not known.
getJpaDialect
in interface EntityManagerFactoryInfo
public void setJpaVendorAdapter(JpaVendorAdapter jpaVendorAdapter)
public JpaVendorAdapter getJpaVendorAdapter()
null
if not known.
public void setBeanClassLoader(java.lang.ClassLoader classLoader)
setBeanClassLoader
in interface org.springframework.beans.factory.BeanClassLoaderAware
public java.lang.ClassLoader getBeanClassLoader()
EntityManagerFactoryInfo
Proxies will be generated in this ClassLoader.
getBeanClassLoader
in interface EntityManagerFactoryInfo
public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
setBeanFactory
in interface org.springframework.beans.factory.BeanFactoryAware
public void setBeanName(java.lang.String name)
setBeanName
in interface org.springframework.beans.factory.BeanNameAware
public final void afterPropertiesSet() throws javax.persistence.PersistenceException
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
javax.persistence.PersistenceException
protected javax.persistence.EntityManagerFactory createEntityManagerFactoryProxy(javax.persistence.EntityManagerFactory emf)
emf
- EntityManagerFactory as returned by the persistence provider
protected abstract javax.persistence.EntityManagerFactory createNativeEntityManagerFactory() throws javax.persistence.PersistenceException
getObject()
method.
javax.persistence.PersistenceException
- if the EntityManager cannot be createdpublic org.springframework.dao.DataAccessException translateExceptionIfPossible(java.lang.RuntimeException ex)
Uses the dialect's conversion if possible; otherwise falls back to standard JPA exception conversion.
translateExceptionIfPossible
in interface org.springframework.dao.support.PersistenceExceptionTranslator
org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor
,
PersistenceExceptionTranslator.translateExceptionIfPossible(java.lang.RuntimeException)
,
EntityManagerFactoryUtils.convertJpaAccessExceptionIfPossible(java.lang.RuntimeException)
public javax.persistence.EntityManagerFactory getNativeEntityManagerFactory()
EntityManagerFactoryInfo
getNativeEntityManagerFactory
in interface EntityManagerFactoryInfo
null
)public javax.persistence.spi.PersistenceUnitInfo getPersistenceUnitInfo()
EntityManagerFactoryInfo
getPersistenceUnitInfo
in interface EntityManagerFactoryInfo
null
if the in-container contract was not used to
configure the EntityManagerFactorypublic javax.sql.DataSource getDataSource()
EntityManagerFactoryInfo
getDataSource
in interface EntityManagerFactoryInfo
null
if not knownpublic javax.persistence.EntityManagerFactory getObject()
getObject
in interface org.springframework.beans.factory.FactoryBean<javax.persistence.EntityManagerFactory>
public java.lang.Class<? extends javax.persistence.EntityManagerFactory> getObjectType()
getObjectType
in interface org.springframework.beans.factory.FactoryBean<javax.persistence.EntityManagerFactory>
public boolean isSingleton()
isSingleton
in interface org.springframework.beans.factory.FactoryBean<javax.persistence.EntityManagerFactory>
public void destroy()
destroy
in interface org.springframework.beans.factory.DisposableBean
protected java.lang.Object writeReplace() throws java.io.ObjectStreamException
java.io.ObjectStreamException
|
spring-orm | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |