/*
* JBoss, Home of Professional Open Source
* Copyright 2006, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags.
* See the copyright.txt in the distribution for a
* full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
* This program is distributed in the hope that it will be useful, but WITHOUT A
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*
* (C) 2005-2006,
* @author JBoss Inc.
*/
/*
* Copyright (C) 2002,
*
* Hewlett-Packard Arjuna Labs,
* Newcastle upon Tyne,
* Tyne and Wear,
* UK.
*
* $Id: TransactionImple.java 2342 2006-03-30 13:06:17Z $
*/
package com.arjuna.ats.internal.jta.transaction.arjunacore;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import javax.transaction.RollbackException;
import javax.transaction.Status;
import javax.transaction.SystemException;
import javax.transaction.xa.XAException;
import javax.transaction.xa.XAResource;
import javax.transaction.xa.Xid;
import org.jboss.tm.ConnectableResource;
import org.jboss.tm.XAResourceWrapper;
import com.arjuna.ats.arjuna.common.Uid;
import com.arjuna.ats.arjuna.coordinator.AbstractRecord;
import com.arjuna.ats.arjuna.coordinator.ActionStatus;
import com.arjuna.ats.arjuna.coordinator.AddOutcome;
import com.arjuna.ats.arjuna.coordinator.BasicAction;
import com.arjuna.ats.arjuna.coordinator.ExceptionDeferrer;
import com.arjuna.ats.arjuna.coordinator.TransactionReaper;
import com.arjuna.ats.arjuna.exceptions.ObjectStoreException;
import com.arjuna.ats.arjuna.logging.tsLogger;
import com.arjuna.ats.internal.arjuna.abstractrecords.LastResourceRecord;
import com.arjuna.ats.internal.jta.resources.arjunacore.CommitMarkableResourceRecord;
import com.arjuna.ats.internal.jta.resources.arjunacore.SynchronizationImple;
import com.arjuna.ats.internal.jta.resources.arjunacore.XAOnePhaseResource;
import com.arjuna.ats.internal.jta.resources.arjunacore.XAResourceRecord;
import com.arjuna.ats.internal.jta.resources.arjunacore.XAResourceRecordWrappingPlugin;
import com.arjuna.ats.internal.jta.utils.XAUtils;
import com.arjuna.ats.internal.jta.utils.arjunacore.StatusConverter;
import com.arjuna.ats.internal.jta.xa.TxInfo;
import com.arjuna.ats.jta.common.JTAEnvironmentBean;
import com.arjuna.ats.jta.common.jtaPropertyManager;
import com.arjuna.ats.jta.exceptions.InactiveTransactionException;
import com.arjuna.ats.jta.exceptions.InvalidTerminationStateException;
import com.arjuna.ats.jta.logging.jtaLogger;
import com.arjuna.ats.jta.resources.LastResourceCommitOptimisation;
import com.arjuna.ats.jta.utils.JTAHelper;
import com.arjuna.ats.jta.utils.XAHelper;
import com.arjuna.ats.jta.xa.XAModifier;
import com.arjuna.ats.jta.xa.XidImple;
import com.arjuna.common.internal.util.propertyservice.BeanPopulator;
/*
* Is given an AtomicAction, but uses the TwoPhaseCoordinator aspects of it to
* ensure that the thread association continues.
*/
public class TransactionImple implements javax.transaction.Transaction,
com.arjuna.ats.jta.transaction.Transaction
{
/*
* Only works with AtomicAction and TwoPhaseCoordinator.
*/
/**
* Create a new transaction with the specified timeout.
*/
public TransactionImple(int timeout)
{
_theTransaction = new AtomicAction();
_theTransaction.begin(timeout);
_resources = new Hashtable();
_duplicateResources = new Hashtable();
_suspendCount = 0;
_xaTransactionTimeoutEnabled = getXATransactionTimeoutEnabled();
_txLocalResources = Collections.synchronizedMap(new HashMap());
}
/**
* Overloads Object.equals()
*/
public boolean equals(Object obj)
{
if (jtaLogger.logger.isTraceEnabled()) {
jtaLogger.logger.trace("TransactionImple.equals");
}
if (obj == null)
return false;
if (obj == this)
return true;
if (obj instanceof TransactionImple)
{
/*
* If we can't get either coordinator to compare, then assume
* transactions are different.
*/
try
{
TransactionImple tx = (TransactionImple) obj;
return tx.get_uid().equals(_theTransaction.get_uid());
}
catch (Exception e)
{
}
}
return false;
}
/**
* Return -1 if we fail.
*/
public int hashCode()
{
if (_theTransaction == null)
return -1;
else
return _theTransaction.get_uid().hashCode();
}
/**
* The JTA specification is vague on whether the calling thread can have any
* transaction associated with it. It does say that it need not have the
* same transaction as this one. We could call suspend prior to making these
* calls, but for now we do nothing.
*/
/**
* We should never throw a HeuristicRollbackException because if we get a
* HeuristicRollback from a resource, and can successfully rollback the
* other resources, this is then the same as having simply been forced to
* rollback the transaction during phase 1.
*/
public void commit() throws javax.transaction.RollbackException,
javax.transaction.HeuristicMixedException,
javax.transaction.HeuristicRollbackException,
java.lang.SecurityException, javax.transaction.SystemException,
java.lang.IllegalStateException
{
if (jtaLogger.logger.isTraceEnabled()) {
jtaLogger.logger.trace("TransactionImple.commit");
}
if (_theTransaction != null)
{
switch (_theTransaction.status())
{
case ActionStatus.RUNNING:
case ActionStatus.ABORT_ONLY:
break;
default:
throw new IllegalStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_inactive(_theTransaction.get_uid()) );
}
/*
* Call end on any suspended resources. If this fails, then the
* transaction will be rolled back.
*/
if (!endSuspendedRMs())
_theTransaction.preventCommit();
// use end of TwoPhaseCoordinator to avoid thread changes.
int status = _theTransaction.end(true);
TransactionImple.removeTransaction(this);
switch (status)
{
case ActionStatus.COMMITTED:
case ActionStatus.COMMITTING: // in case of async commit
break;
case ActionStatus.H_MIXED:
throw addSuppressedThrowables(new javax.transaction.HeuristicMixedException());
case ActionStatus.H_HAZARD:
throw addSuppressedThrowables(new javax.transaction.HeuristicMixedException());
case ActionStatus.H_ROLLBACK:
case ActionStatus.ABORTED:
RollbackException rollbackException = new RollbackException(
jtaLogger.i18NLogger.get_transaction_arjunacore_commitwhenaborted() );
if (_theTransaction.getDeferredThrowable() != null)
{
rollbackException.initCause(_theTransaction
.getDeferredThrowable());
}
throw addSuppressedThrowables(rollbackException);
default:
throw new IllegalStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_invalidstate() );
}
}
else
throw new IllegalStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_inactive() );
}
/**
* Add throwables that have been thrown by XAResources but have been suppressed by wrapping records to the given exception.
*
* @param e an exception that will be thrown out of here
* @return the given exception with suppressed exceptions added
*/
<T extends Exception> T addSuppressedThrowables(T e) {
for (Throwable t : _theTransaction.getDeferredThrowables())
{
e.addSuppressed(t);
}
return e;
}
public void rollback() throws java.lang.IllegalStateException,
java.lang.SecurityException, javax.transaction.SystemException
{
if (jtaLogger.logger.isTraceEnabled()) {
jtaLogger.logger.trace("TransactionImple.rollback");
}
if (_theTransaction != null)
{
switch (_theTransaction.status())
{
case ActionStatus.RUNNING:
case ActionStatus.ABORT_ONLY:
break;
default:
throw new IllegalStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_inactive(_theTransaction.get_uid()) );
}
/*
* Call end on any suspended resources. If this fails, then there's
* not a lot else we can do because the transaction is about to roll
* back anyway!
*/
boolean endSuspendedFailed = !endSuspendedRMs();
if (endSuspendedFailed)
{
jtaLogger.i18NLogger.warn_transaction_arjunacore_endsuspendfailed1();
}
int outcome = _theTransaction.cancel(); // use cancel of
// TwoPhaseCoordinator to
// avoid thread changes.
TransactionImple.removeTransaction(this);
switch (outcome)
{
case ActionStatus.ABORTED:
case ActionStatus.ABORTING: // in case of async rollback
break;
default:
throw new IllegalStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_rollbackstatus()
+ ActionStatus.stringForm(outcome));
}
if (endSuspendedFailed)
throw new IllegalStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_endsuspendfailed2() );
}
else
throw new IllegalStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_inactive() );
}
public void setRollbackOnly() throws java.lang.IllegalStateException,
javax.transaction.SystemException
{
if (jtaLogger.logger.isTraceEnabled()) {
jtaLogger.logger.trace("TransactionImple.setRollbackOnly");
}
if (_theTransaction != null)
{
/*
* Try to mark the transaction as rollback-only. If that fails figure out why.
*/
if (!_theTransaction.preventCommit())
{
switch (getStatus())
{
case Status.STATUS_ROLLEDBACK:
case Status.STATUS_ROLLING_BACK:
break;
case Status.STATUS_PREPARING:
case Status.STATUS_PREPARED:
throw new InvalidTerminationStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_invalidstate() );
default:
throw new InactiveTransactionException( jtaLogger.i18NLogger.get_transaction_arjunacore_inactive(_theTransaction.get_uid()) );
}
}
else
{
// keep a record of why we are rolling back i.e. who called us first, it's a useful debug aid.
if(_rollbackOnlyCallerStacktrace == null)
{
_rollbackOnlyCallerStacktrace = new Throwable("setRollbackOnly called from:");
}
}
}
else
throw new IllegalStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_inactive() );
}
public int getStatus() throws javax.transaction.SystemException
{
int status = javax.transaction.Status.STATUS_NO_TRANSACTION;
if (_theTransaction != null)
{
status = StatusConverter.convert(_theTransaction.status());
}
if (jtaLogger.logger.isTraceEnabled()) {
jtaLogger.logger.trace("TransactionImple.getStatus: " + JTAHelper.stringForm(status));
}
return status;
}
public void registerSynchronization(javax.transaction.Synchronization sync)
throws javax.transaction.RollbackException,
java.lang.IllegalStateException, javax.transaction.SystemException
{
if (sync == null)
{
throw new javax.transaction.SystemException(
"TransactionImple.registerSynchronization - " + jtaLogger.i18NLogger.get_transaction_arjunacore_nullparam() );
}
if (jtaLogger.logger.isTraceEnabled()) {
jtaLogger.logger.trace("TransactionImple.registerSynchronization - Class: " + sync.getClass() + " HashCode: " + sync.hashCode() + " toString: " + sync);
}
registerSynchronizationImple(new SynchronizationImple(sync, false));
}
// package-private method also for use by
// TransactionSynchronizationRegistryImple
void registerSynchronizationImple(SynchronizationImple synchronizationImple)
throws javax.transaction.RollbackException,
java.lang.IllegalStateException, javax.transaction.SystemException
{
if (_theTransaction != null)
{
if (_theTransaction.addSynchronization(synchronizationImple) != AddOutcome.AR_ADDED)
{
int status = _theTransaction.status();
switch (status)
{
case ActionStatus.ABORT_ONLY:
case ActionStatus.ABORTED:
throw new javax.transaction.RollbackException( jtaLogger.i18NLogger.get_transaction_arjunacore_syncwhenaborted() );
case ActionStatus.CREATED:
throw new IllegalStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_inactive(_theTransaction.get_uid()) );
default:
throw new IllegalStateException(
jtaLogger.i18NLogger.get_transaction_arjunacore_syncsnotallowed() + ActionStatus.stringForm(status));
}
}
}
else
throw new IllegalStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_inactive() );
}
/**
* This is the JTA compliant version of the method. However, you had better
* know that your XAResource and family are truly compliant implementations.
* If they aren't then we may fail gracefully (e.g., some versions of Oracle
* don't work with arbitrary Xid implementations!)
*
* If the family isn't compliant, then you should use the other method and
* pass through a relevant XAModifier, which should address the issues we
* have already come across.
*/
public boolean enlistResource(XAResource xaRes) throws RollbackException,
IllegalStateException, javax.transaction.SystemException
{
return enlistResource(xaRes, null);
}
public boolean enlistResource(XAResource xaRes, Object[] params)
throws RollbackException, IllegalStateException,
javax.transaction.SystemException
{
if (jtaLogger.logger.isTraceEnabled()) {
jtaLogger.logger.trace("TransactionImple.enlistResource ( " + xaRes + " )");
}
if (xaRes == null)
throw new javax.transaction.SystemException(
"TransactionImple.enlistResource - " + jtaLogger.i18NLogger.get_transaction_arjunacore_nullres() );
int status = getStatus();
switch (status)
{
case javax.transaction.Status.STATUS_MARKED_ROLLBACK:
throw new RollbackException(
"TransactionImple.enlistResource - " + jtaLogger.i18NLogger.get_transaction_arjunacore_invalidstate() );
case javax.transaction.Status.STATUS_ACTIVE:
break;
default:
throw new IllegalStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_inactive() );
}
XAModifier theModifier = null;
if (params != null)
{
if (params.length >= XAMODIFIER + 1)
{
if (params[XAMODIFIER] instanceof XAModifier)
{
theModifier = (XAModifier) params[XAMODIFIER];
}
}
}
try
{
/*
* For each transaction we maintain a list of resources registered
* with it. Each element on this list also contains a list of
* threads which have registered this resource, and what their XID
* was for that registration.
*/
TxInfo info = null;
/*
* Have we seen this specific resource instance before? Do this
* trawl first before checking the RM instance later. Saves time.
*/
try
{
synchronized (this)
{
info = (TxInfo) _resources.get(xaRes);
if (info == null)
{
/*
* Null info means it's not in the main resources list,
* but may be in the duplicates.
*/
info = (TxInfo) _duplicateResources.get(xaRes);
}
}
if (info != null)
{
switch (info.getState())
{
case TxInfo.ASSOCIATION_SUSPENDED:
{
/*
* Have seen resource before, so do a resume. The
* Resource instance will still be registered with the
* transaction though.
*/
int xaStartResume = ((theModifier == null) ? XAResource.TMRESUME
: theModifier
.xaStartParameters(XAResource.TMRESUME));
xaRes.start(info.xid(), xaStartResume);
info.setState(TxInfo.ASSOCIATED);
synchronized (this)
{
_suspendCount--;
}
return true; // already registered resource with this
// transaction!
}
case TxInfo.ASSOCIATED:
{
/*
* Already active on this transaction.
*/
return true;
}
case TxInfo.NOT_ASSOCIATED:
{
/*
* Resource was associated, but was presumably delisted.
*/
int xaStartJoin = ((theModifier == null) ? XAResource.TMJOIN
: theModifier
.xaStartParameters(XAResource.TMJOIN));
xaRes.start(info.xid(), xaStartJoin);
info.setState(TxInfo.ASSOCIATED);
return true;
}
default:
{
// Note: this exception will be caught by our catch
// block
throw new IllegalStateException(
"TransactionImple.enlistResource - " + jtaLogger.i18NLogger.get_transaction_arjunacore_illresstate()
+ ":" + info.getState());
}
}
}
}
catch (IllegalStateException ex)
{
throw ex; // we threw it in the first place
}
catch (XAException exp)
{
if (info != null)
info.setState(TxInfo.FAILED);
jtaLogger.i18NLogger.warn_transaction_arjunacore_enlisterror("TransactionImple.enlistResource",
XAHelper.printXAErrorCode(exp));
return false;
}
// if (threadIsActive(xaRes))
// return true; // this thread has already registered a resource for
// this db
/*
* We definitely haven't seen this specific resource instance
* before, but that doesn't mean that we haven't seen the RM it is
* connected to.
*/
Xid xid = null;
TxInfo existingRM = isNewRM(xaRes);
if (existingRM == null)
{
/*
* New RM, so create xid with new branch.
*/
boolean branchRequired = true;
synchronized (this)
{
if (_resources.size() == 0)// first ever, so no need for
// branch
{
// branchRequired = false;
branchRequired = true;
}
}
xid = createXid(branchRequired, theModifier, xaRes);
boolean associatedWork = false;
int retry = 20;
/*
* If another process has (or is about to) create the same
* transaction association then we will probably get a failure
* during start with XAER_DUPID. We know this must be due to
* another server, since we keep track of our own registrations.
* So, if this happens we create a new transaction branch and
* try again.
*
* To save time we could always just create branches by default.
*
* Is there a benefit to a zero branch?
*/
while (!associatedWork)
{
try
{
if (_xaTransactionTimeoutEnabled)
{
int timeout = _theTransaction.getTimeout();
if (timeout > 0)
{
try
{
xaRes.setTransactionTimeout(timeout);
}
catch (XAException te)
{
jtaLogger.i18NLogger.warn_transaction_arjunacore_timeouterror("TransactionImple.enlistResource",XAHelper.xidToString(xid), XAHelper.printXAErrorCode(te), te);
}
}
}
int xaStartNormal = ((theModifier == null) ? XAResource.TMNOFLAGS
: theModifier
.xaStartParameters(XAResource.TMNOFLAGS));
// Pay attention now, this bit is hairy. We need to add a new AbstractRecord (XAResourceRecord)
// to the BasicAction, which will thereafter drive its completion. However, the transaction
// core is not directly XA aware, so it's our job to start the XAResource. Problem is, if
// adding the record fails, BasicAction will never end the resource via the XAResourceRecord,
// so we must do so directly. start may fail due to dupl xid or other reason, and transactions
// may rollback async, for which reasons we can't call add before start.
// The xid will change on each pass of the loop, so we need to create a new record on each pass.
// The add will fail in the case of multiple last resources being disallowed
// see JBTM-362 and JBTM-363
AbstractRecord abstractRecord = createRecord(xaRes, params, xid);
if(abstractRecord != null) {
xaRes.start(xid, xaStartNormal);
if(_theTransaction.add(abstractRecord) == AddOutcome.AR_ADDED) {
_resources.put(xaRes, new TxInfo(xid));
return true; // dive out, no need to set associatedWork = true;
} else {
// we called start on the resource, but _theTransaction did not accept it.
// we therefore have a mess which we must now clean up by ensuring the start is undone:
abstractRecord.topLevelAbort();
}
}
// if we get to here, something other than a failure of xaRes.start probably went wrong.
// so we don't loop and retry, we just give up.
markRollbackOnly();
return false;
}
catch (XAException e)
{
// transaction already created by another server
if ((e.errorCode == XAException.XAER_DUPID)
|| (e.errorCode == XAException.XAER_RMERR))
{
if (retry > 0)
xid = createXid(true, theModifier, xaRes);
retry--;
}
else
{
/*
* Can't do start, so set transaction to rollback
* only.
*/
jtaLogger.i18NLogger.warn_transaction_arjunacore_enliststarterror("TransactionImple.enlistResource",
XAHelper.xidToString(xid), XAHelper.printXAErrorCode(e), e);
markRollbackOnly();
throw e;
}
if (retry < 0)
{
jtaLogger.i18NLogger.warn_transaction_arjunacore_enliststarterror("TransactionImple.enlistResource",
XAHelper.xidToString(xid), XAHelper.printXAErrorCode(e), e);
markRollbackOnly();
throw new javax.transaction.SystemException(
"TransactionImple.enlistResource - XAResource.start "
+ jtaLogger.i18NLogger.get_transaction_arjunacore_couldnotregister()
+ ": " + xid);
}
}
}
}
else
{
/*
* Have seen this RM before, so ignore this instance. The first
* registered RM instance will be used to drive the transaction
* completion. We add it to the duplicateResource list so we can
* delist it correctly later though.
*/
/*
* Re-create xid.
*/
xid = existingRM.xid();
try
{
int xaStartJoin = ((theModifier == null) ? XAResource.TMJOIN
: theModifier.xaStartParameters(XAResource.TMJOIN));
xaRes.start(xid, xaStartJoin);
}
catch (XAException ex)
{
jtaLogger.i18NLogger.warn_transaction_arjunacore_xastart("TransactionImple.enlistResource - xa_start ",
XAHelper.xidToString(xid), XAHelper.printXAErrorCode(ex), ex);
markRollbackOnly();
throw ex;
}
/*
* Add to duplicate resources list so we can keep track of it
* (particularly if we later have to delist).
*/
_duplicateResources.put(xaRes, new TxInfo(xid));
return true;
}
return false;
}
catch (Exception e)
{
e.printStackTrace();
/*
* Some exceptional condition arose and we probably could not enlist
* the resouce. So, for safety mark the transaction as rollback
* only.
*/
markRollbackOnly();
return false;
}
}
/**
* Attempt to create an AbstractRecord wrapping the given XAResource. Return null if this fails, or
* is diallowed by the current configuration of multiple last resource behaviour.
*
* @param xaRes
* @param params
* @param xid
* @return
*/
private AbstractRecord createRecord(XAResource xaRes, Object[] params, Xid xid)
{
if ((xaRes instanceof LastResourceCommitOptimisation)
|| ((LAST_RESOURCE_OPTIMISATION_INTERFACE != null) && LAST_RESOURCE_OPTIMISATION_INTERFACE
.isInstance(xaRes)))
{
if (xaRes instanceof ConnectableResource) {
String jndiName = ((XAResourceWrapper)xaRes).getJndiName();
if (commitMarkableResourceJNDINames.contains(jndiName)) {
try {
return new CommitMarkableResourceRecord(this, ((ConnectableResource)xaRes), xid, _theTransaction);
} catch (IllegalStateException | RollbackException
| SystemException e) {
tsLogger.logger.warn("Could not register synchronization for CommitMarkableResourceRecord", e);
return null;
}
}
}
return new LastResourceRecord(new XAOnePhaseResource(xaRes, xid, params));
}
else
{
return new XAResourceRecord(this, xaRes, xid, params);
}
}
/*
* Do we have to unregister resources? Assume not as it would not make much
* sense otherwise!
*/
public boolean delistResource(XAResource xaRes, int flags)
throws IllegalStateException, javax.transaction.SystemException
{
if (jtaLogger.logger.isTraceEnabled()) {
jtaLogger.logger.trace("TransactionImple.delistResource ( " + xaRes + ", " + flags + " )");
}
if (xaRes == null)
throw new javax.transaction.SystemException(
"TransactionImple.delistResource - " + jtaLogger.i18NLogger.get_transaction_arjunacore_nullres() );
int status = getStatus();
switch (status)
{
case javax.transaction.Status.STATUS_ACTIVE:
break;
case javax.transaction.Status.STATUS_MARKED_ROLLBACK:
break;
default:
throw new IllegalStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_inactive() );
}
TxInfo info = null;
try
{
synchronized (this)
{
info = (TxInfo) _resources.get(xaRes);
if (info == null)
info = (TxInfo) _duplicateResources.get(xaRes);
}
if (info == null)
{
jtaLogger.i18NLogger.warn_transaction_arjunacore_unknownresource("TransactionImple.delistResource");
return false;
}
else
{
boolean optimizedRollback = false;
try
{
/*
* If we know the transaction is going to rollback, then we
* can try to rollback the RM now. Just an optimisation.
*/
if (status == javax.transaction.Status.STATUS_MARKED_ROLLBACK)
{
if (XAUtils.canOptimizeDelist(xaRes))
{
xaRes.end(info.xid(), XAResource.TMFAIL);
xaRes.rollback(info.xid());
info.setState(TxInfo.OPTIMIZED_ROLLBACK);
optimizedRollback = true;
}
}
}
catch (Exception e)
{
// failed, so try again when transaction does rollback
}
switch (info.getState())
{
case TxInfo.ASSOCIATED:
{
if ((flags & XAResource.TMSUCCESS) != 0)
{
xaRes.end(info.xid(), XAResource.TMSUCCESS);
info.setState(TxInfo.NOT_ASSOCIATED);
}
else
{
if ((flags & XAResource.TMSUSPEND) != 0)
{
xaRes.end(info.xid(), XAResource.TMSUSPEND);
info.setState(TxInfo.ASSOCIATION_SUSPENDED);
synchronized (this)
{
_suspendCount++;
}
}
else
{
xaRes.end(info.xid(), XAResource.TMFAIL);
info.setState(TxInfo.FAILED);
}
}
}
break;
case TxInfo.ASSOCIATION_SUSPENDED:
{
if ((flags & XAResource.TMSUCCESS) != 0)
{
// Oracle barfs if we don't send resume first, despite
// what XA says!
if (XAUtils.mustEndSuspendedRMs(xaRes))
xaRes.start(info.xid(), XAResource.TMRESUME);
xaRes.end(info.xid(), XAResource.TMSUCCESS);
info.setState(TxInfo.NOT_ASSOCIATED);
synchronized (this)
{
_suspendCount--;
}
}
else
{
if ((flags & XAResource.TMSUSPEND) != 0)
{
// Note: this exception will be caught by our catch
// block
throw new IllegalStateException(
"TransactionImple.delistResource - " + jtaLogger.i18NLogger.get_transaction_arjunacore_ressuspended() );
}
else
{
xaRes.end(info.xid(), XAResource.TMFAIL);
info.setState(TxInfo.FAILED);
synchronized (this)
{
_suspendCount--;
}
}
}
}
break;
default:
{
if (!optimizedRollback)
throw new IllegalStateException(
"TransactionImple.delistResource - " +
jtaLogger.i18NLogger.get_transaction_arjunacore_illresstate()
+ ":" + info.getState());
}
}
info = null;
return true;
}
}
catch (IllegalStateException ex)
{
throw ex;
}
catch (XAException exp)
{
if (info != null)
info.setState(TxInfo.FAILED);
/*
* For safety mark the transaction as rollback only.
*/
markRollbackOnly();
jtaLogger.i18NLogger.warn_transaction_arjunacore_delistresource("TransactionImple.delistResource", XAHelper.printXAErrorCode(exp), exp);
return false;
}
catch (Exception e)
{
jtaLogger.i18NLogger.warn_transaction_arjunacore_delistgeneral("TransactionImple.delistResource", e);
/*
* Some exception occurred and we probably could not delist the
* resource. So, for safety mark the transaction as rollback only.
*/
markRollbackOnly();
return false;
}
}
public final Uid get_uid()
{
return _theTransaction.get_uid();
}
public final Xid getTxId ()
{
Xid res = baseXid();
if (res == null)
res = new XidImple(_theTransaction);
return res;
}
/**
* Returning list of throwables which are bound to transaction failure.
* This method is intended to be used when handling some error states.
* The result exception could be enriched with these returned ones.
*/
public List<Throwable> getDeferredThrowables()
{
return _theTransaction.getDeferredThrowables();
}
/**
* Method {@link #getDeferredThrowables()} will return list
* of deferred throwables.
*
* @return true
*/
public boolean supportsDeferredThrowables() {
return true;
}
public String toString()
{
if (_theTransaction == null)
return "TransactionImple < ac, NoTransaction >";
else
{
return "TransactionImple < ac, " + _theTransaction + " >";
}
}
public void endAssociation(Xid _tranID, XAResource _theXAResource, int xaState, int txInfoState) throws XAException {
int txInfo = getXAResourceState(_theXAResource);
XAException toThrow = null;
if ((txInfo != TxInfo.NOT_ASSOCIATED) && (txInfo != TxInfo.FAILED)) {
try {
doEnd(_tranID, _theXAResource, xaState, txInfoState);
} catch (XAException e) {
toThrow = e;
}
}
for (Object resource : _duplicateResources.keySet()) {
XAResource dupXar = (XAResource) resource;
if (_theXAResource.isSameRM(dupXar)) {
try {
doEnd(_tranID, dupXar, xaState, txInfoState);
} catch (XAException e) {
// Some resource managers (e.g. Artemis) will not allow xa_end on duplicate xa resources as per JTA 1.2
if (e.errorCode != XAException.XAER_PROTO || STRICTJTA12DUPLICATEXAENDPROTOERR) {
if (toThrow == null) {
toThrow = e;
} else {
_theTransaction.getDeferredThrowables().add(e);
}
}
}
}
}
if (toThrow != null) {
throw toThrow;
}
}
private void doEnd(Xid _tranID, XAResource xar, int xaState, int txInfoState) throws XAException {
try {
xar.end(_tranID, xaState);
setXAResourceState(xar, txInfoState);
} catch (XAException e1) {
switch (e1.errorCode) {
case XAException.XA_RBROLLBACK:
case XAException.XA_RBCOMMFAIL:
case XAException.XA_RBDEADLOCK:
case XAException.XA_RBINTEGRITY:
case XAException.XA_RBOTHER:
case XAException.XA_RBPROTO:
case XAException.XA_RBTIMEOUT:
case XAException.XA_RBTRANSIENT:
setXAResourceState(xar, txInfoState);
}
jtaLogger.i18NLogger.warn_could_not_end_xar(xar, e1);
throw e1;
}
}
public int getXAResourceState(XAResource xaRes)
{
int state = TxInfo.UNKNOWN;
if (xaRes != null)
{
TxInfo info = (TxInfo) _resources.get(xaRes);
if (info == null)
{
info = (TxInfo) _duplicateResources.get(xaRes);
}
if (info != null)
state = info.getState();
}
return state;
}
public void setXAResourceState(XAResource xaRes, int state)
{
if (xaRes != null)
{
TxInfo info = (TxInfo) _resources.get(xaRes);
if (info == null)
{
info = (TxInfo) _duplicateResources.get(xaRes);
}
if (info != null)
info.setState(state);
}
}
public static final TransactionImple getTransaction()
{
TransactionImple tx = null;
final BasicAction current = BasicAction.Current();
if (current != null)
{
final Uid txid = current.get_uid();
tx = (TransactionImple) _transactions.get(txid);
if (tx == null)
tx = new TransactionImple(current);
}
return tx;
}
public static final TransactionImple getTransaction(Uid id)
{
try
{
if (id != null)
return (TransactionImple) _transactions.get(id);
else
return null;
}
catch (Exception e)
{
return new TransactionImple(null);
}
}
// get a key-value pair from a transaction specific Map
public Object getTxLocalResource(Object key)
{
return _txLocalResources.get(key);
}
// store a key-value pair in the scope of the transaction.
public void putTxLocalResource(Object key, Object value)
{
_txLocalResources.put(key, value);
}
/*
* For JBossAS integration TransactionLocal implementation, we need to know if a tx has been
* resolved yet or not. We could use getStatus() and a case stmt, but since an instance is
* removed from _transactions on completion this is just as effective.
* @param tx
* @return
*/
public boolean isAlive() {
try {
if(_theTransaction != null) {
return _transactions.containsKey(this.get_uid());
} else {
return false;
}
} catch(NullPointerException e) {
return false; // there is no tx/action, therefore it's not alive.
}
}
protected TransactionImple()
{
this(null);
}
/**
* Create a new TransactionImple representation of a specified transaction.
*/
protected TransactionImple(BasicAction curr)
{
try
{
if (curr == null)
{
_theTransaction = (com.arjuna.ats.arjuna.AtomicAction) BasicAction
.Current();
}
else
_theTransaction = (com.arjuna.ats.arjuna.AtomicAction) curr;
}
catch (ClassCastException ex)
{
jtaLogger.i18NLogger.warn_transaction_arjunacore_notatomicaction();
}
if (_theTransaction != null)
{
_resources = new Hashtable();
_duplicateResources = new Hashtable();
_txLocalResources = Collections.synchronizedMap(new HashMap());
}
else
{
_resources = null;
_duplicateResources = null;
}
_suspendCount = 0;
_xaTransactionTimeoutEnabled = getXATransactionTimeoutEnabled();
}
final com.arjuna.ats.arjuna.AtomicAction getAtomicAction()
{
return _theTransaction;
}
/**
* Does the same as commit, but also changes the thread-to-tx association.
*/
protected void commitAndDisassociate()
throws javax.transaction.RollbackException,
javax.transaction.HeuristicMixedException,
javax.transaction.HeuristicRollbackException,
java.lang.SecurityException, javax.transaction.SystemException,
java.lang.IllegalStateException
{
if (jtaLogger.logger.isTraceEnabled()) {
jtaLogger.logger.trace("TransactionImple.commitAndDisassociate");
}
try
{
if (_theTransaction != null)
{
switch (_theTransaction.status())
{
case ActionStatus.ABORTED:
case ActionStatus.ABORTING:
_theTransaction.abort(); // assure thread disassociation
throw addSuppressedThrowables(new javax.transaction.RollbackException( jtaLogger.i18NLogger.get_transaction_arjunacore_inactive(_theTransaction.get_uid()) ));
case ActionStatus.COMMITTED:
case ActionStatus.COMMITTING: // in case of async commit
_theTransaction.commit(true); // assure thread disassociation
return;
}
final Throwable preexistingRollbackOnlyCallerStacktrace = _rollbackOnlyCallerStacktrace;
switch (_theTransaction.commit(true))
{
case ActionStatus.COMMITTED:
case ActionStatus.COMMITTING: // in case of async commit
break;
case ActionStatus.H_MIXED:
throw addSuppressedThrowables(new javax.transaction.HeuristicMixedException());
case ActionStatus.H_HAZARD:
throw addSuppressedThrowables(new javax.transaction.HeuristicMixedException());
case ActionStatus.H_ROLLBACK:
case ActionStatus.ABORTED:
case ActionStatus.ABORTING:
RollbackException rollbackException = addSuppressedThrowables(new RollbackException( jtaLogger.i18NLogger.get_transaction_arjunacore_commitwhenaborted() ));
// Don't mess with the following flow until you've read JBTM-575 in its entirety.
if(preexistingRollbackOnlyCallerStacktrace != null) {
// we rolled back because the user (note: NOT a beforeCompletion) explicitly told us not to commit.
// beforeCompletions should not be called in such case anyhow, so getDeferredThrowable is irrelevant.
// Attach the trace of who did that for debug:
rollbackException.initCause(preexistingRollbackOnlyCallerStacktrace);
} else if(_theTransaction.getDeferredThrowable() != null) {
// problems occurring during beforeCompletion (the only place deferredThrowable is set) take priority
// over 'immediately prior' (i.e. after the commit call - likely from within beforeCompletion) calls to setRollbackOnly
// despite the small chance that the causal relationship is not infact valid
rollbackException.initCause(_theTransaction.getDeferredThrowable());
} else if(_rollbackOnlyCallerStacktrace != null) {
// we tried to commit but it went wrong, resulting in a call to setRollbackOnly from within a
// beforeCompletion. The beforeCompletion did not then throw an exception as that would be handled above
rollbackException.initCause(_rollbackOnlyCallerStacktrace);
}
throw rollbackException;
default:
throw addSuppressedThrowables(new InvalidTerminationStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_invalidstate() ));
}
}
else
throw addSuppressedThrowables(new IllegalStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_inactive() ));
}
finally
{
TransactionImple.removeTransaction(this);
}
}
/**
* If this is an imported transaction (via JCA) then this will be the Xid we
* are pretending to be. Otherwise, it will be null.
*
* @return null if we are a local transaction, a valid Xid if we have been
* imported.
*/
protected Xid baseXid()
{
return null;
}
/**
* Does the same as rollback, but also changes the thread-to-tx association.
*/
protected void rollbackAndDisassociate()
throws java.lang.IllegalStateException,
java.lang.SecurityException, javax.transaction.SystemException
{
if (jtaLogger.logger.isTraceEnabled()) {
jtaLogger.logger.trace("TransactionImple.rollbackAndDisassociate");
}
try
{
boolean statusIsValid = false;
if (_theTransaction != null)
{
if(_theTransaction.status() == ActionStatus.RUNNING || _theTransaction.status() == ActionStatus.ABORT_ONLY) {
// in these cases we may be able to finish without throwing an exception, if nothing else goes wrong...
statusIsValid = true;
}
int outcome = _theTransaction.abort(); // assure thread disassociation, even if tx is already done.
switch (outcome)
{
case ActionStatus.ABORTED:
case ActionStatus.ABORTING: // in case of async rollback
statusIsValid = true;
break;
default:
throw new InactiveTransactionException( jtaLogger.i18NLogger.get_transaction_arjunacore_rollbackstatus()
+ ActionStatus.stringForm(outcome));
}
}
if(_theTransaction == null || !statusIsValid) {
throw new IllegalStateException( jtaLogger.i18NLogger.get_transaction_arjunacore_inactive() );
}
}
finally
{
TransactionImple.removeTransaction(this);
}
}
/**
* If there are any suspended RMs then we should call end on them before the
* transaction is terminated.
*/
protected boolean endSuspendedRMs()
{
boolean result = true;
if (_suspendCount > 0)
{
Enumeration el = _resources.keys();
/*
* Loop over all registered resources. Those that are in a suspended
* state must have end called on them. If this fails, then we will
* eventually roll back the transaction, but we will continue down
* the list to try to end any other suspended resources.
*/
if (el != null)
{
try
{
/*
* Would it gain us much to just loop for _suspendCount?
*/
while (el.hasMoreElements())
{
/*
* Get the XAResource in case we have to call end on it.
*/
XAResource xaRes = (XAResource) el.nextElement();
TxInfo info = (TxInfo) _resources.get(xaRes);
if (info.getState() == TxInfo.ASSOCIATION_SUSPENDED)
{
if (XAUtils.mustEndSuspendedRMs(xaRes))
xaRes.start(info.xid(), XAResource.TMRESUME);
xaRes.end(info.xid(), XAResource.TMSUCCESS);
info.setState(TxInfo.NOT_ASSOCIATED);
}
}
}
catch (XAException ex)
{
jtaLogger.i18NLogger.warn_transaction_arjunacore_xaenderror(ex);
result = false;
}
}
/*
* need to do the same for all duplicated resources
*/
el = _duplicateResources.keys();
if (el != null)
{
try
{
/*
* Would it gain us much to just loop for _suspendCount?
*/
while (el.hasMoreElements())
{
/*
* Get the XAResource in case we have to call end on it.
*/
XAResource xaRes = (XAResource) el.nextElement();
TxInfo info = (TxInfo) _duplicateResources.get(xaRes);
if (info.getState() == TxInfo.ASSOCIATION_SUSPENDED)
{
if (XAUtils.mustEndSuspendedRMs(xaRes))
xaRes.start(info.xid(), XAResource.TMRESUME);
xaRes.end(info.xid(), XAResource.TMSUCCESS);
info.setState(TxInfo.NOT_ASSOCIATED);
}
}
}
catch (XAException ex)
{
jtaLogger.i18NLogger.warn_transaction_arjunacore_xaenderror(ex);
result = false;
}
}
_suspendCount = 0;
}
return result;
}
/*
* If this thread has already registered a resource for the same db then
* don't use this copy. For some databases it would actually be ok for us to
* use the resource (at least to do an xa_start equivalent on it), but for
* Oracle 8.1.6 it causes their JDBC driver to crash!
*/
private final boolean threadIsActive(XAResource xaRes)
{
Thread t = Thread.currentThread();
try
{
Enumeration el = _resources.keys();
if (el != null)
{
while (el.hasMoreElements())
{
XAResource x = (XAResource) el.nextElement();
if (x.isSameRM(xaRes))
{
TxInfo info = (TxInfo) _resources.get(x);
if (info.thread() == t)
return true;
}
}
}
el = _duplicateResources.keys();
if (el != null)
{
while (el.hasMoreElements())
{
XAResource x = (XAResource) el.nextElement();
if (x.isSameRM(xaRes))
{
TxInfo info = (TxInfo) _resources.get(x);
if (info.thread() == t)
return true;
}
}
}
}
catch (Exception e)
{
jtaLogger.i18NLogger.warn_transaction_arjunacore_threadexception(e);
throw new com.arjuna.ats.arjuna.exceptions.FatalError(e.toString(), e);
}
return false;
}
/**
* isNewRM returns an existing TxInfo for the same RM, if present. Null
* otherwise.
*/
private final TxInfo isNewRM(XAResource xaRes)
{
try
{
synchronized (this)
{
Enumeration el = _resources.keys();
if (el != null)
{
while (el.hasMoreElements())
{
XAResource x = (XAResource) el.nextElement();
if (x.isSameRM(xaRes))
{
return (TxInfo) _resources.get(x);
}
}
}
el = _duplicateResources.keys();
if (el != null)
{
while (el.hasMoreElements())
{
XAResource x = (XAResource) el.nextElement();
if (x.isSameRM(xaRes))
{
return (TxInfo) _duplicateResources.get(x);
}
}
}
}
}
catch (XAException ex)
{
jtaLogger.i18NLogger.warn_transaction_arjunacore_newtmerror("TransactionImple.isNewRM",
XAHelper.printXAErrorCode(ex), ex);
throw new com.arjuna.ats.arjuna.exceptions.FatalError(ex.toString(), ex);
}
catch (Exception e)
{
jtaLogger.i18NLogger.warn_transaction_arjunacore_newtmerror("TransactionImple.isNewRM",
"-", e);
throw new com.arjuna.ats.arjuna.exceptions.FatalError(e.toString(), e);
}
return null;
}
protected Xid createXid(boolean branch, XAModifier theModifier, XAResource xaResource) throws IOException, ObjectStoreException
{
int eisName = 0;
if(branch) {
if(_xaResourceRecordWrappingPlugin != null) {
eisName = _xaResourceRecordWrappingPlugin.getEISName(xaResource);
}
}
Xid xid = new XidImple(_theTransaction.get_uid(), branch, eisName);
if (theModifier != null)
{
try
{
xid = theModifier.createXid((XidImple) xid);
}
catch (Exception e)
{
e.printStackTrace();
}
}
return xid;
}
/*
* This method calls setRollbackOnly and catches any exceptions it may throw
* and issues a warning. We use this in places where we need to force the
* outcome of the transaction but already have an exception to throw back to
* the application, so a failure here will only be masked.
*/
private final void markRollbackOnly()
{
try
{
setRollbackOnly();
}
catch (Exception ex)
{
jtaLogger.i18NLogger.warn_transaction_arjunacore_markrollback("TransactionImple.markRollbackOnly",
_theTransaction.toString());
}
}
/*
* Add and remove transactions from list.
*/
static final protected void putTransaction(TransactionImple tx)
{
_transactions.put(tx.get_uid(), tx);
}
public static final void removeTransaction(TransactionImple tx)
{
_transactions.remove(tx.get_uid());
}
private static boolean getXATransactionTimeoutEnabled()
{
return XA_TRANSACTION_TIMEOUT_ENABLED;
}
public static Map<Uid, javax.transaction.Transaction> getTransactions()
{
return Collections.unmodifiableMap(_transactions);
}
public Map<XAResource, TxInfo> getResources()
{
return Collections.unmodifiableMap(_resources);
}
public int getTimeout()
{
return _theTransaction.getTimeout();
}
public long getRemainingTimeoutMills() {
return TransactionReaper.transactionReaper().getRemainingTimeoutMills(_theTransaction);
}
public java.util.Map<Uid, String> getSynchronizations()
{
if (_theTransaction != null)
return _theTransaction.getSynchronizations();
return Collections.EMPTY_MAP;
}
protected com.arjuna.ats.arjuna.AtomicAction _theTransaction;
private Hashtable _resources;
private Hashtable _duplicateResources;
private int _suspendCount;
private final boolean _xaTransactionTimeoutEnabled;
private Map _txLocalResources;
private Throwable _rollbackOnlyCallerStacktrace;
private static final boolean XA_TRANSACTION_TIMEOUT_ENABLED = jtaPropertyManager.getJTAEnvironmentBean()
.isXaTransactionTimeoutEnabled();
private static final Class LAST_RESOURCE_OPTIMISATION_INTERFACE = jtaPropertyManager.getJTAEnvironmentBean()
.getLastResourceOptimisationInterface();
protected static final XAResourceRecordWrappingPlugin _xaResourceRecordWrappingPlugin =
jtaPropertyManager.getJTAEnvironmentBean().getXAResourceRecordWrappingPlugin();
/**
* Static block writes warning message to the log if last resource optimisation interface was not set.
*/
static
{
if(LAST_RESOURCE_OPTIMISATION_INTERFACE == null) {
jtaLogger.i18NLogger.warn_transaction_arjunacore_lastResourceOptimisationInterface(jtaPropertyManager.getJTAEnvironmentBean().getLastResourceOptimisationInterfaceClassName());
}
}
private static final ConcurrentHashMap _transactions = new ConcurrentHashMap();
private static final List<String> commitMarkableResourceJNDINames = BeanPopulator
.getDefaultInstance(JTAEnvironmentBean.class)
.getCommitMarkableResourceJNDINames();
private static final boolean STRICTJTA12DUPLICATEXAENDPROTOERR = jtaPropertyManager.getJTAEnvironmentBean().isStrictJTA12DuplicateXAENDPROTOErr();
}