org.springframework.orm.jdo

Class LocalPersistenceManagerFactoryBean

java.lang.Object

org.springframework.orm.jdo.LocalPersistenceManagerFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, DisposableBean, FactoryBean<PersistenceManagerFactory>, InitializingBean, PersistenceExceptionTranslator

public class LocalPersistenceManagerFactoryBean
extends java.lang.Object
implements FactoryBean<PersistenceManagerFactory>, BeanClassLoaderAware, InitializingBean, DisposableBean, PersistenceExceptionTranslator

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!

NOTE: This class requires JDO 3.0 or higher, as of Spring 4.0. It will also expose the JPA javax.persistence.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 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.

Since:

03.06.2003

Author:

Juergen Hoeller

See Also:

JdoTransactionManager.setPersistenceManagerFactory(PersistenceManagerFactory), JndiObjectFactoryBean, javax.jdo.JDOHelper#getPersistenceManagerFactory, javax.jdo.PersistenceManagerFactory#setConnectionFactory, javax.jdo.PersistenceManagerFactory#close(), PersistenceExceptionTranslationPostProcessor

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.ClassLoader	beanClassLoader
private Resource	configLocation
private JdoDialect	jdoDialect
private java.util.Map<java.lang.String,java.lang.Object>	jdoPropertyMap
protected Log	logger
private PersistenceManagerFactory	persistenceManagerFactory
private java.lang.String	persistenceManagerFactoryName

Constructor Summary

Constructors

Constructor and Description
LocalPersistenceManagerFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Initialize the PersistenceManagerFactory for the given location.
void	destroy() Close the PersistenceManagerFactory on bean factory shutdown.
java.util.Map<java.lang.String,java.lang.Object>	getJdoPropertyMap() Allow Map access to the JDO properties to be passed to the JDOHelper, with the option to add or override specific entries.
PersistenceManagerFactory	getObject() Return the singleton PersistenceManagerFactory.
java.lang.Class<? extends PersistenceManagerFactory>	getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean	isSingleton() Is the object managed by this factory a singleton? That is, will FactoryBean.getObject() always return the same object (a reference that can be cached)?
protected PersistenceManagerFactory	newPersistenceManagerFactory(java.util.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.
protected PersistenceManagerFactory	newPersistenceManagerFactory(java.lang.String name) Subclasses can override this to perform custom initialization of the PersistenceManagerFactory instance, creating it for the specified name.
void	setBeanClassLoader(java.lang.ClassLoader beanClassLoader) Callback that supplies the bean class loader to a bean instance.
void	setConfigLocation(Resource configLocation) Set the location of the JDO properties config file, for example as classpath resource "classpath:kodo.properties".
void	setJdoDialect(JdoDialect jdoDialect) Set the JDO dialect to use for the PersistenceExceptionTranslator functionality of this factory.
void	setJdoProperties(java.util.Properties jdoProperties) Set JDO properties, such as"javax.jdo.PersistenceManagerFactoryClass".
void	setJdoPropertyMap(java.util.Map<java.lang.String,java.lang.Object> jdoProperties) Specify JDO properties as a Map, to be passed into JDOHelper.getPersistenceManagerFactory (if any).
void	setPersistenceManagerFactoryName(java.lang.String persistenceManagerFactoryName) Specify the name of the desired PersistenceManagerFactory.
DataAccessException	translateExceptionIfPossible(java.lang.RuntimeException ex) Implementation of the PersistenceExceptionTranslator interface, as autodetected by Spring's PersistenceExceptionTranslationPostProcessor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected final Log logger

persistenceManagerFactoryName

private java.lang.String persistenceManagerFactoryName

configLocation

private Resource configLocation

jdoPropertyMap

private final java.util.Map<java.lang.String,java.lang.Object> jdoPropertyMap

beanClassLoader

private java.lang.ClassLoader beanClassLoader

persistenceManagerFactory

private PersistenceManagerFactory persistenceManagerFactory

jdoDialect

private JdoDialect jdoDialect

Constructor Detail

LocalPersistenceManagerFactoryBean

public LocalPersistenceManagerFactoryBean()

Method Detail

setPersistenceManagerFactoryName

public void setPersistenceManagerFactoryName(java.lang.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(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(java.util.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(java.util.Map<java.lang.String,java.lang.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:

javax.jdo.JDOHelper#getPersistenceManagerFactory(java.util.Map)

getJdoPropertyMap

public java.util.Map<java.lang.String,java.lang.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]".

setJdoDialect

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.

See Also:

JdoDialect.translateException(JDOException), translateExceptionIfPossible(java.lang.RuntimeException), PersistenceExceptionTranslator

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader beanClassLoader)

Description copied from interface: BeanClassLoaderAware

Callback that supplies the bean class loader to a bean instance.

Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean's InitializingBean.afterPropertiesSet() method or a custom init-method.

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

Parameters:

beanClassLoader - the owning class loader; may be null in which case a default ClassLoader must be used, for example the ClassLoader obtained via ClassUtils.getDefaultClassLoader()

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.IllegalArgumentException,
                               java.io.IOException,
                               JDOException

Initialize the PersistenceManagerFactory for the given location.

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

java.lang.IllegalArgumentException - in case of illegal property values

java.io.IOException - if the properties could not be loaded from the given location

JDOException - in case of JDO initialization errors

newPersistenceManagerFactory

protected PersistenceManagerFactory newPersistenceManagerFactory(java.lang.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:

javax.jdo.JDOHelper#getPersistenceManagerFactory(String)

newPersistenceManagerFactory

protected PersistenceManagerFactory newPersistenceManagerFactory(java.util.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:

javax.jdo.JDOHelper#getPersistenceManagerFactory(java.util.Map)

getObject

public PersistenceManagerFactory getObject()

Return the singleton PersistenceManagerFactory.

Specified by:

getObject in interface FactoryBean<PersistenceManagerFactory>

Returns:

an instance of the bean (can be null)

See Also:

FactoryBeanNotInitializedException

getObjectType

public java.lang.Class<? extends PersistenceManagerFactory> getObjectType()

Description copied from interface: FactoryBean

Return the type of object that this FactoryBean creates, or null if not known in advance.

This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

NOTE: Autowiring will simply ignore FactoryBeans that return null here. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Specified by:

getObjectType in interface FactoryBean<PersistenceManagerFactory>

Returns:

the type of object that this FactoryBean creates, or null if not known at the time of the call

See Also:

ListableBeanFactory.getBeansOfType(java.lang.Class<T>)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the object managed by this factory a singleton? That is, will FactoryBean.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. Hence, do not return true unless the FactoryBean always exposes the same reference.

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

NOTE: This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean.isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

Specified by:

isSingleton in interface FactoryBean<PersistenceManagerFactory>

Returns:

whether the exposed object is a singleton

See Also:

FactoryBean.getObject(), SmartFactoryBean.isPrototype()

translateExceptionIfPossible

public DataAccessException translateExceptionIfPossible(java.lang.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.

Specified by:

translateExceptionIfPossible in interface PersistenceExceptionTranslator

Parameters:

ex - a RuntimeException to translate

Returns:

the corresponding DataAccessException (or null if the exception could not be translated, as in this case it may result from user code rather than from an actual persistence problem)

See Also:

PersistenceExceptionTranslationPostProcessor, JdoDialect.translateException(JDOException), PersistenceManagerFactoryUtils.convertJdoAccessException(JDOException)

destroy

public void destroy()

Close the PersistenceManagerFactory on bean factory shutdown.

Specified by:

destroy in interface DisposableBean