mq5.0-source.main.mq-jmsra.jmsra-ra.src.main.java.com.sun.messaging.jms.ra.util.DirectXAResourceMap Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.messaging.jms.ra.util;
import java.util.Set;
import java.util.HashMap;
import java.util.HashSet;
import javax.transaction.xa.XAException;
import com.sun.messaging.jmq.util.XidImpl;
import com.sun.messaging.jms.ra.DirectXAResource;
/**
* This class keeps track of all the DirectXAResource objects which are party to a given transaction branch
*
* This class maintains a static Map
* whose key is the transaction branch XID (a XidImpl)
* and whose corresponding value is a Set of all the DirectXAResource objects
* which are being used in this transaction branch
*
* A resource should be registered with this class by calling register(),
* whenever XAResource.start(xid,TMNOFLAGS) or XAResource.start(xid,TMJOIN) is called
* and removed from this class when the xid is committed or rolled back.
*
* register() should never be called for XAResource.start(xid,TMRESUME) - this will cause an XAException
*
* Note that the XA spec requires that when a second resource is added to an existing
* xid, XAStart(xid,flags) is called with the join flag set
*
*/
public class DirectXAResourceMap {
private static HashMap> resourceMap = new HashMap>();
/**
*
* @param xid
* @param xar
* @param isJoin
* @throws XAException
*/
public synchronized static void register(XidImpl xid, DirectXAResource xar, boolean isJoin) throws XAException{
Set resources = resourceMap.get(xid);
if (resources == null){
// xid not found: check we are not doing a join
if (isJoin) {
XAException xae = new XAException("Trying to add an XAResource using the JOIN flag when no existing XAResource has been added with this XID");
xae.errorCode = XAException.XAER_INVAL;
throw xae;
}
resources = new HashSet();
resourceMap.put(xid, resources);
} else {
// map already contains an entry for this xid: check we are doing a JOIN
if (!isJoin){
XAException xae = new XAException("Trying to add an XAResource to an existing xid without using the JOIN flag");
xae.errorCode = XAException.XAER_DUPID;
throw xae;
}
}
resources.add(xar);
}
/**
* Unregister the specified transaction branch and all its resources
*
* This should be called when the transaction is committed or rolled back
*
* @param xid Transaction branch XID
*/
public synchronized static void unregister(XidImpl xid){
// note that xid won't exist in the map if we obtained this xid using XAResource.recover(),
// so it is not an error if xid is not found
resourceMap.remove(xid);
}
/**
* Unregister the specified resource from the specified transaction branch
*
* This should be called when an individual session is closed
* but a transaction is still pending
*
* @param xid Transaction branch XID
* @param xar Resource
*/
public synchronized static void unregisterResource(DirectXAResource xar, XidImpl xid){
Set resources = resourceMap.get(xid);
if (resources!=null){
resources.remove(xar);
if (resources.size()==0){
resourceMap.remove(xid);
}
}
}
/**
* Returns a Set of resources associated with the specified transaction branch
* @param xid Transaction branch XID
* @param throwExceptionIfNotFound Whether to throw an exception if XID not found
* (typically set to true on a commit, false on a rollback,
* since a commit legitimately be followed by a rollback)
* @return Resources associated with the specified transaction branch
* @throws XAException Unknown XID (only thrown if throwExceptionIfNotFound=true)
*/
public synchronized static DirectXAResource[] getXAResources(XidImpl xid, boolean throwExceptionIfNotFound) throws XAException{
Set resources = resourceMap.get(xid);
if (resources==null){
if (throwExceptionIfNotFound){
XAException xae = new XAException("Unknown XID (was start() called?");
throw xae;
} else {
return new DirectXAResource[0];
}
}
return resources.toArray(new DirectXAResource[resources.size()]);
}
/**
* Return whether the resources map is empty
*
* This is for use by tests
*
* @return
*/
public static boolean isEmpty(){
return resourceMap.isEmpty();
}
}