/*
* Bitronix Transaction Manager
*
* Copyright (c) 2010, Bitronix Software.
*
* 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, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY 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
* along with this distribution; if not, write to:
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor
* Boston, MA 02110-1301 USA
*/
package bitronix.tm.resource.common;
import bitronix.tm.BitronixTransaction;
import bitronix.tm.BitronixXid;
import bitronix.tm.internal.XAResourceHolderState;
import bitronix.tm.utils.Uid;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.*;
/**
* Implementation of all services required by a {@link XAResourceHolder}. This class keeps a list of all
* {@link XAResourceHolderState}s of the {@link XAResourceHolder} plus the currently active one. There is
* one per transaction in which this {@link XAResourceHolder} is enlisted plus all the suspended transactions in which
* it is enlisted as well.
*
* @author lorban
*/
public abstract class AbstractXAResourceHolder extends AbstractXAStatefulHolder implements XAResourceHolder {
private final static Logger log = LoggerFactory.getLogger(AbstractXAResourceHolder.class);
private final Map xaResourceHolderStates = Collections.synchronizedMap(new HashMap());
public Map getXAResourceHolderStatesForGtrid(Uid gtrid) {
synchronized (xaResourceHolderStates) {
return (Map) xaResourceHolderStates.get(gtrid);
}
}
public void putXAResourceHolderState(BitronixXid xid, XAResourceHolderState xaResourceHolderState) {
synchronized (xaResourceHolderStates) {
if (log.isDebugEnabled()) log.debug("putting XAResourceHolderState [" + xaResourceHolderState + "] on " + this);
Uid gtrid = xid.getGlobalTransactionIdUid();
Uid bqual = xid.getBranchQualifierUid();
if (!xaResourceHolderStates.containsKey(gtrid)) {
if (log.isDebugEnabled()) log.debug("GTRID [" + gtrid + "] previously unknown to " + this + ", adding it to the resource's transactions list");
Map statesForGtrid = new LinkedHashMap(4); // use a LinkedHashMap as iteration order must be guaranteed
statesForGtrid.put(bqual, xaResourceHolderState);
xaResourceHolderStates.put(gtrid, statesForGtrid);
}
else {
if (log.isDebugEnabled()) log.debug("GTRID [" + gtrid + "] previously known to " + this + ", adding it to the resource's transactions list");
Map statesForGtrid = (Map) xaResourceHolderStates.get(gtrid);
statesForGtrid.put(bqual, xaResourceHolderState);
}
}
}
public void removeXAResourceHolderState(BitronixXid xid) {
synchronized (xaResourceHolderStates) {
if (log.isDebugEnabled()) log.debug("removing XAResourceHolderState of xid " + xid + " from " + this);
Uid gtrid = xid.getGlobalTransactionIdUid();
Uid bqual = xid.getBranchQualifierUid();
Map statesForGtrid = (Map) xaResourceHolderStates.get(gtrid);
if (statesForGtrid == null) {
log.warn("tried to remove unknown GTRID [" + gtrid + "] from " + this + " - Bug?");
return;
}
Object removed = statesForGtrid.remove(bqual);
if (removed == null) {
log.warn("tried to remove unknown BQUAL [" + bqual + "] from " + this + " - Bug?");
return;
}
if (statesForGtrid.isEmpty()) {
xaResourceHolderStates.remove(gtrid);
}
}
}
public boolean hasStateForXAResource(XAResourceHolder xaResourceHolder) {
synchronized (xaResourceHolderStates) {
Iterator statesForGtridIt = xaResourceHolderStates.values().iterator();
while (statesForGtridIt.hasNext()) {
Map statesForGtrid = (Map) statesForGtridIt.next();
Iterator statesForBqualIt = statesForGtrid.values().iterator();
while (statesForBqualIt.hasNext()) {
XAResourceHolderState otherXaResourceHolderState = (XAResourceHolderState) statesForBqualIt.next();
if (otherXaResourceHolderState.getXAResource() == xaResourceHolder.getXAResource()) {
if (log.isDebugEnabled()) log.debug("resource " + xaResourceHolder + " is enlisted in another transaction with " + otherXaResourceHolderState.getXid().toString());
return true;
}
}
}
if (log.isDebugEnabled()) log.debug("resource not enlisted in any transaction: " + xaResourceHolder);
return false;
}
}
/**
* If this method returns false, then local transaction calls like Connection.commit() can be made.
* @return true if start() has been successfully called but not end() yet <i>and</i> the transaction is not suspended.
*/
public boolean isParticipatingInActiveGlobalTransaction() {
synchronized (xaResourceHolderStates) {
BitronixTransaction currentTransaction = TransactionContextHelper.currentTransaction();
Uid gtrid = currentTransaction == null ? null : currentTransaction.getResourceManager().getGtrid();
if (gtrid == null)
return false;
Map statesForGtrid = (Map) xaResourceHolderStates.get(gtrid);
if (statesForGtrid == null)
return false;
Iterator statesForBqualIt = statesForGtrid.values().iterator();
while (statesForBqualIt.hasNext()) {
XAResourceHolderState xaResourceHolderState = (XAResourceHolderState) statesForBqualIt.next();
if (xaResourceHolderState != null &&
xaResourceHolderState.isStarted() &&
!xaResourceHolderState.isSuspended() &&
!xaResourceHolderState.isEnded())
return true;
}
return false;
}
}
/**
* Simple helper method which returns a set of GTRIDs of transactions in which
* this resource is enlisted. Useful for monitoring.
* @return a set of String-encoded GTRIDs of transactions in which this resource is enlisted.
*/
public Set getXAResourceHolderStateGtrids() {
synchronized (xaResourceHolderStates) {
HashSet gtridsAsStrings = new HashSet();
Iterator gtridsIt = xaResourceHolderStates.keySet().iterator();
while (gtridsIt.hasNext()) {
Uid uid = (Uid) gtridsIt.next();
gtridsAsStrings.add(uid.toString());
}
return gtridsAsStrings;
}
}
}