| java.lang.Object
 org.springframework.orm.jpa.AbstractEntityManagerFactoryBean
org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean
| LocalContainerEntityManagerFactoryBean | | public class LocalContainerEntityManagerFactoryBean extends AbstractEntityManagerFactoryBean implements ResourceLoaderAware,LoadTimeWeaverAware(Code) | | org.springframework.beans.factory.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
org.springframework.orm.jpa.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
org.springframework.instrument.classloading.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.
author:
Juergen Hoeller
author:
Rod Johnson
since:
2.0
See Also: LocalContainerEntityManagerFactoryBean.setPersistenceXmlLocation
See Also: LocalContainerEntityManagerFactoryBean.setJpaProperties
See Also: LocalContainerEntityManagerFactoryBean.setJpaVendorAdapter
See Also: LocalContainerEntityManagerFactoryBean.setLoadTimeWeaver
See Also: LocalContainerEntityManagerFactoryBean.setDataSource
See Also: EntityManagerFactoryInfo
See Also: LocalEntityManagerFactoryBean
See Also: org.springframework.orm.jpa.support.SharedEntityManagerBean
See Also: javax.persistence.spi.PersistenceProvider.createContainerEntityManagerFactory |
| Method Summary | |
| protected EntityManagerFactory | createNativeEntityManagerFactory()
| | 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. | | public DataSource | getDataSource()
| | public PersistenceUnitInfo | getPersistenceUnitInfo()
| | public String | getPersistenceUnitName()
| | protected void | postProcessEntityManagerFactory(EntityManagerFactory emf, PersistenceUnitInfo pui)
Hook method allowing subclasses to customize the EntityManagerFactory
after its creation via the PersistenceProvider. | | public void | setDataSource(DataSource dataSource)
Specify the JDBC DataSource that the JPA persistence provider is supposed
to use for accessing the database. | | public void | setLoadTimeWeaver(LoadTimeWeaver loadTimeWeaver)
Specify the Spring LoadTimeWeaver to use for class instrumentation according
to the JPA class transformer contract. | | 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. | | public void | setPersistenceUnitPostProcessors(PersistenceUnitPostProcessor[] postProcessors)
Set the PersistenceUnitPostProcessors to be applied to the
PersistenceUnitInfo used for creating this EntityManagerFactory. | | public void | setPersistenceXmlLocation(String persistenceXmlLocation)
Set the location of the persistence.xml file
we want to use. | | public void | setResourceLoader(ResourceLoader resourceLoader)
|
| createNativeEntityManagerFactory | | protected EntityManagerFactory createNativeEntityManagerFactory() throws PersistenceException(Code) | | |
| determinePersistenceUnitInfo | | protected PersistenceUnitInfo determinePersistenceUnitInfo(PersistenceUnitManager persistenceUnitManager)(Code) | | 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 the chosen PersistenceUnitInfo |
| getPersistenceUnitInfo | | public PersistenceUnitInfo getPersistenceUnitInfo()(Code) | | |
| getPersistenceUnitName | | public String getPersistenceUnitName()(Code) | | |
| postProcessEntityManagerFactory | | protected void postProcessEntityManagerFactory(EntityManagerFactory emf, PersistenceUnitInfo pui)(Code) | | 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
Parameters:
pui - the PersistenceUnitInfo used to configure the EntityManagerFactory
See Also: javax.persistence.spi.PersistenceProvider.createContainerEntityManagerFactory |
| setDataSource | | public void setDataSource(DataSource dataSource)(Code) | | 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.
See Also: javax.persistence.spi.PersistenceUnitInfo.getNonJtaDataSource
See Also: LocalContainerEntityManagerFactoryBean.setPersistenceUnitManager |
| setLoadTimeWeaver | | public void setLoadTimeWeaver(LoadTimeWeaver loadTimeWeaver)(Code) | | 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
LocalContainerEntityManagerFactoryBean.setPersistenceUnitManager PersistenceUnitManager is responsible for the weaving configuration.
See Also: org.springframework.instrument.classloading.InstrumentationLoadTimeWeaver
See Also: org.springframework.instrument.classloading.ReflectiveLoadTimeWeaver
See Also: org.springframework.instrument.classloading.tomcat.TomcatInstrumentableClassLoader |
| setPersistenceUnitPostProcessors | | public void setPersistenceUnitPostProcessors(PersistenceUnitPostProcessor[] postProcessors)(Code) | | 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.
See Also: LocalContainerEntityManagerFactoryBean.setPersistenceUnitManager |
| setPersistenceXmlLocation | | public void setPersistenceXmlLocation(String persistenceXmlLocation)(Code) | | 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 Stringidentifying the location of the persistence.xml filethat this LocalContainerEntityManagerFactoryBean should parse
See Also: LocalContainerEntityManagerFactoryBean.setPersistenceUnitManager |
| Fields inherited from org.springframework.orm.jpa.AbstractEntityManagerFactoryBean | final protected Log logger(Code)(Java Doc)
public EntityManagerFactory nativeEntityManagerFactory(Code)(Java Doc)
|
|
|