org.springframework.orm.jdo
Class TransactionAwarePersistenceManagerFactoryProxy

java.lang.Object
  org.springframework.orm.jdo.TransactionAwarePersistenceManagerFactoryProxy

All Implemented Interfaces:

FactoryBean

public class TransactionAwarePersistenceManagerFactoryProxy
extends Object
implements FactoryBean

This FactoryBean exposes a proxy for a target JDO PersistenceManagerFactory, returning the current thread-bound PersistenceManager (the Spring-managed transactional PersistenceManager or a the single OpenPersistenceManagerInView PersistenceManager) on getPersistenceManager(), if any.

Essentially, getPersistenceManager() calls get seamlessly forwarded to PersistenceManagerFactoryUtils.getPersistenceManager. Furthermore, PersistenceManager.close calls get forwarded to PersistenceManagerFactoryUtils.releasePersistenceManager.

The main advantage of this proxy is that it allows DAOs to work with a plain JDO PersistenceManagerFactory reference, while still participating in Spring's (or a J2EE server's) resource and transaction management. DAOs will only rely on the JDO API in such a scenario, without any Spring dependencies.

Note that the behavior of this proxy matches the behavior that the JDO spec defines for a PersistenceManagerFactory as exposed by a JCA connector, when deployed in a J2EE server. Hence, DAOs could seamlessly switch between a JNDI PersistenceManagerFactory and this proxy for a local PersistenceManagerFactory, receiving the reference through Dependency Injection. This will work without any Spring API dependencies in the DAO code!

It is usually preferable to write your JDO-based DAOs with Spring's JdoTemplate, offering benefits such as consistent data access exceptions instead of JDOExceptions at the DAO layer. However, Spring's resource and transaction management (and Dependency Injection) will work for DAOs written against the plain JDO API too.

Of course, you can still access the target PersistenceManagerFactory even when your DAOs go through this proxy, by defining a bean reference that points directly at your target PersistenceManagerFactory bean.

Since:

1.2

Author:

Juergen Hoeller

See Also:

PersistenceManagerFactory.getPersistenceManager(), PersistenceManager.close(), PersistenceManagerFactoryUtils.getPersistenceManager(javax.jdo.PersistenceManagerFactory, boolean), PersistenceManagerFactoryUtils.releasePersistenceManager(javax.jdo.PersistenceManager, javax.jdo.PersistenceManagerFactory)

Constructor Summary

TransactionAwarePersistenceManagerFactoryProxy()

Method Summary

Object	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
Class	getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance.
javax.jdo.PersistenceManagerFactory	getTargetPersistenceManagerFactory() Return the target JDO PersistenceManagerFactory that this proxy delegates to.
boolean	isSingleton() Is the bean managed by this factory a singleton or a prototype?
void	setTargetPersistenceManagerFactory(javax.jdo.PersistenceManagerFactory target) Set the target JDO PersistenceManagerFactory that this proxy should delegate to.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionAwarePersistenceManagerFactoryProxy

public TransactionAwarePersistenceManagerFactoryProxy()

Method Detail

setTargetPersistenceManagerFactory

public void setTargetPersistenceManagerFactory(javax.jdo.PersistenceManagerFactory target)

Set the target JDO PersistenceManagerFactory that this proxy should delegate to. This should be the raw PersistenceManagerFactory, as accessed by JdoTransactionManager.

See Also:

JdoTransactionManager

getTargetPersistenceManagerFactory

public javax.jdo.PersistenceManagerFactory getTargetPersistenceManagerFactory()

Return the target JDO PersistenceManagerFactory that this proxy delegates to.

getObject

public Object getObject()

Description copied from interface: FactoryBean

Return an instance (possibly shared or independent) of the object managed by this factory. As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

If this method returns null, the factory will consider the FactoryBean as not fully initialized and throw a corresponding FactoryBeanNotInitializedException.

Specified by:

getObject in interface FactoryBean

Returns:

an instance of the bean (should not be null; a null value will be considered as an indication of incomplete initialization)

See Also:

FactoryBeanNotInitializedException

getObjectType

public Class getObjectType()

Description copied from interface: FactoryBean

Return the type of object that this FactoryBean creates, or null if not known in advance. This allows to check for specific types of beans without instantiating objects, for example on autowiring.

For a singleton, this 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

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)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the bean managed by this factory a singleton or a prototype? That is, will getObject() always return the same object?

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

Specified by:

isSingleton in interface FactoryBean

Returns:

if this bean is a singleton