org.infinispan.transaction.xa.recovery
Interface RecoveryManager

All Known Implementing Classes:

RecoveryManagerImpl

public interface RecoveryManager

RecoveryManager is the component responsible with managing recovery related information and the functionality associated with it. Refer to this document for details on the design of recovery.

Since:

5.0

Author:

Mircea.Markus@jboss.com

Nested Class Summary

static interface	RecoveryManager.InDoubtTxInfo An object describing in doubt transaction's state.
static interface	RecoveryManager.RecoveryIterator Stateful structure allowing prepared-tx retrieval in a batch-oriented manner, as required by XAResource.recover(int).

Method Summary

String	forceTransactionCompletion(Xid xid, boolean commit) Replays the given transaction by re-running the prepare and commit.
String	forceTransactionCompletionFromCluster(Xid xid, Address where, boolean commit) This method invokes forceTransactionCompletion(javax.transaction.xa.Xid, boolean) on the specified node.
Set<RecoveryManager.InDoubtTxInfo>	getInDoubtTransactionInfo() Same as getInDoubtTransactionInfoFromCluster(), but only returns transactions from the local node.
Set<RecoveryManager.InDoubtTxInfo>	getInDoubtTransactionInfoFromCluster() Returns a Set containing all the in-doubt transactions from the cluster, including the local node.
List<Xid>	getInDoubtTransactions() Local call that returns a list containing:
RecoveryAwareTransaction	getPreparedTransaction(Xid xid) Local call returning the remote transaction identified by the supplied xid or null.
RecoveryManager.RecoveryIterator	getPreparedTransactionsFromCluster() Returns the list of transactions in prepared state from both local and remote cluster nodes.
boolean	isTransactionPrepared(GlobalTransaction globalTx) Checks both internal state and transaction table's state for the given tx.
void	removeRecoveryInformation(Long internalId) Same as removeRecoveryInformation(javax.transaction.xa.Xid) but identifies the tx by its internal id.
void	removeRecoveryInformation(Xid xid) Remove recovery information stored on this node (doesn't involve rpc).
void	removeRecoveryInformationFromCluster(Collection<Address> where, long internalId, boolean sync) Same as #removeRecoveryInformationFromCluster(java.util.Collection but the transaction is identified by its internal id, and not by its xid.
void	removeRecoveryInformationFromCluster(Collection<Address> where, Xid xid, boolean sync) Removes from the specified nodes (or all nodes if the value of 'where' is null) the recovery information associated with these Xids.

Method Detail

getPreparedTransactionsFromCluster

RecoveryManager.RecoveryIterator getPreparedTransactionsFromCluster()

Returns the list of transactions in prepared state from both local and remote cluster nodes. Implementation can take advantage of several optimisations:

 - in order to get all tx from the cluster a broadcast is performed. This can be performed only once (assuming the call
   is successful), the first time this method is called. After that a local, cached list of tx prepared on this node is returned.
 - during the broadcast just return the list of prepared transactions that are not originated on other active nodes of the
 cluster.
 

getInDoubtTransactionInfoFromCluster

Set<RecoveryManager.InDoubtTxInfo> getInDoubtTransactionInfoFromCluster()

Returns a Set containing all the in-doubt transactions from the cluster, including the local node. This does not include transactions that are prepared successfully and for which the originator is still in the cluster.

See Also:

RecoveryManager.InDoubtTxInfo

getInDoubtTransactionInfo

Set<RecoveryManager.InDoubtTxInfo> getInDoubtTransactionInfo()

Same as getInDoubtTransactionInfoFromCluster(), but only returns transactions from the local node.

removeRecoveryInformationFromCluster

void removeRecoveryInformationFromCluster(Collection<Address> where,
                                          Xid xid,
                                          boolean sync)

Removes from the specified nodes (or all nodes if the value of 'where' is null) the recovery information associated with these Xids.

Parameters:

where - on which nodes should this be executed.

xid - the list of xids to be removed.

sync - execute sync or async (false)

removeRecoveryInformationFromCluster

void removeRecoveryInformationFromCluster(Collection<Address> where,
                                          long internalId,
                                          boolean sync)

Same as #removeRecoveryInformationFromCluster(java.util.Collection but the transaction is identified by its internal id, and not by its xid.

getInDoubtTransactions

List<Xid> getInDoubtTransactions()

Local call that returns a list containing:

 - all the remote transactions prepared on this node for which the originator(i.e. the node where the tx
 stared) is no longer part of the cluster.
 AND
 - all the locally originated transactions which are prepared and for which the commit failed
 

See Also:

RecoveryAwareRemoteTransaction.isInDoubt()

getPreparedTransaction

RecoveryAwareTransaction getPreparedTransaction(Xid xid)

Local call returning the remote transaction identified by the supplied xid or null.

forceTransactionCompletion

String forceTransactionCompletion(Xid xid,
                                  boolean commit)

Replays the given transaction by re-running the prepare and commit. This call expects the transaction to exist on this node either as a local or remote transaction.

Parameters:

xid - tx to commit or rollback

commit - if true tx is committed, if false it is rolled back

forceTransactionCompletionFromCluster

String forceTransactionCompletionFromCluster(Xid xid,
                                             Address where,
                                             boolean commit)

This method invokes forceTransactionCompletion(javax.transaction.xa.Xid, boolean) on the specified node.

isTransactionPrepared

boolean isTransactionPrepared(GlobalTransaction globalTx)

Checks both internal state and transaction table's state for the given tx. If it finds it, returns true if tx is prepared.

removeRecoveryInformation

void removeRecoveryInformation(Long internalId)

Same as removeRecoveryInformation(javax.transaction.xa.Xid) but identifies the tx by its internal id.

removeRecoveryInformation

void removeRecoveryInformation(Xid xid)

Remove recovery information stored on this node (doesn't involve rpc).

Parameters:

xid@see - #removeRecoveryInformation(java.util.Collection, javax.transaction.xa.Xid, boolean)