com.sun.gjc.spi.XAResourceImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* 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.
*/
// Portions Copyright [2018] Payara Foundation and/or affiliates
package com.sun.gjc.spi;
import javax.transaction.xa.XAException;
import javax.transaction.xa.XAResource;
import javax.transaction.xa.Xid;
/**
* XAResource wrapper for Generic JDBC Connector.
*
* @author Evani Sai Surya Kiran
* @version 1.0, 02/08/23
*/
public class XAResourceImpl implements XAResource {
XAResource xar;
ManagedConnectionImpl mc;
/**
* Constructor for XAResourceImpl
*
* @param xar XAResource
* @param mc ManagedConnection
*/
public XAResourceImpl(XAResource xar, ManagedConnectionImpl mc) {
this.xar = xar;
this.mc = mc;
}
/**
* Commit the global transaction specified by xid.
*
* @param xid A global transaction identifier
* @param onePhase If true, the resource manager should use a one-phase commit
* protocol to commit the work done on behalf of xid.
*/
@Override
public void commit(Xid xid, boolean onePhase) throws XAException {
//the mc.transactionCompleted call has come here because
//the transaction *actually* completes after the flow
//reaches here. the end() method might not really signal
//completion of transaction in case the transaction is
//suspended. In case of transaction suspension, the end
//method is still called by the transaction manager
try {
xar.commit(xid, onePhase);
} catch (XAException xae) {
throw xae;
} catch (Exception e) {
throw new XAException(e.getMessage());
} finally {
mc.transactionCompleted();
}
}
/**
* Ends the work performed on behalf of a transaction branch.
*
* @param xid A global transaction identifier that is the same as what
* was used previously in the start method.
* @param flags One of TMSUCCESS, TMFAIL, or TMSUSPEND
*/
@Override
public void end(Xid xid, int flags) throws XAException {
xar.end(xid, flags);
//GJCINT
//mc.transactionCompleted();
}
/**
* Tell the resource manager to forget about a heuristically completed transaction branch.
*
* @param xid A global transaction identifier
*/
@Override
public void forget(Xid xid) throws XAException {
xar.forget(xid);
}
/**
* Obtain the current transaction timeout value set for this
* XAResource instance.
*
* @return the transaction timeout value in seconds
*/
@Override
public int getTransactionTimeout() throws XAException {
return xar.getTransactionTimeout();
}
/**
* This method is called to determine if the resource manager instance
* represented by the target object is the same as the resouce manager
* instance represented by the parameter xares.
*
* @param xares An XAResource object whose resource manager
* instance is to be compared with the resource
* @return true if it's the same RM instance; otherwise false.
*/
@Override
public boolean isSameRM(XAResource xares) throws XAException {
return xar.isSameRM(xares);
}
/**
* Ask the resource manager to prepare for a transaction commit
* of the transaction specified in xid.
*
* @param xid A global transaction identifier
* @return A value indicating the resource manager's vote on the
* outcome of the transaction. The possible values
* are: XA_RDONLY or XA_OK. If the resource manager wants
* to roll back the transaction, it should do so
* by raising an appropriate XAException in the prepare method.
*/
@Override
public int prepare(Xid xid) throws XAException {
try {
int result = xar.prepare(xid);
//When the VOTE from resource manager is XA_RDONLY , we will not get commit() call from TxManager.
//Hence calling txCompleted.
if (result == XAResource.XA_RDONLY) {
mc.transactionCompleted();
}
return result;
} catch (XAException xae) {
mc.transactionCompleted();
throw xae;
} catch (Exception e) {
mc.transactionCompleted();
throw new XAException(e.getMessage());
}
}
/**
* Obtain a list of prepared transaction branches from a resource manager.
*
* @param flag One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS
* must be used when no other flags are set in flags.
* @return The resource manager returns zero or more XIDs for the transaction
* branches that are currently in a prepared or heuristically
* completed state. If an error occurs during the operation, the resource
* manager should throw the appropriate XAException.
*/
@Override
public Xid[] recover(int flag) throws XAException {
return xar.recover(flag);
}
/**
* Inform the resource manager to roll back work done on behalf of a transaction branch
*
* @param xid A global transaction identifier
*/
@Override
public void rollback(Xid xid) throws XAException {
//the mc.transactionCompleted call has come here becasue
//the transaction *actually* completes after the flow
//reaches here. the end() method might not really signal
//completion of transaction in case the transaction is
//suspended. In case of transaction suspension, the end
//method is still called by the transaction manager
try {
xar.rollback(xid);
} catch (XAException xae) {
throw xae;
} catch (Exception e) {
throw new XAException(e.getMessage());
} finally {
mc.transactionCompleted();
}
}
/**
* Set the current transaction timeout value for this XAResource instance.
*
* @param seconds the transaction timeout value in seconds.
* @return true if transaction timeout value is set successfully; otherwise false.
*/
@Override
public boolean setTransactionTimeout(int seconds) throws XAException {
return xar.setTransactionTimeout(seconds);
}
/**
* Start work on behalf of a transaction branch specified in xid.
*
* @param xid A global transaction identifier to be associated with the resource
* @param flags One of {@link #TMNOFLAGS}, {@link #TMJOIN}, or {@link #TMRESUME}
*/
@Override
public void start(Xid xid, int flags) throws XAException {
//GJCINT
mc.transactionStarted();
xar.start(xid, flags);
}
}