public class PersistenceAnnotationBeanPostProcessor extends Object implements org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor, org.springframework.beans.factory.config.DestructionAwareBeanPostProcessor, org.springframework.beans.factory.support.MergedBeanDefinitionPostProcessor, org.springframework.core.PriorityOrdered, org.springframework.beans.factory.BeanFactoryAware, Serializable
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 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.
PersistenceUnit
,
PersistenceContext
,
Serialized FormConstructor and Description |
---|
PersistenceAnnotationBeanPostProcessor() |
Modifier and Type | Method and Description |
---|---|
protected 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() |
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 |
lookup(String jndiName,
Class<T> requiredType)
Perform a JNDI lookup for the given resource by name.
|
Object |
postProcessAfterInitialization(Object bean,
String beanName) |
boolean |
postProcessAfterInstantiation(Object bean,
String beanName) |
void |
postProcessBeforeDestruction(Object bean,
String beanName) |
Object |
postProcessBeforeInitialization(Object bean,
String beanName) |
Object |
postProcessBeforeInstantiation(Class<?> beanClass,
String beanName) |
void |
postProcessMergedBeanDefinition(org.springframework.beans.factory.support.RootBeanDefinition beanDefinition,
Class<?> beanType,
String beanName) |
org.springframework.beans.PropertyValues |
postProcessPropertyValues(org.springframework.beans.PropertyValues pvs,
PropertyDescriptor[] pds,
Object bean,
String beanName) |
boolean |
requiresDestruction(Object bean) |
void |
setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) |
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 Java EE container, i.e.
|
public PersistenceAnnotationBeanPostProcessor()
public void setJndiTemplate(Object jndiTemplate)
JndiAccessor.setJndiTemplate(org.springframework.jndi.JndiTemplate)
public void setJndiEnvironment(Properties jndiEnvironment)
JndiAccessor.setJndiEnvironment(java.util.Properties)
public void setResourceRef(boolean resourceRef)
JndiLocatorSupport.setResourceRef(boolean)
public void setPersistenceUnits(Map<String,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(Map<String,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(Map<String,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 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()
getOrder
in interface org.springframework.core.Ordered
public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
setBeanFactory
in interface org.springframework.beans.factory.BeanFactoryAware
public void postProcessMergedBeanDefinition(org.springframework.beans.factory.support.RootBeanDefinition beanDefinition, Class<?> beanType, String beanName)
postProcessMergedBeanDefinition
in interface org.springframework.beans.factory.support.MergedBeanDefinitionPostProcessor
public Object postProcessBeforeInstantiation(Class<?> beanClass, String beanName)
postProcessBeforeInstantiation
in interface org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor
public boolean postProcessAfterInstantiation(Object bean, String beanName)
postProcessAfterInstantiation
in interface org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor
public org.springframework.beans.PropertyValues postProcessPropertyValues(org.springframework.beans.PropertyValues pvs, PropertyDescriptor[] pds, Object bean, String beanName)
postProcessPropertyValues
in interface org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor
public Object postProcessBeforeInitialization(Object bean, String beanName)
postProcessBeforeInitialization
in interface org.springframework.beans.factory.config.BeanPostProcessor
public Object postProcessAfterInitialization(Object bean, String beanName)
postProcessAfterInitialization
in interface org.springframework.beans.factory.config.BeanPostProcessor
public void postProcessBeforeDestruction(Object bean, String beanName)
postProcessBeforeDestruction
in interface org.springframework.beans.factory.config.DestructionAwareBeanPostProcessor
public boolean requiresDestruction(Object bean)
requiresDestruction
in interface org.springframework.beans.factory.config.DestructionAwareBeanPostProcessor
@Nullable protected EntityManagerFactory getPersistenceUnit(@Nullable 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 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 String unitName, @Nullable String requestingBeanName) throws org.springframework.beans.factory.NoSuchBeanDefinitionException
unitName
- the name of the persistence unit (may be null
or empty)requestingBeanName
- the name of the requesting beanorg.springframework.beans.factory.NoSuchBeanDefinitionException
- if there is no such EntityManagerFactory in the contextprotected EntityManagerFactory findNamedEntityManagerFactory(String unitName, @Nullable String requestingBeanName) throws org.springframework.beans.factory.NoSuchBeanDefinitionException
unitName
- the name of the persistence unit (never empty)requestingBeanName
- the name of the requesting beanorg.springframework.beans.factory.NoSuchBeanDefinitionException
- if there is no such EntityManagerFactory in the contextprotected EntityManagerFactory findDefaultEntityManagerFactory(@Nullable String requestingBeanName) throws org.springframework.beans.factory.NoSuchBeanDefinitionException
org.springframework.beans.factory.NoSuchBeanDefinitionException
- if there is no single EntityManagerFactory in the contextprotected <T> T lookup(String jndiName, Class<T> requiredType) throws 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 objectException
- if the JNDI lookup failed