Package org.springframework.orm.jpa.support

Class PersistenceAnnotationBeanPostProcessor

java.lang.Object
org.springframework.orm.jpa.support.PersistenceAnnotationBeanPostProcessor
All Implemented Interfaces:
Serializable, BeanRegistrationAotProcessor, Aware, BeanFactoryAware, BeanPostProcessor, DestructionAwareBeanPostProcessor, InstantiationAwareBeanPostProcessor, MergedBeanDefinitionPostProcessor, Ordered, PriorityOrdered
public class PersistenceAnnotationBeanPostProcessor extends Object implements InstantiationAwareBeanPostProcessor, DestructionAwareBeanPostProcessor, MergedBeanDefinitionPostProcessor, BeanRegistrationAotProcessor, PriorityOrdered, BeanFactoryAware, Serializable
BeanPostProcessor that processes PersistenceUnit and PersistenceContext annotations, for injection of the corresponding JPA resources EntityManagerFactory and EntityManager. Any such annotated fields or methods in any Spring-managed object will automatically be injected.

This post-processor will inject sub-interfaces of EntityManagerFactory and EntityManager if the annotated fields or methods are declared as such. The actual type will be verified early, with the exception of a shared ("transactional") EntityManager reference, where type mismatches might be detected as late as on the first actual invocation.

Note: In the present implementation, PersistenceAnnotationBeanPostProcessor only supports @PersistenceUnit and @PersistenceContext with the "unitName" attribute, or no attribute at all (for the default unit). If those annotations are present with the "name" attribute at the class level, they will simply be ignored, since those only serve as deployment hint (as per the Jakarta EE specification).

This post-processor can either obtain EntityManagerFactory beans defined in the Spring application context (the default), or obtain EntityManagerFactory references from JNDI ("persistence unit references"). In the bean case, the persistence unit name will be matched against the actual deployed unit, with the bean name used as fallback unit name if no deployed name found. Typically, Spring's LocalContainerEntityManagerFactoryBean will be used for setting up such EntityManagerFactory beans. Alternatively, such beans may also be obtained from JNDI, e.g. using the jee:jndi-lookup XML configuration element (with the bean name matching the requested unit name). In both cases, the post-processor definition will look as simple as this: 

 <bean class="org.springframework.orm.jpa.support.PersistenceAnnotationBeanPostProcessor"/>
In the JNDI case, specify the corresponding JNDI names in this post-processor's "persistenceUnits" map, typically with matching persistence-unit-ref entries in the Jakarta EE deployment descriptor. By default, those names are considered as resource references (according to the Jakarta EE resource-ref convention), located underneath the "java:comp/env/" namespace. For example: 
 <bean class="org.springframework.orm.jpa.support.PersistenceAnnotationBeanPostProcessor">
   <property name="persistenceUnits">
     <map/gt;
       <entry key="unit1" value="persistence/unit1"/>
       <entry key="unit2" value="persistence/unit2"/>
     </map/gt;
   </property>
 </bean>
In this case, the specified persistence units will always be resolved in JNDI rather than as Spring-defined beans. The entire persistence unit deployment, including the weaving of persistent classes, is then up to the Jakarta EE server. Persistence contexts (i.e. EntityManager references) will be built based on those server-provided EntityManagerFactory references, using Spring's own transaction synchronization facilities for transactional EntityManager handling (typically with Spring's @Transactional annotation for demarcation and JtaTransactionManager as backend).

If you prefer the Jakarta EE server's own EntityManager handling, specify entries in this post-processor's "persistenceContexts" map (or "extendedPersistenceContexts" map, typically with matching persistence-context-ref entries in the Jakarta EE deployment descriptor. For example: 

 <bean class="org.springframework.orm.jpa.support.PersistenceAnnotationBeanPostProcessor">
   <property name="persistenceContexts">
     <map/gt;
       <entry key="unit1" value="persistence/context1"/>
       <entry key="unit2" value="persistence/context2"/>
     </map/gt;
   </property>
 </bean>
If the application only obtains EntityManager references in the first place, this is all you need to specify. If you need EntityManagerFactory references as well, specify entries for both "persistenceUnits" and "persistenceContexts", pointing to matching JNDI locations.

NOTE: In general, do not inject EXTENDED EntityManagers into STATELESS beans, i.e. do not use @PersistenceContext with type EXTENDED in Spring beans defined with scope 'singleton' (Spring's default scope). Extended EntityManagers are not thread-safe, hence they must not be used in concurrently accessed beans (which Spring-managed singletons usually are).

Note: A default PersistenceAnnotationBeanPostProcessor will be registered by the "context:annotation-config" and "context:component-scan" XML tags. Remove or turn off the default annotation configuration there if you intend to specify a custom PersistenceAnnotationBeanPostProcessor bean definition.

Since:
2.0
Author:
Rod Johnson, Juergen Hoeller, Stephane Nicoll, Phillip Webb
See Also:

  • Constructor Details

    • PersistenceAnnotationBeanPostProcessor

      public PersistenceAnnotationBeanPostProcessor()

  • Method Details

    • setJndiTemplate

      public void setJndiTemplate(Object jndiTemplate)
      Set the JNDI template to use for JNDI lookups.
      See Also:

    • setJndiEnvironment

      public void setJndiEnvironment(Properties jndiEnvironment)
      Set the JNDI environment to use for JNDI lookups.
      See Also:

    • setResourceRef

      public void setResourceRef(boolean resourceRef)
      Set whether the lookup occurs in a Jakarta EE container, i.e. if the prefix "java:comp/env/" needs to be added if the JNDI name doesn't already contain it. PersistenceAnnotationBeanPostProcessor's default is "true".
      See Also:

    • setPersistenceUnits

      public void setPersistenceUnits(Map<String,String> persistenceUnits)
      Specify the persistence units for EntityManagerFactory lookups, as a Map from persistence unit name to persistence unit JNDI name (which needs to resolve to an EntityManagerFactory instance).

      JNDI names specified here should refer to persistence-unit-ref entries in the Jakarta EE deployment descriptor, matching the target persistence unit.

      In case of no unit name specified in the annotation, the specified value for the default persistence unit will be taken (by default, the value mapped to the empty String), or simply the single persistence unit if there is only one.

      This is mainly intended for use in a Jakarta EE environment, with all lookup driven by the standard JPA annotations, and all EntityManagerFactory references obtained from JNDI. No separate EntityManagerFactory bean definitions are necessary in such a scenario.

      If no corresponding "persistenceContexts"/"extendedPersistenceContexts" are specified, @PersistenceContext will be resolved to EntityManagers built on top of the EntityManagerFactory defined here. Note that those will be Spring-managed EntityManagers, which implement transaction synchronization based on Spring's facilities. If you prefer the Jakarta EE server's own EntityManager handling, specify corresponding "persistenceContexts"/"extendedPersistenceContexts".

    • setPersistenceContexts

      public void setPersistenceContexts(Map<String,String> persistenceContexts)
      Specify the transactional persistence contexts for EntityManager lookups, as a Map from persistence unit name to persistence context JNDI name (which needs to resolve to an EntityManager instance).

      JNDI names specified here should refer to persistence-context-ref entries in the Jakarta EE deployment descriptors, matching the target persistence unit and being set up with persistence context type Transaction.

      In case of no unit name specified in the annotation, the specified value for the default persistence unit will be taken (by default, the value mapped to the empty String), or simply the single persistence unit if there is only one.

      This is mainly intended for use in a Jakarta EE environment, with all lookup driven by the standard JPA annotations, and all EntityManager references obtained from JNDI. No separate EntityManagerFactory bean definitions are necessary in such a scenario, and all EntityManager handling is done by the Jakarta EE server itself.

    • setExtendedPersistenceContexts

      public void setExtendedPersistenceContexts(Map<String,String> extendedPersistenceContexts)
      Specify the extended persistence contexts for EntityManager lookups, as a Map from persistence unit name to persistence context JNDI name (which needs to resolve to an EntityManager instance).

      JNDI names specified here should refer to persistence-context-ref entries in the Jakarta EE deployment descriptors, matching the target persistence unit and being set up with persistence context type Extended.

      In case of no unit name specified in the annotation, the specified value for the default persistence unit will be taken (by default, the value mapped to the empty String), or simply the single persistence unit if there is only one.

      This is mainly intended for use in a Jakarta EE environment, with all lookup driven by the standard JPA annotations, and all EntityManager references obtained from JNDI. No separate EntityManagerFactory bean definitions are necessary in such a scenario, and all EntityManager handling is done by the Jakarta EE server itself.

    • setDefaultPersistenceUnitName

      public void setDefaultPersistenceUnitName(@Nullable String unitName)
      Specify the default persistence unit name, to be used in case of no unit name specified in an @PersistenceUnit / @PersistenceContext annotation.

      This is mainly intended for lookups in the application context, indicating the target persistence unit name (typically matching the bean name), but also applies to lookups in the "persistenceUnits" / "persistenceContexts" / "extendedPersistenceContexts" map, avoiding the need for duplicated mappings for the empty String there.

      Default is to check for a single EntityManagerFactory bean in the Spring application context, if any. If there are multiple such factories, either specify this default persistence unit name or explicitly refer to named persistence units in your annotations.

    • setOrder

      public void setOrder(int order)

    • getOrder

      public int getOrder()
      Description copied from interface: Ordered
      Get the order value of this object.

      Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet load-on-startup values).

      Same order values will result in arbitrary sort positions for the affected objects.

      Specified by:
      getOrder in interface Ordered
      Returns:
      the order value
      See Also:

    • setBeanFactory

      public void setBeanFactory(BeanFactory beanFactory)
      Description copied from interface: BeanFactoryAware
      Callback that supplies the owning factory to a bean instance.

      Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean.afterPropertiesSet() or a custom init-method.

      Specified by:
      setBeanFactory in interface BeanFactoryAware
      Parameters:
      beanFactory - owning BeanFactory (never null). The bean can immediately call methods on the factory.
      See Also:

    • postProcessMergedBeanDefinition

      public void postProcessMergedBeanDefinition(RootBeanDefinition beanDefinition, Class<?> beanType, String beanName)
      Description copied from interface: MergedBeanDefinitionPostProcessor
      Post-process the given merged bean definition for the specified bean.
      Specified by:
      postProcessMergedBeanDefinition in interface MergedBeanDefinitionPostProcessor
      Parameters:
      beanDefinition - the merged bean definition for the bean
      beanType - the actual type of the managed bean instance
      beanName - the name of the bean
      See Also:

    • processAheadOfTime

      public BeanRegistrationAotContribution processAheadOfTime(RegisteredBean registeredBean)
      Description copied from interface: BeanRegistrationAotProcessor
      Process the given RegisteredBean instance ahead-of-time and return a contribution or null.

      Processors are free to use any techniques they like to analyze the given instance. Most typically use reflection to find fields or methods to use in the contribution. Contributions typically generate source code or resource files that can be used when the AOT optimized application runs.

      If the given instance isn't relevant to the processor, it should return a null contribution.

      Specified by:
      processAheadOfTime in interface BeanRegistrationAotProcessor
      Parameters:
      registeredBean - the registered bean to process
      Returns:
      a BeanRegistrationAotContribution or null

    • resetBeanDefinition

      public void resetBeanDefinition(String beanName)
      Description copied from interface: MergedBeanDefinitionPostProcessor
      A notification that the bean definition for the specified name has been reset, and that this post-processor should clear any metadata for the affected bean.

      The default implementation is empty.

      Specified by:
      resetBeanDefinition in interface MergedBeanDefinitionPostProcessor
      Parameters:
      beanName - the name of the bean
      See Also:

    • postProcessProperties

      public PropertyValues postProcessProperties(PropertyValues pvs, Object bean, String beanName)
      Description copied from interface: InstantiationAwareBeanPostProcessor
      Post-process the given property values before the factory applies them to the given bean.

      The default implementation returns the given pvs as-is.

      Specified by:
      postProcessProperties in interface InstantiationAwareBeanPostProcessor
      Parameters:
      pvs - the property values that the factory is about to apply (never null)
      bean - the bean instance created, but whose properties have not yet been set
      beanName - the name of the bean
      Returns:
      the actual property values to apply to the given bean (can be the passed-in PropertyValues instance), or null to skip property population

    • postProcessBeforeDestruction

      public void postProcessBeforeDestruction(Object bean, String beanName)
      Description copied from interface: DestructionAwareBeanPostProcessor
      Apply this BeanPostProcessor to the given bean instance before its destruction, e.g. invoking custom destruction callbacks.

      Like DisposableBean's destroy and a custom destroy method, this callback will only apply to beans which the container fully manages the lifecycle for. This is usually the case for singletons and scoped beans.

      Specified by:
      postProcessBeforeDestruction in interface DestructionAwareBeanPostProcessor
      Parameters:
      bean - the bean instance to be destroyed
      beanName - the name of the bean
      See Also:

    • requiresDestruction

      public boolean requiresDestruction(Object bean)
      Description copied from interface: DestructionAwareBeanPostProcessor
      Determine whether the given bean instance requires destruction by this post-processor.

      The default implementation returns true. If a pre-5 implementation of DestructionAwareBeanPostProcessor does not provide a concrete implementation of this method, Spring silently assumes true as well.

      Specified by:
      requiresDestruction in interface DestructionAwareBeanPostProcessor
      Parameters:
      bean - the bean instance to check
      Returns:
      true if DestructionAwareBeanPostProcessor.postProcessBeforeDestruction(java.lang.Object, java.lang.String) is supposed to be called for this bean instance eventually, or false if not needed

    • getPersistenceUnit

      @Nullable protected EntityManagerFactory getPersistenceUnit(@Nullable String unitName)
      Return a specified persistence unit for the given unit name, as defined through the "persistenceUnits" map.
      Parameters:
      unitName - the name of the persistence unit
      Returns:
      the corresponding EntityManagerFactory, or null if none found
      See Also:

    • getPersistenceContext

      @Nullable protected EntityManager getPersistenceContext(@Nullable String unitName, boolean extended)
      Return a specified persistence context for the given unit name, as defined through the "persistenceContexts" (or "extendedPersistenceContexts") map.
      Parameters:
      unitName - the name of the persistence unit
      extended - whether to obtain an extended persistence context
      Returns:
      the corresponding EntityManager, or null if none found
      See Also:

    • findEntityManagerFactory

      protected EntityManagerFactory findEntityManagerFactory(@Nullable String unitName, @Nullable String requestingBeanName) throws NoSuchBeanDefinitionException
      Find an EntityManagerFactory with the given name in the current Spring application context, falling back to a single default EntityManagerFactory (if any) in case of no unit name specified.
      Parameters:
      unitName - the name of the persistence unit (may be null or empty)
      requestingBeanName - the name of the requesting bean
      Returns:
      the EntityManagerFactory
      Throws:
      NoSuchBeanDefinitionException - if there is no such EntityManagerFactory in the context

    • findNamedEntityManagerFactory

      protected EntityManagerFactory findNamedEntityManagerFactory(String unitName, @Nullable String requestingBeanName) throws NoSuchBeanDefinitionException
      Find an EntityManagerFactory with the given name in the current Spring application context.
      Parameters:
      unitName - the name of the persistence unit (never empty)
      requestingBeanName - the name of the requesting bean
      Returns:
      the EntityManagerFactory
      Throws:
      NoSuchBeanDefinitionException - if there is no such EntityManagerFactory in the context

    • findDefaultEntityManagerFactory

      protected EntityManagerFactory findDefaultEntityManagerFactory(@Nullable String requestingBeanName) throws NoSuchBeanDefinitionException
      Find a single default EntityManagerFactory in the Spring application context.
      Returns:
      the default EntityManagerFactory
      Throws:
      NoSuchBeanDefinitionException - if there is no single EntityManagerFactory in the context

    • lookup

      protected <T> T lookup(String jndiName, Class<T> requiredType) throws Exception
      Perform a JNDI lookup for the given resource by name.

      Called for EntityManagerFactory and EntityManager lookup when JNDI names are mapped for specific persistence units.

      Parameters:
      jndiName - the JNDI name to look up
      requiredType - the required type of the object
      Returns:
      the obtained object
      Throws:
      Exception - if the JNDI lookup failed