Class PersistenceAnnotationBeanPostProcessor
- All Implemented Interfaces:
Serializable
,BeanRegistrationAotProcessor
,Aware
,BeanFactoryAware
,BeanPostProcessor
,DestructionAwareBeanPostProcessor
,InstantiationAwareBeanPostProcessor
,MergedBeanDefinitionPostProcessor
,Ordered
,PriorityOrdered
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:
-
Field Summary
Fields inherited from interface org.springframework.beans.factory.aot.BeanRegistrationAotProcessor
IGNORE_REGISTRATION_ATTRIBUTE
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected EntityManagerFactory
findDefaultEntityManagerFactory
(String requestingBeanName) Find a single default EntityManagerFactory in the Spring application context.protected EntityManagerFactory
findEntityManagerFactory
(String unitName, String requestingBeanName) 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.protected EntityManagerFactory
findNamedEntityManagerFactory
(String unitName, String requestingBeanName) Find an EntityManagerFactory with the given name in the current Spring application context.int
getOrder()
Get the order value of this object.protected EntityManager
getPersistenceContext
(String unitName, boolean extended) Return a specified persistence context for the given unit name, as defined through the "persistenceContexts" (or "extendedPersistenceContexts") map.protected EntityManagerFactory
getPersistenceUnit
(String unitName) Return a specified persistence unit for the given unit name, as defined through the "persistenceUnits" map.protected <T> T
Perform a JNDI lookup for the given resource by name.void
postProcessBeforeDestruction
(Object bean, String beanName) Apply this BeanPostProcessor to the given bean instance before its destruction, e.g.void
postProcessMergedBeanDefinition
(RootBeanDefinition beanDefinition, Class<?> beanType, String beanName) Post-process the given merged bean definition for the specified bean.postProcessProperties
(PropertyValues pvs, Object bean, String beanName) Post-process the given property values before the factory applies them to the given bean.processAheadOfTime
(RegisteredBean registeredBean) Process the givenRegisteredBean
instance ahead-of-time and return a contribution ornull
.boolean
requiresDestruction
(Object bean) Determine whether the given bean instance requires destruction by this post-processor.void
resetBeanDefinition
(String beanName) 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.void
setBeanFactory
(BeanFactory beanFactory) Callback that supplies the owning factory to a bean instance.void
setDefaultPersistenceUnitName
(String unitName) Specify the default persistence unit name, to be used in case of no unit name specified in an@PersistenceUnit
/@PersistenceContext
annotation.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).void
setJndiEnvironment
(Properties jndiEnvironment) Set the JNDI environment to use for JNDI lookups.void
setJndiTemplate
(Object jndiTemplate) Set the JNDI template to use for JNDI lookups.void
setOrder
(int order) 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).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).void
setResourceRef
(boolean resourceRef) Set whether the lookup occurs in a Jakarta EE container, i.e.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.beans.factory.config.BeanPostProcessor
postProcessAfterInitialization, postProcessBeforeInitialization
Methods inherited from interface org.springframework.beans.factory.aot.BeanRegistrationAotProcessor
isBeanExcludedFromAotProcessing
Methods inherited from interface org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor
postProcessAfterInstantiation, postProcessBeforeInstantiation
-
Constructor Details
-
PersistenceAnnotationBeanPostProcessor
public PersistenceAnnotationBeanPostProcessor()
-
-
Method Details
-
setJndiTemplate
Set the JNDI template to use for JNDI lookups. -
setJndiEnvironment
Set the JNDI environment to use for JNDI lookups. -
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". -
setPersistenceUnits
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
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 typeTransaction
.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
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 typeExtended
.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
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.
-
setBeanFactory
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 interfaceBeanFactoryAware
- Parameters:
beanFactory
- owning BeanFactory (nevernull
). 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 interfaceMergedBeanDefinitionPostProcessor
- Parameters:
beanDefinition
- the merged bean definition for the beanbeanType
- the actual type of the managed bean instancebeanName
- the name of the bean- See Also:
-
resetBeanDefinition
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 interfaceMergedBeanDefinitionPostProcessor
- Parameters:
beanName
- the name of the bean- See Also:
-
processAheadOfTime
Description copied from interface:BeanRegistrationAotProcessor
Process the givenRegisteredBean
instance ahead-of-time and return a contribution ornull
.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 interfaceBeanRegistrationAotProcessor
- Parameters:
registeredBean
- the registered bean to process- Returns:
- a
BeanRegistrationAotContribution
ornull
-
postProcessProperties
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 interfaceInstantiationAwareBeanPostProcessor
- Parameters:
pvs
- the property values that the factory is about to apply (nevernull
)bean
- the bean instance created, but whose properties have not yet been setbeanName
- 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
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 interfaceDestructionAwareBeanPostProcessor
- Parameters:
bean
- the bean instance to be destroyedbeanName
- the name of the bean- See Also:
-
requiresDestruction
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 ofDestructionAwareBeanPostProcessor
does not provide a concrete implementation of this method, Spring silently assumestrue
as well.- Specified by:
requiresDestruction
in interfaceDestructionAwareBeanPostProcessor
- Parameters:
bean
- the bean instance to check- Returns:
true
ifDestructionAwareBeanPostProcessor.postProcessBeforeDestruction(java.lang.Object, java.lang.String)
is supposed to be called for this bean instance eventually, orfalse
if not needed
-
getPersistenceUnit
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 unitextended
- 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 benull
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
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 uprequiredType
- the required type of the object- Returns:
- the obtained object
- Throws:
Exception
- if the JNDI lookup failed
-