LocalEntityManagerFactoryBean

Class Overview

FactoryBean that creates a JPA javax.persistence.EntityManagerFactory according to JPA's standard standalone bootstrap contract. This is the simplest 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 LocalContainerEntityManagerFactoryBean definition is just a matter of configuration!

Configuration settings are usually read from a META-INF/persistence.xml config file, residing in the class path, according to the JPA standalone bootstrap contract. Additionally, most JPA providers will require a special VM agent (specified on JVM startup) that allows them to instrument application classes. See the Java Persistence API specification and your provider documentation for setup details.

This EntityManagerFactory bootstrap is appropriate for standalone applications which solely use JPA for data access. If you want to set up your persistence provider for an external DataSource and/or for global transactions which span multiple resources, you will need to either deploy it into a full Java EE 5 application server and access the deployed EntityManagerFactory via JNDI, or use Spring's LocalContainerEntityManagerFactoryBean with appropriate configuration for local setup according to JPA's container contract.

Note: This FactoryBean has limited configuration power in terms of what configuration it is able to pass to the JPA provider. If you need more flexible configuration, for example passing a Spring-managed JDBC DataSource to the JPA provider, consider using Spring's more powerful LocalContainerEntityManagerFactoryBean instead.

Summary

[Expand] Inherited Fields
From class org.springframework.orm.jpa.AbstractEntityManagerFactoryBean protected final Log logger Logger available to subclasses public EntityManagerFactory nativeEntityManagerFactory Raw EntityManagerFactory as returned by 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 Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.beans.factory.BeanClassLoaderAware abstract void setBeanClassLoader(ClassLoader classLoader) Callback that supplies the bean class loader to a bean instance.
From interface org.springframework.beans.factory.BeanFactoryAware abstract void setBeanFactory(BeanFactory beanFactory) Callback that supplies the owning factory to a bean instance.
From interface org.springframework.beans.factory.BeanNameAware abstract void setBeanName(String name) Set the name of the bean in the bean factory that created this bean.
From interface org.springframework.beans.factory.DisposableBean abstract void destroy() Invoked by a BeanFactory on destruction of a singleton.
From interface org.springframework.beans.factory.FactoryBean abstract T getObject() Return an instance (possibly shared or independent) of the object managed by this factory. abstract Class<?> getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance. abstract 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.
From interface org.springframework.beans.factory.InitializingBean abstract void afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
From interface org.springframework.dao.support.PersistenceExceptionTranslator abstract DataAccessException translateExceptionIfPossible(RuntimeException ex) Translate the given runtime exception thrown by a persistence framework to a corresponding exception from Spring's generic DataAccessException hierarchy, if possible.
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.