public class

LocalContainerEntityManagerFactoryBean

extends AbstractEntityManagerFactoryBean
implements ResourceLoaderAware LoadTimeWeaverAware

java.lang.Object
↳	org.springframework.orm.jpa.AbstractEntityManagerFactoryBean
	↳	org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean

Class Overview

FactoryBean that creates a JPA javax.persistence.EntityManagerFactory according to JPA's standard container bootstrap contract. This is the most powerful way to set up a shared JPA EntityManagerFactory in a Spring application context; the EntityManagerFactory can then be passed to JPA-based DAOs via dependency injection. Note that switching to a JNDI lookup or to a LocalEntityManagerFactoryBean definition is just a matter of configuration!

As with LocalEntityManagerFactoryBean, configuration settings are usually read in from a META-INF/persistence.xml config file, residing in the class path, according to the general JPA configuration contract. However, this FactoryBean is more flexible in that you can override the location of the persistence.xml file, specify the JDBC DataSources to link to, etc. Furthermore, it allows for pluggable class instrumentation through Spring's LoadTimeWeaver abstraction, instead of being tied to a special VM agent specified on JVM startup.

Internally, this FactoryBean parses the persistence.xml file itself and creates a corresponding javax.persistence.spi.PersistenceUnitInfo object (with further configuration merged in, such as JDBC DataSources and the Spring LoadTimeWeaver), to be passed to the chosen JPA javax.persistence.spi.PersistenceProvider. This corresponds to a local JPA container with full support for the standard JPA container contract.

The exposed EntityManagerFactory object will implement all the interfaces of the underlying native EntityManagerFactory returned by the PersistenceProvider, plus the EntityManagerFactoryInfo interface which exposes additional metadata as assembled by this FactoryBean.

Summary

[Expand]

Inherited Fields

From class org.springframework.orm.jpa.AbstractEntityManagerFactoryBean

Public Constructors
	LocalContainerEntityManagerFactoryBean()

Public Methods
DataSource	getDataSource() Return the JDBC DataSource that this EntityManagerFactory obtains its JDBC Connections from.
PersistenceUnitInfo	getPersistenceUnitInfo() Return the PersistenceUnitInfo used to create this EntityManagerFactory, if the in-container API was used.
String	getPersistenceUnitName() Return the name of the persistence unit used to create this EntityManagerFactory, or `null` if it is an unnamed default.
void	setDataSource(DataSource dataSource) Specify the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database.
void	setLoadTimeWeaver(LoadTimeWeaver loadTimeWeaver) Specify the Spring LoadTimeWeaver to use for class instrumentation according to the JPA class transformer contract.
void	setPersistenceUnitManager(PersistenceUnitManager persistenceUnitManager) Set the PersistenceUnitManager to use for obtaining the JPA persistence unit that this FactoryBean is supposed to build an EntityManagerFactory for.
void	setPersistenceUnitPostProcessors(PersistenceUnitPostProcessor[] postProcessors) Set the PersistenceUnitPostProcessors to be applied to the PersistenceUnitInfo used for creating this EntityManagerFactory.
void	setPersistenceXmlLocation(String persistenceXmlLocation) Set the location of the `persistence.xml` file we want to use.
void	setResourceLoader(ResourceLoader resourceLoader) Set the ResourceLoader that this object runs in.

Protected Methods
EntityManagerFactory	createNativeEntityManagerFactory() Subclasses must implement this method to create the EntityManagerFactory that will be returned by the `getObject()` method.
PersistenceUnitInfo	determinePersistenceUnitInfo(PersistenceUnitManager persistenceUnitManager) Determine the PersistenceUnitInfo to use for the EntityManagerFactory created by this bean.
void	postProcessEntityManagerFactory(EntityManagerFactory emf, PersistenceUnitInfo pui) Hook method allowing subclasses to customize the EntityManagerFactory after its creation via the PersistenceProvider.

[Expand]

Inherited Methods

From class org.springframework.orm.jpa.AbstractEntityManagerFactoryBean

final void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
EntityManagerFactory	createEntityManagerFactoryProxy(EntityManagerFactory emf) Create a proxy of the given EntityManagerFactory.
abstract EntityManagerFactory	createNativeEntityManagerFactory() Subclasses must implement this method to create the EntityManagerFactory that will be returned by the `getObject()` method.
void	destroy() Close the EntityManagerFactory on bean factory shutdown.
ClassLoader	getBeanClassLoader() Return the ClassLoader that the application's beans are loaded with.
DataSource	getDataSource() Return the JDBC DataSource that this EntityManagerFactory obtains its JDBC Connections from.
Class<? extends EntityManager>	getEntityManagerInterface() Return the (potentially vendor-specific) EntityManager interface that this factory's EntityManagers will implement.
JpaDialect	getJpaDialect() Return the vendor-specific JpaDialect implementation for this EntityManagerFactory, or `null` if not known.
Map<String, Object>	getJpaPropertyMap() Allow Map access to the JPA properties to be passed to the persistence provider, with the option to add or override specific entries.
JpaVendorAdapter	getJpaVendorAdapter() Return the JpaVendorAdapter implementation for this EntityManagerFactory, or `null` if not known.
EntityManagerFactory	getNativeEntityManagerFactory() Return the raw underlying EntityManagerFactory.
EntityManagerFactory	getObject() Return the singleton EntityManagerFactory.
Class<? extends EntityManagerFactory>	getObjectType() Return the type of object that this FactoryBean creates, or `null` if not known in advance.
PersistenceProvider	getPersistenceProvider() Return the underlying PersistenceProvider that the underlying EntityManagerFactory was created with.
PersistenceUnitInfo	getPersistenceUnitInfo() Return the PersistenceUnitInfo used to create this EntityManagerFactory, if the in-container API was used.
String	getPersistenceUnitName() Return the name of the persistence unit used to create this EntityManagerFactory, or `null` if it is an unnamed default.
boolean	isSingleton() Is the object managed by this factory a singleton? That is, will `getObject()` always return the same object (a reference that can be cached)? NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from `getObject()` might get cached by the owning BeanFactory.
void	setBeanClassLoader(ClassLoader classLoader) Callback that supplies the bean `class loader` to a bean instance.
void	setBeanFactory(BeanFactory beanFactory) Callback that supplies the owning factory to a bean instance.
void	setBeanName(String name) Set the name of the bean in the bean factory that created this bean.
void	setEntityManagerFactoryInterface(Class<? extends EntityManagerFactory> emfInterface) Specify the (potentially vendor-specific) EntityManagerFactory interface that this EntityManagerFactory proxy is supposed to implement.
void	setEntityManagerInterface(Class<? extends EntityManager> emInterface) Specify the (potentially vendor-specific) EntityManager interface that this factory's EntityManagers are supposed to implement.
void	setJpaDialect(JpaDialect jpaDialect) Specify the vendor-specific JpaDialect implementation to associate with this EntityManagerFactory.
void	setJpaProperties(Properties jpaProperties) Specify JPA properties, to be passed into `Persistence.createEntityManagerFactory` (if any).
void	setJpaPropertyMap(Map<String, ?> jpaProperties) Specify JPA properties as a Map, to be passed into `Persistence.createEntityManagerFactory` (if any).
void	setJpaVendorAdapter(JpaVendorAdapter jpaVendorAdapter) Specify the JpaVendorAdapter implementation for the desired JPA provider, if any.
void	setPersistenceProvider(PersistenceProvider persistenceProvider) Set the PersistenceProvider instance to use for creating the EntityManagerFactory.
void	setPersistenceProviderClass(Class<? extends PersistenceProvider> persistenceProviderClass) Set the PersistenceProvider implementation class to use for creating the EntityManagerFactory.
void	setPersistenceUnitName(String persistenceUnitName) Specify the name of the EntityManagerFactory configuration.
DataAccessException	translateExceptionIfPossible(RuntimeException ex) Implementation of the PersistenceExceptionTranslator interface, as autodetected by Spring's PersistenceExceptionTranslationPostProcessor.
Object	writeReplace()

From class java.lang.Object

From interface org.springframework.beans.factory.BeanClassLoaderAware

From interface org.springframework.beans.factory.BeanFactoryAware

From interface org.springframework.beans.factory.BeanNameAware

From interface org.springframework.beans.factory.DisposableBean

From interface org.springframework.beans.factory.FactoryBean

From interface org.springframework.beans.factory.InitializingBean

From interface org.springframework.context.ResourceLoaderAware

From interface org.springframework.context.weaving.LoadTimeWeaverAware

From interface org.springframework.dao.support.PersistenceExceptionTranslator

From interface org.springframework.orm.jpa.EntityManagerFactoryInfo

abstract ClassLoader	getBeanClassLoader() Return the ClassLoader that the application's beans are loaded with.
abstract DataSource	getDataSource() Return the JDBC DataSource that this EntityManagerFactory obtains its JDBC Connections from.
abstract Class<? extends EntityManager>	getEntityManagerInterface() Return the (potentially vendor-specific) EntityManager interface that this factory's EntityManagers will implement.
abstract JpaDialect	getJpaDialect() Return the vendor-specific JpaDialect implementation for this EntityManagerFactory, or `null` if not known.
abstract EntityManagerFactory	getNativeEntityManagerFactory() Return the raw underlying EntityManagerFactory.
abstract PersistenceProvider	getPersistenceProvider() Return the underlying PersistenceProvider that the underlying EntityManagerFactory was created with.
abstract PersistenceUnitInfo	getPersistenceUnitInfo() Return the PersistenceUnitInfo used to create this EntityManagerFactory, if the in-container API was used.
abstract String	getPersistenceUnitName() Return the name of the persistence unit used to create this EntityManagerFactory, or `null` if it is an unnamed default.

Public Constructors

public LocalContainerEntityManagerFactoryBean ()

Public Methods

public DataSource getDataSource ()

Return the JDBC DataSource that this EntityManagerFactory obtains its JDBC Connections from.

Returns

the JDBC DataSource, or null if not known

public PersistenceUnitInfo getPersistenceUnitInfo ()

Return the PersistenceUnitInfo used to create this EntityManagerFactory, if the in-container API was used.

Returns

the PersistenceUnitInfo used to create this EntityManagerFactory, or null if the in-container contract was not used to configure the EntityManagerFactory

public String getPersistenceUnitName ()

Return the name of the persistence unit used to create this EntityManagerFactory, or null if it is an unnamed default.

If getPersistenceUnitInfo() returns non-null, the result of getPersistenceUnitName() must be equal to the value returned by PersistenceUnitInfo.getPersistenceUnitName().

public void setDataSource (DataSource dataSource)

Specify the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database. This is an alternative to keeping the JDBC configuration in persistence.xml, passing in a Spring-managed DataSource instead.

In JPA speak, a DataSource passed in here will be used as "nonJtaDataSource" on the PersistenceUnitInfo passed to the PersistenceProvider, overriding data source configuration in persistence.xml (if any).

NOTE: Only applied if no external PersistenceUnitManager specified.

public void setLoadTimeWeaver (LoadTimeWeaver loadTimeWeaver)

Specify the Spring LoadTimeWeaver to use for class instrumentation according to the JPA class transformer contract.

It is a not required to specify a LoadTimeWeaver: Most providers will be able to provide a subset of their functionality without class instrumentation as well, or operate with their VM agent specified on JVM startup.

In terms of Spring-provided weaving options, the most important ones are InstrumentationLoadTimeWeaver, which requires a Spring-specific (but very general) VM agent specified on JVM startup, and ReflectiveLoadTimeWeaver, which interacts with an underlying ClassLoader based on specific extended methods being available on it (for example, interacting with Spring's TomcatInstrumentableClassLoader).

NOTE: As of Spring 2.5, the context's default LoadTimeWeaver (defined as bean with name "loadTimeWeaver") will be picked up automatically, if available, removing the need for LoadTimeWeaver configuration on each affected target bean. Consider using the context:load-time-weaver XML tag for creating such a shared LoadTimeWeaver (autodetecting the environment by default).

NOTE: Only applied if no external PersistenceUnitManager specified. Otherwise, the external PersistenceUnitManager is responsible for the weaving configuration.

Parameters

loadTimeWeaver	the `LoadTimeWeaver` instance (never `null`)

public void setPersistenceUnitManager (PersistenceUnitManager persistenceUnitManager)

Set the PersistenceUnitManager to use for obtaining the JPA persistence unit that this FactoryBean is supposed to build an EntityManagerFactory for.

The default is to rely on the local settings specified on this FactoryBean, such as "persistenceXmlLocation", "dataSource" and "loadTimeWeaver".

For reuse of existing persistence unit configuration or more advanced forms of custom persistence unit handling, consider defining a separate PersistenceUnitManager bean (typically a DefaultPersistenceUnitManager instance) and linking it in here. persistence.xml location, DataSource configuration and LoadTimeWeaver will be defined on that separate DefaultPersistenceUnitManager bean in such a scenario.

public void setPersistenceUnitPostProcessors (PersistenceUnitPostProcessor[] postProcessors)

Set the PersistenceUnitPostProcessors to be applied to the PersistenceUnitInfo used for creating this EntityManagerFactory.

Such post-processors can, for example, register further entity classes and jar files, in addition to the metadata read in from persistence.xml.

NOTE: Only applied if no external PersistenceUnitManager specified.

public void setPersistenceXmlLocation (String persistenceXmlLocation)

Set the location of the persistence.xml file we want to use. This is a Spring resource location.

Default is "classpath:META-INF/persistence.xml".

NOTE: Only applied if no external PersistenceUnitManager specified.

Parameters

persistenceXmlLocation	a Spring resource String identifying the location of the `persistence.xml` file that this LocalContainerEntityManagerFactoryBean should parse

public void setResourceLoader (ResourceLoader resourceLoader)

Set the ResourceLoader that this object runs in.

This might be a ResourcePatternResolver, which can be checked through instanceof ResourcePatternResolver. See also the ResourcePatternUtils.getResourcePatternResolver method.

Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked before ApplicationContextAware's setApplicationContext.

Parameters

resourceLoader	ResourceLoader object to be used by this object

Protected Methods

protected EntityManagerFactory createNativeEntityManagerFactory ()

Subclasses must implement this method to create the EntityManagerFactory that will be returned by the getObject() method.

Returns

EntityManagerFactory instance returned by this FactoryBean

Throws

PersistenceException

protected PersistenceUnitInfo determinePersistenceUnitInfo (PersistenceUnitManager persistenceUnitManager)

Determine the PersistenceUnitInfo to use for the EntityManagerFactory created by this bean.

The default implementation reads in all persistence unit infos from persistence.xml, as defined in the JPA specification. If no entity manager name was specified, it takes the first info in the array as returned by the reader. Otherwise, it checks for a matching name.

Parameters

persistenceUnitManager	the PersistenceUnitManager to obtain from

Returns

the chosen PersistenceUnitInfo

protected void postProcessEntityManagerFactory (EntityManagerFactory emf, PersistenceUnitInfo pui)

Hook method allowing subclasses to customize the EntityManagerFactory after its creation via the PersistenceProvider.

The default implementation is empty.

Parameters

emf	the newly created EntityManagerFactory we are working with
pui	the PersistenceUnitInfo used to configure the EntityManagerFactory

Interfaces

Classes

Exceptions

LocalContainerEntityManagerFactoryBean

Class Overview

See Also

Summary

Public Constructors

public LocalContainerEntityManagerFactoryBean ()

Public Methods

public DataSource getDataSource ()

Returns

public PersistenceUnitInfo getPersistenceUnitInfo ()

Returns

public String getPersistenceUnitName ()

public void setDataSource (DataSource dataSource)

See Also

public void setLoadTimeWeaver (LoadTimeWeaver loadTimeWeaver)

Parameters

See Also

public void setPersistenceUnitManager (PersistenceUnitManager persistenceUnitManager)

See Also

public void setPersistenceUnitPostProcessors (PersistenceUnitPostProcessor[] postProcessors)

See Also

public void setPersistenceXmlLocation (String persistenceXmlLocation)

Parameters

See Also

public void setResourceLoader (ResourceLoader resourceLoader)

Parameters

Protected Methods

protected EntityManagerFactory createNativeEntityManagerFactory ()

Returns

Throws

protected PersistenceUnitInfo determinePersistenceUnitInfo (PersistenceUnitManager persistenceUnitManager)

Parameters

Returns

protected void postProcessEntityManagerFactory (EntityManagerFactory emf, PersistenceUnitInfo pui)

Parameters

See Also