org.infinispan.transaction.xa

Class TransactionXaAdapter

java.lang.Object

org.infinispan.transaction.AbstractEnlistmentAdapter

org.infinispan.transaction.xa.TransactionXaAdapter

All Implemented Interfaces:

XAResource

public class TransactionXaAdapter
extends AbstractEnlistmentAdapter
implements XAResource

This acts both as an local CacheTransaction and implementor of an XAResource that will be called by tx manager on various tx stages.

Since:

4.0

Author:

Mircea.Markus@jboss.com

Field Summary

Fields inherited from class org.infinispan.transaction.AbstractEnlistmentAdapter

config

Fields inherited from interface javax.transaction.xa.XAResource

TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY

Constructor Summary

Constructors

Constructor and Description
TransactionXaAdapter(LocalXaTransaction localTransaction, TransactionTable txTable, RecoveryManager rm, TransactionCoordinator txCoordinator, CommandsFactory commandsFactory, RpcManager rpcManager, ClusteringDependentLogic clusteringDependentLogic, Configuration config)
TransactionXaAdapter(TransactionTable txTable, RecoveryManager rm, TransactionCoordinator txCoordinator, CommandsFactory commandsFactory, RpcManager rpcManager, ClusteringDependentLogic clusteringDependentLogic, Configuration config)

Method Summary

Methods

Modifier and Type	Method and Description
void	commit(Xid externalXid, boolean isOnePhase) Same comment as for prepare(javax.transaction.xa.Xid) applies for commit.
void	end(Xid externalXid, int i) Called to disassociate the resource from a transaction.
boolean	equals(Object o)
void	forget(Xid externalXid) Tells the resource manager to forget about a heuristic decision.
LocalXaTransaction	getLocalTransaction()
int	getTransactionTimeout() Get the current transaction timeout value for this resource.
boolean	isSameRM(XAResource xaResource) the only situation in which it returns true is when the other xa resource pertains to the same cache, on the same node.
int	prepare(Xid externalXid) This can be call for any transaction object.
Xid[]	recover(int flag) Return a list of transactions that are in a prepared or heuristically state.
void	rollback(Xid externalXid) Same comment as for prepare(javax.transaction.xa.Xid) applies for commit.
boolean	setTransactionTimeout(int i) Set the transaction timeout value for this resource.
void	start(Xid externalXid, int i) Called to associate the resource with a transaction.
String	toString()

Methods inherited from class org.infinispan.transaction.AbstractEnlistmentAdapter

hashCode, releaseLocksForCompletedTransaction

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TransactionXaAdapter

public TransactionXaAdapter(LocalXaTransaction localTransaction,
                    TransactionTable txTable,
                    RecoveryManager rm,
                    TransactionCoordinator txCoordinator,
                    CommandsFactory commandsFactory,
                    RpcManager rpcManager,
                    ClusteringDependentLogic clusteringDependentLogic,
                    Configuration config)

TransactionXaAdapter

public TransactionXaAdapter(TransactionTable txTable,
                    RecoveryManager rm,
                    TransactionCoordinator txCoordinator,
                    CommandsFactory commandsFactory,
                    RpcManager rpcManager,
                    ClusteringDependentLogic clusteringDependentLogic,
                    Configuration config)

Method Detail

prepare

public int prepare(Xid externalXid)
            throws XAException

This can be call for any transaction object. See Section 3.4.6 (Resource Sharing) from JTA spec v1.1.

Specified by:

prepare in interface XAResource

Parameters:

externalXid - The id of the transaction to prepare to commit work for.

Returns:

Either XAResource.XA_OK or XAResource.XA_RDONLY.

Throws:

XAException - If an error occurred.

commit

public void commit(Xid externalXid,
          boolean isOnePhase)
            throws XAException

Same comment as for prepare(javax.transaction.xa.Xid) applies for commit.

Specified by:

commit in interface XAResource

Parameters:

externalXid - The id of the transaction to commit work for.

isOnePhase - If true, the transaction manager is using one-phase optimization.

Throws:

XAException - If an error occurred.

rollback

public void rollback(Xid externalXid)
              throws XAException

Same comment as for prepare(javax.transaction.xa.Xid) applies for commit.

Specified by:

rollback in interface XAResource

Parameters:

externalXid - The id of the transaction to commit work for.

Throws:

XAException - If an error occurred.

start

public void start(Xid externalXid,
         int i)
           throws XAException

Description copied from interface: XAResource

Called to associate the resource with a transaction. If the flags argument is XAResource.TMNOFLAGS, the transaction must not previously have been seen by this resource manager, or an XAException with error code XAER_DUPID will be thrown. If the flags argument is XAResource.TMJOIN, the resource will join a transaction previously seen by tis resource manager. If the flags argument is XAResource.TMRESUME the resource will resume the transaction association that was suspended with end(TMSUSPEND).

Specified by:

start in interface XAResource

Parameters:

externalXid - The id of the transaction to associate with.

i - Must be either XAResource.TMNOFLAGS, XAResource.TMJOIN or XAResource.TMRESUME.

Throws:

XAException - If an error occurred.

end

public void end(Xid externalXid,
       int i)
         throws XAException

Description copied from interface: XAResource

Called to disassociate the resource from a transaction. If the flags argument is XAResource.TMSUCCESS, the portion of work was done sucessfully. If the flags argument is XAResource.TMFAIL, the portion of work failed. The resource manager may mark the transaction for rollback only to avoid the transaction being committed. If the flags argument is XAResource.TMSUSPEND the resource will temporarily suspend the transaction association. The transaction must later be re-associated by giving the XAResource.TMRESUME flag to the start method.

Specified by:

end in interface XAResource

Parameters:

externalXid - The id of the transaction to disassociate from.

i - Must be either XAResource.TMSUCCESS, XAResource.TMFAIL or XAResource.TMSUSPEND.

Throws:

XAException - If an error occurred.

forget

public void forget(Xid externalXid)
            throws XAException

Description copied from interface: XAResource

Tells the resource manager to forget about a heuristic decision.

Specified by:

forget in interface XAResource

Parameters:

externalXid - The id of the transaction that was ended with a heuristic decision.

Throws:

XAException - If an error occurred.

getTransactionTimeout

public int getTransactionTimeout()
                          throws XAException

Description copied from interface: XAResource

Get the current transaction timeout value for this resource.

Specified by:

getTransactionTimeout in interface XAResource

Returns:

The current timeout value, in seconds.

Throws:

XAException - If an error occurred.

isSameRM

public boolean isSameRM(XAResource xaResource)
                 throws XAException

the only situation in which it returns true is when the other xa resource pertains to the same cache, on the same node.

Specified by:

isSameRM in interface XAResource

Throws:

XAException - If an error occurred.

recover

public Xid[] recover(int flag)
              throws XAException

Description copied from interface: XAResource

Return a list of transactions that are in a prepared or heuristically state. This method looks not only at the resource it is invoked on, but also on all other resources managed by the same resource manager. It is intended to be used by the application server when recovering after a server crash.

A recovery scan is done with one or more calls to this method. At the first call, XAResource.TMSTARTRSCAN must be in the flag argument to indicate that the scan should be started. During the recovery scan, the resource manager maintains an internal cursor that keeps track of the progress of the recovery scan. To end the recovery scan, the XAResource.TMENDRSCAN must be passed in the flag argument.

Specified by:

recover in interface XAResource

Parameters:

flag - Must be either XAResource.TMNOFLAGS, XAResource.TMSTARTRSCAN, XAResource.TMENDRSCAN or TMSTARTRSCAN|TMENDRSCAN.

Returns:

An array of zero or more transaction ids.

Throws:

XAException - If an error occurred.

setTransactionTimeout

public boolean setTransactionTimeout(int i)
                              throws XAException

Description copied from interface: XAResource

Set the transaction timeout value for this resource. If the seconds argument is 0, the timeout value is set to the default timeout value of the resource manager. Not all resource managers support setting the timeout value. If the resource manager does not support setting the timeout value, it should return false.

Specified by:

setTransactionTimeout in interface XAResource

Parameters:

i - The timeout value, in seconds.

Returns:

True if the timeout value could be set, otherwise false.

Throws:

XAException - If an error occurred.

toString

public String toString()

Overrides:

toString in class Object

getLocalTransaction

public LocalXaTransaction getLocalTransaction()

equals

public boolean equals(Object o)

Overrides:

equals in class Object