org.springframework.orm.jpa

Class SharedEntityManagerCreator

java.lang.Object

org.springframework.orm.jpa.SharedEntityManagerCreator

public abstract class SharedEntityManagerCreator
extends java.lang.Object

Delegate for creating a shareable JPA javax.persistence.EntityManager reference for a given javax.persistence.EntityManagerFactory.

A shared EntityManager will behave just like an EntityManager fetched from an application server's JNDI environment, as defined by the JPA specification. It will delegate all calls to the current transactional EntityManager, if any; otherwise it will fall back to a newly created EntityManager per operation.

For a behavioral definition of such a shared transactional EntityManager, see javax.persistence.PersistenceContextType#TRANSACTION and its discussion in the JPA spec document. This is also the default being used for the annotation-based javax.persistence.PersistenceContext#type().

Since:

2.0

Author:

Juergen Hoeller, Rod Johnson, Oliver Gierke

See Also:

javax.persistence.PersistenceContext, javax.persistence.PersistenceContextType#TRANSACTION, JpaTransactionManager, ExtendedEntityManagerCreator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SharedEntityManagerCreator.DeferredQueryInvocationHandler Invocation handler that handles deferred Query objects created by non-transactional createQuery invocations on a shared EntityManager.
private static class	SharedEntityManagerCreator.SharedEntityManagerInvocationHandler Invocation handler that delegates all calls to the current transactional EntityManager, if any; else, it will fall back to a newly created EntityManager per operation.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.Class<?>[]	NO_ENTITY_MANAGER_INTERFACES
private static java.util.Set<java.lang.String>	queryTerminationMethods
private static java.util.Set<java.lang.String>	transactionRequiringMethods

Constructor Summary

Constructors

Constructor and Description
SharedEntityManagerCreator()

Method Summary

Modifier and Type	Method and Description
static EntityManager	createSharedEntityManager(EntityManagerFactory emf) Create a transactional EntityManager proxy for the given EntityManagerFactory.
static EntityManager	createSharedEntityManager(EntityManagerFactory emf, java.util.Map<?,?> properties) Create a transactional EntityManager proxy for the given EntityManagerFactory.
static EntityManager	createSharedEntityManager(EntityManagerFactory emf, java.util.Map<?,?> properties, boolean synchronizedWithTransaction) Create a transactional EntityManager proxy for the given EntityManagerFactory.
static EntityManager	createSharedEntityManager(EntityManagerFactory emf, java.util.Map<?,?> properties, boolean synchronizedWithTransaction, java.lang.Class<?>... entityManagerInterfaces) Create a transactional EntityManager proxy for the given EntityManagerFactory.
static EntityManager	createSharedEntityManager(EntityManagerFactory emf, java.util.Map<?,?> properties, java.lang.Class<?>... entityManagerInterfaces) Create a transactional EntityManager proxy for the given EntityManagerFactory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_ENTITY_MANAGER_INTERFACES

private static final java.lang.Class<?>[] NO_ENTITY_MANAGER_INTERFACES

transactionRequiringMethods

private static final java.util.Set<java.lang.String> transactionRequiringMethods

queryTerminationMethods

private static final java.util.Set<java.lang.String> queryTerminationMethods

Constructor Detail

SharedEntityManagerCreator

public SharedEntityManagerCreator()

Method Detail

createSharedEntityManager

public static EntityManager createSharedEntityManager(EntityManagerFactory emf)

Create a transactional EntityManager proxy for the given EntityManagerFactory.

Parameters:

emf - the EntityManagerFactory to delegate to.

Returns:

a shareable transaction EntityManager proxy

createSharedEntityManager

public static EntityManager createSharedEntityManager(EntityManagerFactory emf,
                                                      java.util.Map<?,?> properties)

Create a transactional EntityManager proxy for the given EntityManagerFactory.

Parameters:

emf - the EntityManagerFactory to delegate to.

properties - the properties to be passed into the createEntityManager call (may be null)

Returns:

a shareable transaction EntityManager proxy

createSharedEntityManager

public static EntityManager createSharedEntityManager(EntityManagerFactory emf,
                                                      java.util.Map<?,?> properties,
                                                      boolean synchronizedWithTransaction)

Create a transactional EntityManager proxy for the given EntityManagerFactory.

Parameters:

emf - the EntityManagerFactory to delegate to.

properties - the properties to be passed into the createEntityManager call (may be null)

synchronizedWithTransaction - whether to automatically join ongoing transactions (according to the JPA 2.1 SynchronizationType rules)

Returns:

a shareable transaction EntityManager proxy

createSharedEntityManager

public static EntityManager createSharedEntityManager(EntityManagerFactory emf,
                                                      java.util.Map<?,?> properties,
                                                      java.lang.Class<?>... entityManagerInterfaces)

Create a transactional EntityManager proxy for the given EntityManagerFactory.

Parameters:

emf - EntityManagerFactory to obtain EntityManagers from as needed

properties - the properties to be passed into the createEntityManager call (may be null)

entityManagerInterfaces - the interfaces to be implemented by the EntityManager. Allows the addition or specification of proprietary interfaces.

Returns:

a shareable transactional EntityManager proxy

createSharedEntityManager

public static EntityManager createSharedEntityManager(EntityManagerFactory emf,
                                                      java.util.Map<?,?> properties,
                                                      boolean synchronizedWithTransaction,
                                                      java.lang.Class<?>... entityManagerInterfaces)

Create a transactional EntityManager proxy for the given EntityManagerFactory.

Parameters:

emf - EntityManagerFactory to obtain EntityManagers from as needed

properties - the properties to be passed into the createEntityManager call (may be null)

synchronizedWithTransaction - whether to automatically join ongoing transactions (according to the JPA 2.1 SynchronizationType rules)

entityManagerInterfaces - the interfaces to be implemented by the EntityManager. Allows the addition or specification of proprietary interfaces.

Returns:

a shareable transactional EntityManager proxy