public class PersistenceAnnotationBeanPostProcessor extends java.lang.Object implements InstantiationAwareBeanPostProcessor, DestructionAwareBeanPostProcessor, MergedBeanDefinitionPostProcessor, PriorityOrdered, BeanFactoryAware, java.io.Serializable
javax.persistence.PersistenceUnit
and javax.persistence.PersistenceContext
annotations, for injection of
the corresponding JPA resources javax.persistence.EntityManagerFactory
and javax.persistence.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 Java 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 Java EE deployment descriptor.
By default, those names are considered as resource references (according to the
Java 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 Java 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 Java 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
Java 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.
javax.persistence.PersistenceUnit
,
javax.persistence.PersistenceContext
,
Serialized FormModifier and Type | Class and Description |
---|---|
private class |
PersistenceAnnotationBeanPostProcessor.LocatorDelegate
Separate inner class to isolate the JNDI API dependency
(for compatibility with Google App Engine's API white list).
|
private class |
PersistenceAnnotationBeanPostProcessor.PersistenceElement
Class representing injection information about an annotated field
or setter method.
|
Modifier and Type | Field and Description |
---|---|
private ListableBeanFactory |
beanFactory |
private java.lang.String |
defaultPersistenceUnitName |
private java.util.Map<java.lang.Object,EntityManager> |
extendedEntityManagersToClose |
private java.util.Map<java.lang.String,java.lang.String> |
extendedPersistenceContexts |
private java.util.Map<java.lang.String,InjectionMetadata> |
injectionMetadataCache |
private java.lang.Object |
jndiEnvironment |
private int |
order |
private java.util.Map<java.lang.String,java.lang.String> |
persistenceContexts |
private java.util.Map<java.lang.String,java.lang.String> |
persistenceUnits |
private boolean |
resourceRef |
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Constructor and Description |
---|
PersistenceAnnotationBeanPostProcessor() |
Modifier and Type | Method and Description |
---|---|
private InjectionMetadata |
buildPersistenceMetadata(java.lang.Class<?> clazz) |
protected EntityManagerFactory |
findDefaultEntityManagerFactory(java.lang.String requestingBeanName)
Find a single default EntityManagerFactory in the Spring application context.
|
protected EntityManagerFactory |
findEntityManagerFactory(java.lang.String unitName,
java.lang.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(java.lang.String unitName,
java.lang.String requestingBeanName)
Find an EntityManagerFactory with the given name in the current
Spring application context.
|
private InjectionMetadata |
findPersistenceMetadata(java.lang.String beanName,
java.lang.Class<?> clazz,
PropertyValues pvs) |
int |
getOrder()
Get the order value of this object.
|
protected EntityManager |
getPersistenceContext(java.lang.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(java.lang.String unitName)
Return a specified persistence unit for the given unit name,
as defined through the "persistenceUnits" map.
|
protected <T> T |
lookup(java.lang.String jndiName,
java.lang.Class<T> requiredType)
Perform a JNDI lookup for the given resource by name.
|
java.lang.Object |
postProcessAfterInitialization(java.lang.Object bean,
java.lang.String beanName)
Apply this BeanPostProcessor to the given new bean instance after any bean
initialization callbacks (like InitializingBean's
afterPropertiesSet
or a custom init-method). |
boolean |
postProcessAfterInstantiation(java.lang.Object bean,
java.lang.String beanName)
Perform operations after the bean has been instantiated, via a constructor or factory method,
but before Spring property population (from explicit properties or autowiring) occurs.
|
void |
postProcessBeforeDestruction(java.lang.Object bean,
java.lang.String beanName)
Apply this BeanPostProcessor to the given bean instance before
its destruction.
|
java.lang.Object |
postProcessBeforeInitialization(java.lang.Object bean,
java.lang.String beanName)
Apply this BeanPostProcessor to the given new bean instance before any bean
initialization callbacks (like InitializingBean's
afterPropertiesSet
or a custom init-method). |
java.lang.Object |
postProcessBeforeInstantiation(java.lang.Class<?> beanClass,
java.lang.String beanName)
Apply this BeanPostProcessor before the target bean gets instantiated.
|
void |
postProcessMergedBeanDefinition(RootBeanDefinition beanDefinition,
java.lang.Class<?> beanType,
java.lang.String beanName)
Post-process the given merged bean definition for the specified bean.
|
PropertyValues |
postProcessPropertyValues(PropertyValues pvs,
java.beans.PropertyDescriptor[] pds,
java.lang.Object bean,
java.lang.String beanName)
Post-process the given property values before the factory applies them
to the given bean.
|
boolean |
requiresDestruction(java.lang.Object bean)
Determine whether the given bean instance requires destruction by this
post-processor.
|
void |
setBeanFactory(BeanFactory beanFactory)
Callback that supplies the owning factory to a bean instance.
|
void |
setDefaultPersistenceUnitName(java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Properties jndiEnvironment)
Set the JNDI environment to use for JNDI lookups.
|
void |
setJndiTemplate(java.lang.Object jndiTemplate)
Set the JNDI template to use for JNDI lookups.
|
void |
setOrder(int order) |
void |
setPersistenceContexts(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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 Java EE container, i.e.
|
@Nullable private java.lang.Object jndiEnvironment
private boolean resourceRef
@Nullable private transient java.util.Map<java.lang.String,java.lang.String> persistenceUnits
@Nullable private transient java.util.Map<java.lang.String,java.lang.String> persistenceContexts
@Nullable private transient java.util.Map<java.lang.String,java.lang.String> extendedPersistenceContexts
private transient java.lang.String defaultPersistenceUnitName
private int order
@Nullable private transient ListableBeanFactory beanFactory
private final transient java.util.Map<java.lang.String,InjectionMetadata> injectionMetadataCache
private final java.util.Map<java.lang.Object,EntityManager> extendedEntityManagersToClose
public PersistenceAnnotationBeanPostProcessor()
public void setJndiTemplate(java.lang.Object jndiTemplate)
public void setJndiEnvironment(java.util.Properties jndiEnvironment)
public void setResourceRef(boolean resourceRef)
public void setPersistenceUnits(java.util.Map<java.lang.String,java.lang.String> persistenceUnits)
JNDI names specified here should refer to persistence-unit-ref
entries in the Java 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 Java 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 Java EE server's own EntityManager handling,
specify corresponding "persistenceContexts"/"extendedPersistenceContexts".
public void setPersistenceContexts(java.util.Map<java.lang.String,java.lang.String> persistenceContexts)
JNDI names specified here should refer to persistence-context-ref
entries in the Java 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 Java 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 Java EE server itself.
public void setExtendedPersistenceContexts(java.util.Map<java.lang.String,java.lang.String> extendedPersistenceContexts)
JNDI names specified here should refer to persistence-context-ref
entries in the Java 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 Java 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 Java EE server itself.
public void setDefaultPersistenceUnitName(@Nullable java.lang.String unitName)
@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.
public void setOrder(int order)
public int getOrder()
Ordered
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.
getOrder
in interface Ordered
Ordered.HIGHEST_PRECEDENCE
,
Ordered.LOWEST_PRECEDENCE
public void setBeanFactory(BeanFactory beanFactory)
BeanFactoryAware
Invoked after the population of normal bean properties
but before an initialization callback such as
InitializingBean.afterPropertiesSet()
or a custom init-method.
setBeanFactory
in interface BeanFactoryAware
beanFactory
- owning BeanFactory (never null
).
The bean can immediately call methods on the factory.BeanInitializationException
public void postProcessMergedBeanDefinition(RootBeanDefinition beanDefinition, java.lang.Class<?> beanType, java.lang.String beanName)
MergedBeanDefinitionPostProcessor
postProcessMergedBeanDefinition
in interface MergedBeanDefinitionPostProcessor
beanDefinition
- the merged bean definition for the beanbeanType
- the actual type of the managed bean instancebeanName
- the name of the beanpublic java.lang.Object postProcessBeforeInstantiation(java.lang.Class<?> beanClass, java.lang.String beanName)
InstantiationAwareBeanPostProcessor
If a non-null object is returned by this method, the bean creation process
will be short-circuited. The only further processing applied is the
BeanPostProcessor.postProcessAfterInitialization(java.lang.Object, java.lang.String)
callback from the configured
BeanPostProcessors
.
This callback will only be applied to bean definitions with a bean class. In particular, it will not be applied to beans with a factory method.
Post-processors may implement the extended
SmartInstantiationAwareBeanPostProcessor
interface in order
to predict the type of the bean object that they are going to return here.
The default implementation returns null
.
postProcessBeforeInstantiation
in interface InstantiationAwareBeanPostProcessor
beanClass
- the class of the bean to be instantiatedbeanName
- the name of the beannull
to proceed with default instantiationInstantiationAwareBeanPostProcessor.postProcessAfterInstantiation(java.lang.Object, java.lang.String)
,
AbstractBeanDefinition.hasBeanClass()
public boolean postProcessAfterInstantiation(java.lang.Object bean, java.lang.String beanName)
InstantiationAwareBeanPostProcessor
This is the ideal callback for performing custom field injection on the given bean instance, right before Spring's autowiring kicks in.
The default implementation returns true
.
postProcessAfterInstantiation
in interface InstantiationAwareBeanPostProcessor
bean
- the bean instance created, with properties not having been set yetbeanName
- the name of the beantrue
if properties should be set on the bean; false
if property population should be skipped. Normal implementations should return true
.
Returning false
will also prevent any subsequent InstantiationAwareBeanPostProcessor
instances being invoked on this bean instance.InstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation(java.lang.Class<?>, java.lang.String)
public PropertyValues postProcessPropertyValues(PropertyValues pvs, java.beans.PropertyDescriptor[] pds, java.lang.Object bean, java.lang.String beanName)
InstantiationAwareBeanPostProcessor
Also allows for replacing the property values to apply, typically through creating a new MutablePropertyValues instance based on the original PropertyValues, adding or removing specific values.
The default implementation returns the given pvs
as-is.
postProcessPropertyValues
in interface InstantiationAwareBeanPostProcessor
pvs
- the property values that the factory is about to apply (never null
)pds
- the relevant property descriptors for the target bean (with ignored
dependency types - which the factory handles specifically - already filtered out)bean
- the bean instance created, but whose properties have not yet been setbeanName
- the name of the beannull
to skip property populationMutablePropertyValues
public java.lang.Object postProcessBeforeInitialization(java.lang.Object bean, java.lang.String beanName)
BeanPostProcessor
afterPropertiesSet
or a custom init-method). The bean will already be populated with property values.
The returned bean instance may be a wrapper around the original.
The default implementation returns the given bean
as-is.
postProcessBeforeInitialization
in interface BeanPostProcessor
bean
- the new bean instancebeanName
- the name of the beannull
, no subsequent BeanPostProcessors will be invokedInitializingBean.afterPropertiesSet()
public java.lang.Object postProcessAfterInitialization(java.lang.Object bean, java.lang.String beanName)
BeanPostProcessor
afterPropertiesSet
or a custom init-method). The bean will already be populated with property values.
The returned bean instance may be a wrapper around the original.
In case of a FactoryBean, this callback will be invoked for both the FactoryBean
instance and the objects created by the FactoryBean (as of Spring 2.0). The
post-processor can decide whether to apply to either the FactoryBean or created
objects or both through corresponding bean instanceof FactoryBean
checks.
This callback will also be invoked after a short-circuiting triggered by a
InstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation(java.lang.Class<?>, java.lang.String)
method,
in contrast to all other BeanPostProcessor callbacks.
The default implementation returns the given bean
as-is.
postProcessAfterInitialization
in interface BeanPostProcessor
bean
- the new bean instancebeanName
- the name of the beannull
, no subsequent BeanPostProcessors will be invokedInitializingBean.afterPropertiesSet()
,
FactoryBean
public void postProcessBeforeDestruction(java.lang.Object bean, java.lang.String beanName)
DestructionAwareBeanPostProcessor
Like DisposableBean's destroy
and a custom destroy method,
this callback just applies to singleton beans in the factory (including
inner beans).
postProcessBeforeDestruction
in interface DestructionAwareBeanPostProcessor
bean
- the bean instance to be destroyedbeanName
- the name of the beanDisposableBean
,
AbstractBeanDefinition.setDestroyMethodName(java.lang.String)
public boolean requiresDestruction(java.lang.Object bean)
DestructionAwareBeanPostProcessor
NOTE: Even as a late addition, this method has been introduced on
DestructionAwareBeanPostProcessor
itself instead of on a SmartDABPP
subinterface. This allows existing DestructionAwareBeanPostProcessor
implementations to easily provide requiresDestruction
logic while
retaining compatibility with Spring <4.3, and it is also an easier onramp to
declaring requiresDestruction
as a Java 8 default method in Spring 5.
If an implementation of DestructionAwareBeanPostProcessor
does
not provide a concrete implementation of this method, Spring's invocation
mechanism silently assumes a method returning true
(the effective
default before 4.3, and the to-be-default in the Java 8 method in Spring 5).
requiresDestruction
in interface DestructionAwareBeanPostProcessor
bean
- the bean instance to checktrue
if DestructionAwareBeanPostProcessor.postProcessBeforeDestruction(java.lang.Object, java.lang.String)
is supposed to
be called for this bean instance eventually, or false
if not neededprivate InjectionMetadata findPersistenceMetadata(java.lang.String beanName, java.lang.Class<?> clazz, @Nullable PropertyValues pvs)
private InjectionMetadata buildPersistenceMetadata(java.lang.Class<?> clazz)
@Nullable protected EntityManagerFactory getPersistenceUnit(@Nullable java.lang.String unitName)
unitName
- the name of the persistence unitnull
if none foundsetPersistenceUnits(java.util.Map<java.lang.String, java.lang.String>)
@Nullable protected EntityManager getPersistenceContext(@Nullable java.lang.String unitName, boolean extended)
unitName
- the name of the persistence unitextended
- whether to obtain an extended persistence contextnull
if none foundsetPersistenceContexts(java.util.Map<java.lang.String, java.lang.String>)
,
setExtendedPersistenceContexts(java.util.Map<java.lang.String, java.lang.String>)
protected EntityManagerFactory findEntityManagerFactory(@Nullable java.lang.String unitName, @Nullable java.lang.String requestingBeanName) throws NoSuchBeanDefinitionException
unitName
- the name of the persistence unit (may be null
or empty)requestingBeanName
- the name of the requesting beanNoSuchBeanDefinitionException
- if there is no such EntityManagerFactory in the contextprotected EntityManagerFactory findNamedEntityManagerFactory(java.lang.String unitName, @Nullable java.lang.String requestingBeanName) throws NoSuchBeanDefinitionException
unitName
- the name of the persistence unit (never empty)requestingBeanName
- the name of the requesting beanNoSuchBeanDefinitionException
- if there is no such EntityManagerFactory in the contextprotected EntityManagerFactory findDefaultEntityManagerFactory(@Nullable java.lang.String requestingBeanName) throws NoSuchBeanDefinitionException
NoSuchBeanDefinitionException
- if there is no single EntityManagerFactory in the contextprotected <T> T lookup(java.lang.String jndiName, java.lang.Class<T> requiredType) throws java.lang.Exception
Called for EntityManagerFactory and EntityManager lookup when JNDI names are mapped for specific persistence units.
jndiName
- the JNDI name to look uprequiredType
- the required type of the objectjava.lang.Exception
- if the JNDI lookup failed