Save This Page
Home » spring-framework-2.5.5-with-dependencies » org.springframework » orm » jdo » [javadoc | source]
org.springframework.orm.jdo
public class: LocalPersistenceManagerFactoryBean [javadoc | source]
java.lang.Object
   org.springframework.orm.jdo.LocalPersistenceManagerFactoryBean

All Implemented Interfaces:
    PersistenceExceptionTranslator, BeanClassLoaderAware, DisposableBean, InitializingBean, FactoryBean

org.springframework.beans.factory.FactoryBean that creates a JDO javax.jdo.PersistenceManagerFactory . This is the usual way to set up a shared JDO PersistenceManagerFactory in a Spring application context; the PersistenceManagerFactory can then be passed to JDO-based DAOs via dependency injection. Note that switching to a JNDI lookup or to a bean-style PersistenceManagerFactory instance is just a matter of configuration!

Configuration settings can either be read from a properties file, specified as "configLocation", or locally specified. Properties specified as "jdoProperties" here will override any settings in a file. On JDO 2.1, you may alternatively specify a "persistenceManagerFactoryName", referring to a PMF definition in "META-INF/jdoconfig.xml" (see #setPersistenceManagerFactoryName ).

NOTE: This class requires JDO 2.0 or higher, as of Spring 2.5.

This class also implements the org.springframework.dao.support.PersistenceExceptionTranslator interface, as autodetected by Spring's org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor , for AOP-based translation of native exceptions to Spring DataAccessExceptions. Hence, the presence of a LocalPersistenceManagerFactoryBean automatically enables a PersistenceExceptionTranslationPostProcessor to translate JDO exceptions.

Alternative: Configuration of a PersistenceManagerFactory provider bean

As alternative to the properties-driven approach that this FactoryBean offers (which is analogous to using the standard JDOHelper class with a Properties object that is populated with standard JDO properties), you can set up an instance of your PersistenceManagerFactory implementation class directly.

Like a DataSource, a PersistenceManagerFactory is encouraged to support bean-style configuration, which makes it very easy to set up as Spring-managed bean. The implementation class becomes the bean class; the remaining properties are applied as bean properties (starting with lower-case characters, in contrast to the corresponding JDO properties).

For example, in case of JPOX:

<bean id="persistenceManagerFactory" class="org.jpox.PersistenceManagerFactoryImpl" destroy-method="close">
<property name="connectionFactory" ref="dataSource"/>
<property name="nontransactionalRead" value="true"/>
</bean>

Note that such direct setup of a PersistenceManagerFactory implementation is the only way to pass an external connection factory (i.e. a JDBC DataSource) into a JDO PersistenceManagerFactory. With the standard properties-driven approach, you can only use an internal connection pool or a JNDI DataSource.

The close() method is standardized in JDO; don't forget to specify it as "destroy-method" for any PersistenceManagerFactory instance. Note that this FactoryBean will automatically invoke close() for the PersistenceManagerFactory that it creates, without any special configuration.

Field Summary
protected final  Log logger     
Method from org.springframework.orm.jdo.LocalPersistenceManagerFactoryBean Summary:
afterPropertiesSet,   destroy,   getJdoPropertyMap,   getObject,   getObjectType,   isSingleton,   newPersistenceManagerFactory,   newPersistenceManagerFactory,   setBeanClassLoader,   setConfigLocation,   setJdoDialect,   setJdoProperties,   setJdoPropertyMap,   setPersistenceManagerFactoryName,   translateExceptionIfPossible
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.springframework.orm.jdo.LocalPersistenceManagerFactoryBean Detail:
 public  void afterPropertiesSet() throws IllegalArgumentException, IOException, JDOException 
    Initialize the PersistenceManagerFactory for the given location.
 public  void destroy() 
    Close the PersistenceManagerFactory on bean factory shutdown.
 public Map getJdoPropertyMap() 
    Allow Map access to the JDO properties to be passed to the JDOHelper, with the option to add or override specific entries.

    Useful for specifying entries directly, for example via "jdoPropertyMap[myKey]".

 public Object getObject() 
    Return the singleton PersistenceManagerFactory.
 public Class getObjectType() 
 public boolean isSingleton() 
 protected PersistenceManagerFactory newPersistenceManagerFactory(String name) 
    Subclasses can override this to perform custom initialization of the PersistenceManagerFactory instance, creating it for the specified name.

    The default implementation invokes JDOHelper's getPersistenceManagerFactory(String) method. A custom implementation could prepare the instance in a specific way, or use a custom PersistenceManagerFactory implementation.

 protected PersistenceManagerFactory newPersistenceManagerFactory(Map props) 
    Subclasses can override this to perform custom initialization of the PersistenceManagerFactory instance, creating it via the given Properties that got prepared by this LocalPersistenceManagerFactoryBean.

    The default implementation invokes JDOHelper's getPersistenceManagerFactory(Map) method. A custom implementation could prepare the instance in a specific way, or use a custom PersistenceManagerFactory implementation.

 public  void setBeanClassLoader(ClassLoader beanClassLoader) 
 public  void setConfigLocation(Resource configLocation) 
    Set the location of the JDO properties config file, for example as classpath resource "classpath:kodo.properties".

    Note: Can be omitted when all necessary properties are specified locally via this bean.

 public  void setJdoDialect(JdoDialect jdoDialect) 
    Set the JDO dialect to use for the PersistenceExceptionTranslator functionality of this factory.

    Default is a DefaultJdoDialect based on the PersistenceManagerFactory's underlying DataSource, if any.

 public  void setJdoProperties(Properties jdoProperties) 
    Set JDO properties, such as"javax.jdo.PersistenceManagerFactoryClass".

    Can be used to override values in a JDO properties config file, or to specify all necessary properties locally.

    Can be populated with a String "value" (parsed via PropertiesEditor) or a "props" element in XML bean definitions.

 public  void setJdoPropertyMap(Map jdoProperties) 
    Specify JDO properties as a Map, to be passed into JDOHelper.getPersistenceManagerFactory (if any).

    Can be populated with a "map" or "props" element in XML bean definitions.

 public  void setPersistenceManagerFactoryName(String persistenceManagerFactoryName) 
    Specify the name of the desired PersistenceManagerFactory.

    This may either be a properties resource in the classpath if such a resource exists (JDO 2.0), or a PMF definition with that name from "META-INF/jdoconfig.xml" (JDO 2.1), or a JPA EntityManagerFactory cast to a PersistenceManagerFactory based on the persistence-unit name from "META-INF/persistence.xml" (JDO 2.1 / JPA 1.0).

    Default is none: Either 'persistenceManagerFactoryName' or 'configLocation' or 'jdoProperties' needs to be specified.

 public DataAccessException translateExceptionIfPossible(RuntimeException ex) 
    Implementation of the PersistenceExceptionTranslator interface, as autodetected by Spring's PersistenceExceptionTranslationPostProcessor.

    Converts the exception if it is a JDOException, preferably using a specified JdoDialect. Else returns null to indicate an unknown exception.