Package org.apache.isis.persistence.jdo.spring.integration

Class LocalPersistenceManagerFactoryBean

  • All Implemented Interfaces:
    org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<javax.jdo.PersistenceManagerFactory>, org.springframework.beans.factory.InitializingBean, org.springframework.dao.support.PersistenceExceptionTranslator
    public class LocalPersistenceManagerFactoryBean
extends Object
implements org.springframework.beans.factory.FactoryBean<javax.jdo.PersistenceManagerFactory>, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean, org.springframework.dao.support.PersistenceExceptionTranslator
    FactoryBean that creates a 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!

    NOTE: This class requires JDO 3.0 or higher, as of Spring 4.0. It will also expose the JPA EntityManagerFactory as long as the JDO provider creates a javax.jdo.JDOEntityManagerFactory reference underneath, which means that this class can be used as a replacement for org.springframework.orm.jpa.LocalEntityManagerFactoryBean in such a scenario.

    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. You may alternatively specify a "persistenceManagerFactoryName", referring to a PMF definition in "META-INF/jdoconfig.xml" (see setPersistenceManagerFactoryName(java.lang.String)).

    This class also implements the PersistenceExceptionTranslator interface, as autodetected by Spring's 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.

    See Also:
    JdoTransactionManager.setPersistenceManagerFactory(javax.jdo.PersistenceManagerFactory), JndiObjectFactoryBean, JDOHelper.getPersistenceManagerFactory(), PersistenceManagerFactory.setConnectionFactory(java.lang.Object), PersistenceManagerFactory.close(), PersistenceExceptionTranslationPostProcessor

    • Method Detail

      • setPersistenceManagerFactoryName

        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, or a PMF definition with that name from "META-INF/jdoconfig.xml", or a JPA EntityManagerFactory cast to a PersistenceManagerFactory based on the persistence-unit name from "META-INF/persistence.xml" (JPA).

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

        See Also:
        setConfigLocation(org.springframework.core.io.Resource), setJdoProperties(java.util.Properties)

      • setConfigLocation

        public void setConfigLocation​(org.springframework.core.io.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.

      • setJdoProperties

        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.

      • setJdoPropertyMap

        public void setJdoPropertyMap​(Map<String,​Object> 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.

        See Also:
        JDOHelper.getPersistenceManagerFactory(java.util.Map)

      • getJdoPropertyMap

        public Map<String,​Object> 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]".

      • setBeanClassLoader

        public void setBeanClassLoader​(ClassLoader beanClassLoader)
        Specified by:
        setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware

      • afterPropertiesSet

        public void afterPropertiesSet()
                        throws IllegalArgumentException,
                               IOException,
                               javax.jdo.JDOException
        Initialize the PersistenceManagerFactory for the given location.
        Specified by:
        afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
        Throws:
        IllegalArgumentException - in case of illegal property values
        IOException - if the properties could not be loaded from the given location
        javax.jdo.JDOException - in case of JDO initialization errors

      • newPersistenceManagerFactory

        protected javax.jdo.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.

        Parameters:
        name - the name of the desired PersistenceManagerFactory
        Returns:
        the PersistenceManagerFactory instance
        See Also:
        JDOHelper.getPersistenceManagerFactory(String)

      • newPersistenceManagerFactory

        protected javax.jdo.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.

        Parameters:
        props - the merged properties prepared by this LocalPersistenceManagerFactoryBean
        Returns:
        the PersistenceManagerFactory instance
        See Also:
        JDOHelper.getPersistenceManagerFactory(java.util.Map)

      • getObject

        public javax.jdo.PersistenceManagerFactory getObject()
        Return the singleton PersistenceManagerFactory.
        Specified by:
        getObject in interface org.springframework.beans.factory.FactoryBean<javax.jdo.PersistenceManagerFactory>

      • getObjectType

        public Class<? extends javax.jdo.PersistenceManagerFactory> getObjectType()
        Specified by:
        getObjectType in interface org.springframework.beans.factory.FactoryBean<javax.jdo.PersistenceManagerFactory>

      • isSingleton

        public boolean isSingleton()
        Specified by:
        isSingleton in interface org.springframework.beans.factory.FactoryBean<javax.jdo.PersistenceManagerFactory>

      • destroy

        public void destroy()
        Close the PersistenceManagerFactory on bean factory shutdown.
        Specified by:
        destroy in interface org.springframework.beans.factory.DisposableBean