Class SpringPersistenceManagerProxyBean
- java.lang.Object
- org.springframework.orm.jdo.support.SpringPersistenceManagerProxyBean
- All Implemented Interfaces:
FactoryBean<javax.jdo.PersistenceManager>
,InitializingBean
public class SpringPersistenceManagerProxyBean extends Object implements FactoryBean<javax.jdo.PersistenceManager>, InitializingBean
Proxy that implements thePersistenceManager
interface, delegating to the current thread-bound PersistenceManager (the Spring-managed transactional PersistenceManager or the single OpenPersistenceManagerInView PersistenceManager, if any) on each invocation. This class makes such a Spring-style PersistenceManager proxy available for bean references.The main advantage of this proxy is that it allows DAOs to work with a plain JDO PersistenceManager reference in JDO 3.0 style (see
PersistenceManagerFactory.getPersistenceManagerProxy()
), while still participating in Spring's resource and transaction management.The behavior of this proxy matches the behavior that the JDO 3.0 spec defines for a PersistenceManager proxy. Hence, DAOs could seamlessly switch between
StandardPersistenceManagerProxyBean
and this Spring-style proxy, receiving the reference through Dependency Injection. This will work without any Spring API dependencies in the DAO code!- Since:
- 3.0
- Author:
- Juergen Hoeller
- See Also:
StandardPersistenceManagerProxyBean
,PersistenceManagerFactory.getPersistenceManagerProxy()
,PersistenceManagerFactoryUtils.getPersistenceManager(javax.jdo.PersistenceManagerFactory, boolean)
,PersistenceManagerFactoryUtils.releasePersistenceManager(javax.jdo.PersistenceManager, javax.jdo.PersistenceManagerFactory)
Constructor Summary
Constructors Constructor Description SpringPersistenceManagerProxyBean()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
afterPropertiesSet()
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.protected JdoDialect
getJdoDialect()
Return the JDO dialect to use for this proxy.javax.jdo.PersistenceManager
getObject()
Return an instance (possibly shared or independent) of the object managed by this factory.Class<? extends javax.jdo.PersistenceManager>
getObjectType()
Return the type of object that this FactoryBean creates, ornull
if not known in advance.protected javax.jdo.PersistenceManagerFactory
getPersistenceManagerFactory()
Return the target PersistenceManagerFactory for this proxy.protected Class<? extends javax.jdo.PersistenceManager>
getPersistenceManagerInterface()
Return the PersistenceManager interface to expose.protected boolean
isAllowCreate()
Return whether the PersistenceManagerFactory proxy is allowed to create a non-transactional PersistenceManager when no transactional PersistenceManager can be found for the current thread.boolean
isSingleton()
Is the object managed by this factory a singleton? That is, willFactoryBean.getObject()
always return the same object (a reference that can be cached)?void
setAllowCreate(boolean allowCreate)
Set whether the PersistenceManagerFactory proxy is allowed to create a non-transactional PersistenceManager when no transactional PersistenceManager can be found for the current thread.void
setJdoDialect(JdoDialect jdoDialect)
Set the JDO dialect to use for this proxy.void
setPersistenceManagerFactory(javax.jdo.PersistenceManagerFactory persistenceManagerFactory)
Set the target PersistenceManagerFactory for this proxy.void
setPersistenceManagerInterface(Class<? extends javax.jdo.PersistenceManager> persistenceManagerInterface)
Specify the PersistenceManager interface to expose, possibly including vendor extensions.
Constructor Detail
SpringPersistenceManagerProxyBean
public SpringPersistenceManagerProxyBean()
Method Detail
setPersistenceManagerFactory
public void setPersistenceManagerFactory(javax.jdo.PersistenceManagerFactory persistenceManagerFactory)
Set the target PersistenceManagerFactory for this proxy.
getPersistenceManagerFactory
protected javax.jdo.PersistenceManagerFactory getPersistenceManagerFactory()
Return the target PersistenceManagerFactory for this proxy.
setJdoDialect
public void setJdoDialect(JdoDialect jdoDialect)
Set the JDO dialect to use for this proxy.Default is a DefaultJdoDialect based on the PersistenceManagerFactory's underlying DataSource, if any.
getJdoDialect
protected JdoDialect getJdoDialect()
Return the JDO dialect to use for this proxy.
setPersistenceManagerInterface
public void setPersistenceManagerInterface(Class<? extends javax.jdo.PersistenceManager> persistenceManagerInterface)
Specify the PersistenceManager interface to expose, possibly including vendor extensions.Default is the standard
javax.jdo.PersistenceManager
interface.
getPersistenceManagerInterface
protected Class<? extends javax.jdo.PersistenceManager> getPersistenceManagerInterface()
Return the PersistenceManager interface to expose.
setAllowCreate
public void setAllowCreate(boolean allowCreate)
Set whether the PersistenceManagerFactory proxy is allowed to create a non-transactional PersistenceManager when no transactional PersistenceManager can be found for the current thread.Default is "true". Can be turned off to enforce access to transactional PersistenceManagers, which safely allows for DAOs written to get a PersistenceManager without explicit closing (i.e. a
PersistenceManagerFactory.getPersistenceManager()
call without correspondingPersistenceManager.close()
call).
isAllowCreate
protected boolean isAllowCreate()
Return whether the PersistenceManagerFactory proxy is allowed to create a non-transactional PersistenceManager when no transactional PersistenceManager can be found for the current thread.
afterPropertiesSet
public void afterPropertiesSet()
Description copied from interface:InitializingBean
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
- Specified by:
afterPropertiesSet
in interfaceInitializingBean
getObject
public javax.jdo.PersistenceManager 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 FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding
FactoryBeanNotInitializedException
.As of Spring 2.0, FactoryBeans are allowed to return
null
objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.- Specified by:
getObject
in interfaceFactoryBean<javax.jdo.PersistenceManager>
- Returns:
- an instance of the bean (can be
null
) - See Also:
FactoryBeanNotInitializedException
getObjectType
public Class<? extends javax.jdo.PersistenceManager> getObjectType()
Description copied from interface:FactoryBean
Return the type of object that this FactoryBean creates, ornull
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 interfaceFactoryBean<javax.jdo.PersistenceManager>
- 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, willFactoryBean.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 returntrue
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 extendedSmartFactoryBean
interface may explicitly indicate independent instances through itsSmartFactoryBean.isPrototype()
method. PlainFactoryBean
implementations which do not implement this extended interface are simply assumed to always return independent instances if theisSingleton()
implementation returnsfalse
.- Specified by:
isSingleton
in interfaceFactoryBean<javax.jdo.PersistenceManager>
- Returns:
- whether the exposed object is a singleton
- See Also:
FactoryBean.getObject()
,SmartFactoryBean.isPrototype()