Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.atomikos.recovery.xa.XARecoveryManager Maven / Gradle / Ivy
/**
* Copyright (C) 2000-2023 Atomikos
*
* LICENSE CONDITIONS
*
* See http://www.atomikos.com/Main/WhichLicenseApplies for details.
*/
package com.atomikos.recovery.xa;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.transaction.xa.XAException;
import javax.transaction.xa.XAResource;
import com.atomikos.datasource.xa.RecoveryScan;
import com.atomikos.datasource.xa.RecoveryScan.XidSelector;
import com.atomikos.datasource.xa.XAExceptionHelper;
import com.atomikos.datasource.xa.XID;
import com.atomikos.icatch.config.Configuration;
import com.atomikos.icatch.event.transaction.ParticipantHeuristicEvent;
import com.atomikos.logging.Logger;
import com.atomikos.logging.LoggerFactory;
import com.atomikos.publish.EventPublisher;
import com.atomikos.recovery.LogException;
import com.atomikos.recovery.LogReadException;
import com.atomikos.recovery.PendingTransactionRecord;
import com.atomikos.recovery.TxState;
public class XARecoveryManager {
private static final Logger LOGGER = LoggerFactory.createLogger(XARecoveryManager.class);
private static XARecoveryManager instance;
private XidSelector xidSelector;
private String tmUniqueName;
private long maxTimeout;
private Map previousXidRepositoryMap = new HashMap();
public XARecoveryManager(final String tmUniqueName) {
this.tmUniqueName = tmUniqueName;
this.xidSelector=new XidSelector() {
@Override
public boolean selects(XID xid) {
boolean ret = false;
String branch = xid.getBranchQualifierAsString();
if ( branch.startsWith ( tmUniqueName ) ) {
ret = true;
if(LOGGER.isDebugEnabled()){
LOGGER.logDebug(this + ": recovering XID: " + xid);
}
} else {
if(LOGGER.isDebugEnabled()){
LOGGER.logDebug(this + ": XID " + xid +
" with branch " + branch + " is not under my responsibility");
}
}
return ret;
}
@Override
public String toString() {
return XARecoveryManager.this.toString();
}
};
maxTimeout = Configuration.getConfigProperties().getMaxTimeout();
}
public static XARecoveryManager getInstance() {
return instance;
}
public static void installXARecoveryManager(String tmUniqueName) {
if (tmUniqueName == null) {
instance = null;
} else {
instance = new XARecoveryManager(tmUniqueName);
}
}
public boolean recover(XAResource xaResource, long startOfRecoveryScan, Collection expiredCommittingCoordinators, Collection indoubtForeignCoordinatorsToKeep, String uniqueResourceName) throws XAException, LogReadException {
List xidsToRecover = retrievePreparedXidsFromXaResource(xaResource);
PreviousXidRepository previousXidRepository = getPreviousXidRepository(uniqueResourceName);
boolean success = recoverXids(xidsToRecover, previousXidRepository, expiredCommittingCoordinators, indoubtForeignCoordinatorsToKeep, xaResource, startOfRecoveryScan);
previousXidRepository.forgetXidsExpiredAt(startOfRecoveryScan); // ignore if success or not: any pending XIDs have been added for the future
return success;
}
private PreviousXidRepository getPreviousXidRepository(
String uniqueResourceName) {
PreviousXidRepository ret = previousXidRepositoryMap.get(uniqueResourceName);
if (ret == null) {
ret = new InMemoryPreviousXidRepository();
previousXidRepositoryMap.put(uniqueResourceName, ret);
}
return ret;
}
private boolean recoverXids(List xidsToRecover, PreviousXidRepository previousXidRepository,
Collection expiredCommittingCoordinators, Collection indoubtForeignCoordinatorsToKeep, XAResource xaResource,
long startOfRecoveryScan) {
boolean allExpiredCommitsDone = true;
long xidDetectionTime = System.currentTimeMillis();
List expiredPreviousXids = previousXidRepository.findXidsExpiredAt(startOfRecoveryScan);
Collection expiredCommittingCoordinatorIds = PendingTransactionRecord.extractCoordinatorIds(expiredCommittingCoordinators, TxState.COMMITTING, TxState.IN_DOUBT); // in-doubt for subtxs with committing superior
Collection foreignIndoubtCoordinatorIds = PendingTransactionRecord.extractCoordinatorIds(indoubtForeignCoordinatorsToKeep, TxState.IN_DOUBT); // filter out what remote recovery has already resolved
for (XID xid : xidsToRecover) {
String coordinatorId = xid.getGlobalTransactionIdAsString();
if (expiredCommittingCoordinatorIds.contains(coordinatorId)) {
allExpiredCommitsDone = allExpiredCommitsDone && replayCommit(xid, xaResource);
} else if (expiredPreviousXids.contains(xid)) {
if (foreignIndoubtCoordinatorIds.contains(coordinatorId) || !presumedAbort(xid, xaResource)) {
//foreign indoubt, or presumed abort failed (probably hazard) => try again later next scan (ASAP)
previousXidRepository.remember(xid, startOfRecoveryScan + 1);
}
} else {
previousXidRepository.remember(xid, xidDetectionTime + maxTimeout); // unknown xid => wait for maxTimeout
}
}
return allExpiredCommitsDone;
}
private boolean replayCommit(XID xid, XAResource xaResource) {
if (LOGGER.isDebugEnabled()) LOGGER.logDebug(this + ": replaying commit of xid: " + xid);
boolean forgetInLog = false;
try {
xaResource.commit(xid, false);
forgetInLog = true;
} catch (XAException e) {
if (alreadyHeuristicallyTerminatedByResource(e)) {
forgetInLog = handleHeuristicTerminationByResource(xid, xaResource, e, true);;
} else if (xidTerminatedInResourceByConcurrentCommit(e)) {
forgetInLog = true;
} else {
LOGGER.logWarning(XAExceptionHelper.formatLogMessage("Transient error while replaying commit", e, "will retry later"));
}
}
return forgetInLog;
}
private boolean alreadyHeuristicallyTerminatedByResource(XAException e) {
boolean ret = false;
switch (e.errorCode) {
case XAException.XA_HEURHAZ:
case XAException.XA_HEURCOM:
case XAException.XA_HEURMIX:
case XAException.XA_HEURRB:
ret = true;
}
return ret;
}
private boolean xidTerminatedInResourceByConcurrentCommit(XAException e) {
return xidNoLongerKnownByResource(e);
}
private boolean xidTerminatedInResourceByConcurrentRollback(XAException e) {
return xidNoLongerKnownByResource(e);
}
private boolean xidNoLongerKnownByResource(XAException e) {
boolean ret = false;
switch (e.errorCode) {
case XAException.XAER_NOTA:
case XAException.XAER_INVAL:
ret = true;
}
return ret;
}
private boolean handleHeuristicTerminationByResource(XID xid,
XAResource xaResource, XAException e, boolean commitDesired) {
boolean forgetInLog = true;
try {
notifyLogOfHeuristic(xid, e, commitDesired);
if (e.errorCode != XAException.XA_HEURHAZ) {
forgetXidInXaResource(xid, xaResource);
} else {
forgetInLog = false;
}
} catch (LogException transientLogWriteException) {
LOGGER.logWarning("Failed to log heuristic termination of Xid: "+xid+" - ignoring to retry later", transientLogWriteException);
}
return forgetInLog;
}
private void forgetXidInXaResource(XID xid, XAResource xaResource) {
try {
xaResource.forget(xid);
} catch (XAException e) {
LOGGER.logWarning(XAExceptionHelper.formatLogMessage("Unexpected error during forget", e, "ignoring"));
// ignore: worst case, heuristic xid is presented again on next recovery scan
}
}
private void notifyLogOfHeuristic(XID xid, XAException e, boolean commitDesired ) throws LogException {
switch (e.errorCode) {
case XAException.XA_HEURHAZ:
fireTransactionHeuristicEvent(xid, TxState.HEUR_HAZARD);
break;
case XAException.XA_HEURCOM:
if(!commitDesired){
fireTransactionHeuristicEvent(xid, TxState.HEUR_COMMITTED);
}
break;
case XAException.XA_HEURMIX:
fireTransactionHeuristicEvent(xid, TxState.HEUR_MIXED);
break;
case XAException.XA_HEURRB:
if(commitDesired) {
fireTransactionHeuristicEvent(xid, TxState.HEUR_ABORTED);
}
break;
default:
break;
}
}
private void fireTransactionHeuristicEvent(XID xid, TxState state) {
ParticipantHeuristicEvent event = new ParticipantHeuristicEvent(xid.getGlobalTransactionIdAsString(), xid.toString(), state);
EventPublisher.INSTANCE.publish(event);
}
private boolean presumedAbort(XID xid, XAResource xaResource) {
boolean ret = false;
if (LOGGER.isDebugEnabled()) LOGGER.logDebug(this + ": presumed abort of xid: " + xid);
try {
xaResource.rollback(xid);
ret = true;
} catch (XAException e) {
if (alreadyHeuristicallyTerminatedByResource(e)) {
ret = handleHeuristicTerminationByResource(xid, xaResource, e, false);
} else if (xidTerminatedInResourceByConcurrentRollback(e)) {
ret = true;
} else {
LOGGER.logWarning(XAExceptionHelper.formatLogMessage("Unexpected exception during recovery", e, "ignoring to retry later"));
}
}
return ret;
}
private List retrievePreparedXidsFromXaResource(XAResource xaResource) throws XAException {
List ret = new ArrayList();
try {
ret = RecoveryScan.recoverXids(xaResource, xidSelector);
} catch (XAException e) {
LOGGER.logWarning(XAExceptionHelper.formatLogMessage("Error while retrieving xids from resource", e, "will retry later"));
throw e;
}
return ret;
}
@Override
public String toString() {
return "XARecoveryManager " + tmUniqueName;
}
public boolean hasPendingXids(String uniqueResourceName) {
PreviousXidRepository previousXidRepository = getPreviousXidRepository(uniqueResourceName);
return !previousXidRepository.isEmpty();
}
}
