Save This Page
Home » spring-framework-2.5.6-with-dependencies » org.springframework » orm » jpa » [javadoc | source]
org.springframework.orm.jpa
public class: LocalContainerEntityManagerFactoryBean [javadoc | source]
java.lang.Object
   org.springframework.orm.jpa.AbstractEntityManagerFactoryBean
      org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean

All Implemented Interfaces:
    LoadTimeWeaverAware, ResourceLoaderAware, PersistenceExceptionTranslator, EntityManagerFactoryInfo, BeanClassLoaderAware, DisposableBean, InitializingBean, FactoryBean

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.

Fields inherited from org.springframework.orm.jpa.AbstractEntityManagerFactoryBean:
logger,  nativeEntityManagerFactory
Method from org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean Summary:
createNativeEntityManagerFactory,   determinePersistenceUnitInfo,   getDataSource,   getPersistenceUnitInfo,   getPersistenceUnitName,   postProcessEntityManagerFactory,   setDataSource,   setLoadTimeWeaver,   setPersistenceUnitManager,   setPersistenceUnitPostProcessors,   setPersistenceXmlLocation,   setResourceLoader
Methods from org.springframework.orm.jpa.AbstractEntityManagerFactoryBean:
afterPropertiesSet,   createEntityManagerFactoryProxy,   createNativeEntityManagerFactory,   destroy,   getBeanClassLoader,   getDataSource,   getEntityManagerInterface,   getJpaDialect,   getJpaPropertyMap,   getJpaVendorAdapter,   getNativeEntityManagerFactory,   getObject,   getObjectType,   getPersistenceProvider,   getPersistenceUnitInfo,   getPersistenceUnitName,   isSingleton,   setBeanClassLoader,   setEntityManagerFactoryInterface,   setEntityManagerInterface,   setJpaDialect,   setJpaProperties,   setJpaPropertyMap,   setJpaVendorAdapter,   setPersistenceProvider,   setPersistenceProviderClass,   setPersistenceUnitName,   translateExceptionIfPossible
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean Detail:
 protected EntityManagerFactory createNativeEntityManagerFactory() 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.

 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.

    The default implementation is empty.

 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.

 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.

 public  void setResourceLoader(ResourceLoader resourceLoader)