Package org.springframework.orm.jpa

Class AbstractEntityManagerFactoryBean

java.lang.Object
org.springframework.orm.jpa.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
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
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 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 Details

    • logger

      protected final org.apache.commons.logging.Log logger
      Logger 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).
      See Also:

    • setPersistenceProvider

      public void setPersistenceProvider(@Nullable PersistenceProvider persistenceProvider)
      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).
      See Also:

    • getPersistenceProvider

      @Nullable public PersistenceProvider getPersistenceProvider()
      Description copied from interface: EntityManagerFactoryInfo
      Return the underlying PersistenceProvider that the underlying EntityManagerFactory was created with.
      Specified by:
      getPersistenceProvider in interface EntityManagerFactoryInfo
      Returns:
      the PersistenceProvider used to create this EntityManagerFactory, or null if the standard JPA provider autodetection process was used to configure the EntityManagerFactory

    • setPersistenceUnitName

      public void setPersistenceUnitName(@Nullable String persistenceUnitName)
      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.

      See Also:

    • getPersistenceUnitName

      @Nullable public String getPersistenceUnitName()
      Description copied from interface: EntityManagerFactoryInfo
      Return the name of the persistence unit used to create this EntityManagerFactory, or 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().

      Specified by:
      getPersistenceUnitName in interface EntityManagerFactoryInfo
      See Also:

    • setJpaProperties

      public void setJpaProperties(Properties jpaProperties)
      Specify JPA properties, to be passed into Persistence.createEntityManagerFactory (if any).

      Can be populated with a String "value" (parsed via PropertiesEditor) or a "props" element in XML bean definitions.

      See Also:

    • setJpaPropertyMap

      public void setJpaPropertyMap(@Nullable Map<String,?> jpaProperties)
      Specify JPA properties as a Map, to be passed into Persistence.createEntityManagerFactory (if any).

      Can be populated with a "map" or "props" element in XML bean definitions.

      See Also:

    • getJpaPropertyMap

      public 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.

      Useful for specifying entries directly, for example via jpaPropertyMap[myKey].

    • setEntityManagerFactoryInterface

      public void setEntityManagerFactoryInterface(Class<? extends EntityManagerFactory> emfInterface)
      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.

      See Also:

    • setEntityManagerInterface

      public void setEntityManagerInterface(@Nullable Class<? extends EntityManager> emInterface)
      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.

      See Also:

    • getEntityManagerInterface

      @Nullable public Class<? extends EntityManager> 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 target EntityManager instance or simply defaulting to jakarta.persistence.EntityManager.

      Specified by:
      getEntityManagerInterface in interface EntityManagerFactoryInfo

    • setJpaDialect

      public void setJpaDialect(@Nullable JpaDialect jpaDialect)
      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

      @Nullable public JpaDialect getJpaDialect()
      Description copied from interface: EntityManagerFactoryInfo
      Return the vendor-specific JpaDialect implementation for this EntityManagerFactory, or null if not known.
      Specified by:
      getJpaDialect in interface EntityManagerFactoryInfo

    • setJpaVendorAdapter

      public void setJpaVendorAdapter(@Nullable JpaVendorAdapter jpaVendorAdapter)
      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

      @Nullable public JpaVendorAdapter getJpaVendorAdapter()
      Return the JpaVendorAdapter implementation for this EntityManagerFactory, or null if not known.

    • setEntityManagerInitializer

      public void setEntityManagerInitializer(Consumer<EntityManager> entityManagerInitializer)
      Specify a callback for customizing every EntityManager created by the exposed EntityManagerFactory.

      This is an alternative to a JpaVendorAdapter-level postProcessEntityManager implementation, enabling convenient customizations for application purposes, e.g. setting Hibernate filters.

      Since:
      5.3
      See Also:

    • setBootstrapExecutor

      public void setBootstrapExecutor(@Nullable org.springframework.core.task.AsyncTaskExecutor bootstrapExecutor)
      Specify an asynchronous executor for background bootstrapping, e.g. a SimpleAsyncTaskExecutor.

      EntityManagerFactory initialization will then switch into background bootstrap mode, with a EntityManagerFactory 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 a EntityManagerFactory method will then block until the JPA provider's bootstrapping completed, if not ready by then. For maximum benefit, make sure to avoid early EntityManagerFactory 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

      public void setBeanClassLoader(ClassLoader classLoader)
      Specified by:
      setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware

    • getBeanClassLoader

      public ClassLoader 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 interface EntityManagerFactoryInfo

    • setBeanFactory

      public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
      Specified by:
      setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware

    • setBeanName

      public void setBeanName(String name)
      Specified by:
      setBeanName in interface org.springframework.beans.factory.BeanNameAware

    • afterPropertiesSet

      public void afterPropertiesSet() throws PersistenceException
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
      Throws:
      PersistenceException

    • createEntityManagerFactoryProxy

      protected EntityManagerFactory createEntityManagerFactoryProxy(@Nullable EntityManagerFactory emf)
      Create a proxy for the given EntityManagerFactory. We do this to be able to return a transaction-aware proxy for an application-managed EntityManager.
      Parameters:
      emf - the EntityManagerFactory as returned by the persistence provider, if initialized already
      Returns:
      the EntityManagerFactory proxy

    • createNativeEntityManagerFactory

      protected abstract EntityManagerFactory createNativeEntityManagerFactory() throws PersistenceException
      Subclasses must implement this method to create the EntityManagerFactory that will be returned by the getObject() 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 interface org.springframework.dao.support.PersistenceExceptionTranslator
      See Also:

    • getNativeEntityManagerFactory

      public EntityManagerFactory getNativeEntityManagerFactory()
      Description copied from interface: EntityManagerFactoryInfo
      Return the raw underlying EntityManagerFactory.
      Specified by:
      getNativeEntityManagerFactory in interface EntityManagerFactoryInfo
      Returns:
      the unadorned EntityManagerFactory (never null)

    • createNativeEntityManager

      public EntityManager createNativeEntityManager(@Nullable Map<?,?> properties)
      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 underlying native EntityManagerFactory, taking JpaVendorAdapter.postProcessEntityManager(EntityManager) into account.

      Specified by:
      createNativeEntityManager in interface EntityManagerFactoryInfo
      See Also:

    • postProcessEntityManager

      protected void postProcessEntityManager(EntityManager rawEntityManager)
      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

      @Nullable public PersistenceUnitInfo 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 interface EntityManagerFactoryInfo
      Returns:
      the PersistenceUnitInfo used to create this EntityManagerFactory, or null if the in-container contract was not used to configure the EntityManagerFactory

    • getDataSource

      @Nullable public DataSource getDataSource()
      Description copied from interface: EntityManagerFactoryInfo
      Return the JDBC DataSource that this EntityManagerFactory obtains its JDBC Connections from.
      Specified by:
      getDataSource in interface EntityManagerFactoryInfo
      Returns:
      the JDBC DataSource, or null if not known

    • getObject

      @Nullable public EntityManagerFactory getObject()
      Return the singleton EntityManagerFactory.
      Specified by:
      getObject in interface org.springframework.beans.factory.FactoryBean<EntityManagerFactory>

    • getObjectType

      public Class<? extends EntityManagerFactory> getObjectType()
      Specified by:
      getObjectType in interface org.springframework.beans.factory.FactoryBean<EntityManagerFactory>

    • isSingleton

      public boolean isSingleton()
      Specified by:
      isSingleton in interface org.springframework.beans.factory.FactoryBean<EntityManagerFactory>

    • destroy

      public void destroy()
      Close the EntityManagerFactory on bean factory shutdown.
      Specified by:
      destroy in interface org.springframework.beans.factory.DisposableBean

    • writeReplace

      protected Object writeReplace() throws ObjectStreamException
      Throws:
      ObjectStreamException