org.springframework.transaction.jta
Class JotmFactoryBean

java.lang.Object
  org.springframework.transaction.jta.JotmFactoryBean

All Implemented Interfaces:

DisposableBean, FactoryBean

public class JotmFactoryBean
extends Object
implements FactoryBean, DisposableBean

FactoryBean that retrieves the JTA UserTransaction/TransactionManager for ObjectWeb's JOTM. Will retrieve an already active JOTM instance if found (e.g. if running in JOnAS), else create a new local JOTM instance. The same object implements both the UserTransaction and the TransactionManager interface, as returned by this FactoryBean.

A local JOTM instance is well-suited for working in conjunction with ObjectWeb's XAPool, e.g. with bean definitions like the following:

 <bean id="jotm" class="org.springframework.transaction.jta.JotmFactoryBean"/>

 <bean id="transactionManager" class="org.springframework.transaction.jta.JtaTransactionManager">
   <property name="userTransaction" ref="jotm"/>
 </bean>

 <bean id="innerDataSource" class="org.enhydra.jdbc.standard.StandardXADataSource" destroy-method="shutdown">
   <property name="transactionManager" ref="jotm"/>
   <property name="driverName" value="..."/>
   <property name="url" value="..."/>
   <property name="user" value="..."/>
   <property name="password" value="..."/>
 </bean>

 <bean id="dataSource" class="org.enhydra.jdbc.pool.StandardXAPoolDataSource" destroy-method="shutdown">
   <property name="dataSource" ref="innerDataSource"/>
   <property name="user" value="..."/>
   <property name="password" value="..."/>
   <property name="maxSize" value="..."/>
 </bean>

Uses JOTM's static access method to obtain the JOTM Current object, which implements both the UserTransaction and the TransactionManager interface.

Since:

21.01.2004

Author:

Juergen Hoeller

See Also:

JtaTransactionManager.setUserTransaction(javax.transaction.UserTransaction), JtaTransactionManager.setTransactionManager(javax.transaction.TransactionManager), Current

Constructor Summary

JotmFactoryBean()

Method Summary

void	destroy() Stop the local JOTM instance, if created by this FactoryBean.
org.objectweb.jotm.Jotm	getJotm() Return the JOTM instance created by this factory bean, if any.
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.
boolean	isSingleton() Is the bean managed by this factory a singleton or a prototype?
void	setDefaultTimeout(int defaultTimeout) Set the default transaction timeout for the JOTM instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

JotmFactoryBean

public JotmFactoryBean()
                throws NamingException

Throws:

NamingException

Method Detail

setDefaultTimeout

public void setDefaultTimeout(int defaultTimeout)

Set the default transaction timeout for the JOTM instance.

Should only be called for a local JOTM instance, not when accessing an existing (shared) JOTM instance.

getJotm

public org.objectweb.jotm.Jotm getJotm()

Return the JOTM instance created by this factory bean, if any. Will be null if an already active JOTM instance is used.

Application code should never need to access this.

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 (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.

Specified by:

isSingleton in interface FactoryBean

Returns:

if this bean is a singleton

See Also:

FactoryBean.getObject()

destroy

public void destroy()

Stop the local JOTM instance, if created by this FactoryBean.

Specified by:

destroy in interface DisposableBean