org.apache.derby.iapi.store.access.xa: public class: XAXactId

org.apache.derby.iapi.store.access.xa
public class: XAXactId [javadoc | source]

java.lang.Object
   org.apache.derby.iapi.store.access.GlobalXact
      org.apache.derby.iapi.store.access.xa.XAXactId

All Implemented Interfaces:
Xid

The XAXactId class is a specific implementation of the JTA Xid interface. It is only used by the TransactionTable.restore() interface to return an array of Xid's back to the caller, as part of serving the XAresource.restore() interface.

It is NOT the object that is stored in the log. One reason for this is that the Formattable and Xid interface's define two different return values for the getFormatId() interface.
Fields inherited from org.apache.derby.iapi.store.access.GlobalXact:
format_id, global_id, branch_id

Constructor:

public XAXactId(Xid xid) throws XAException
{ if (xid == null) throw new XAException(XAException.XAER_NOTA); copy_init_xid( xid.getFormatId(), xid.getGlobalTransactionId(), xid.getBranchQualifier()); }
Construct an Xid using an external Xid.
Throws:
XAException - invalid external xid
exception: XAException - invalid external xid
public XAXactId(String xactIdString)
{ // extract it in pieces delimited by COLON int start, end, length; // xx start = 1; end = xactIdString.indexOf(COLON, start); if (SanityManager.DEBUG) SanityManager.ASSERT(end != -1, "illegal string format"); String xx = xactIdString.substring(start, end); int N = Integer.parseInt(xx); if (SanityManager.DEBUG) { SanityManager.ASSERT(N > 0 && N < = Xid.MAXGTRIDSIZE, "illegal gtrid size"); } // yy start = end+1; // skip the COLON end = xactIdString.indexOf(COLON, start); if (SanityManager.DEBUG) SanityManager.ASSERT(end != -1, "illegal string format"); String yy = xactIdString.substring(start,end); int M = Integer.parseInt(yy); if (SanityManager.DEBUG) SanityManager.ASSERT(M > 0 && N < = Xid.MAXBQUALSIZE, "illegal bqual size"); // ffffffff start = end+1; // skip the COLON end = xactIdString.indexOf(COLON, start); if (SanityManager.DEBUG) SanityManager.ASSERT(end != -1, "illegal string format"); String f = xactIdString.substring(start,end); format_id = Integer.parseInt(f, 16); // n...n start = end+1; // skip the COLON end = xactIdString.indexOf(COLON, start); if (SanityManager.DEBUG) SanityManager.ASSERT(end != -1, "illegal string format"); global_id = org.apache.derby.iapi.util.StringUtil.fromHexString(xactIdString, start, (end-start)); if (SanityManager.DEBUG) SanityManager.ASSERT(global_id.length == N, "inconsistent global_id length"); // m...m start = end+1; // skip the COLON end = xactIdString.indexOf(COLON, start); if (SanityManager.DEBUG) SanityManager.ASSERT(end != -1, "illegal string format"); branch_id = org.apache.derby.iapi.util.StringUtil.fromHexString(xactIdString, start, (end-start)); if (SanityManager.DEBUG) SanityManager.ASSERT(branch_id.length == M, "inconsistent branch_id length, expect " + M + " got " + branch_id.length); }
public XAXactId(int format_id, byte[] global_id, byte[] branch_id)
{ copy_init_xid(format_id, global_id, branch_id); }
Construct from given pieces of an Xid. Makes copies of arrays.

Method from org.apache.derby.iapi.store.access.xa.XAXactId Summary:
equals, getBranchQualifier, getFormatId, getGlobalTransactionId, toHexString
Methods from org.apache.derby.iapi.store.access.GlobalXact:
equals, hashCode, toString
Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Method from org.apache.derby.iapi.store.access.xa.XAXactId Detail:

public boolean equals(Object other)
{ if (other == this) return true; if (other == null) return false; try { if (other instanceof GlobalXact) return super.equals(other); // Just cast it and catch the exception rather than doing the type // checking twice. Xid other_xid = (Xid) other; return( java.util.Arrays.equals( other_xid.getGlobalTransactionId(), this.global_id) && java.util.Arrays.equals( other_xid.getBranchQualifier(), this.branch_id) && other_xid.getFormatId() == this.format_id); } catch(ClassCastException cce) { // this class only knows how to compare with other Xids if (SanityManager.DEBUG) SanityManager.THROWASSERT("comparing XAXactId with " + other.getClass().getName(), cce); return false; } }
public byte[] getBranchQualifier()
{ return(branch_id); }
Obtain the transaction branch qualifier part of the Xid in a byte array.
public int getFormatId()
{ return(format_id); }
Obtain the format id part of the Xid.
public byte[] getGlobalTransactionId()
{ return(global_id); }
Obtain the global transaction identifier part of XID as an array of bytes.
public String toHexString()
{ // the ascii representation of xid where xid is of // format_id = f // global_id = byte[N] // branch_id = byte[M] // // :xx:yy:ffffffff:n...n:mmmm...m: // where xx = N (up to 64 max) // yy = M (up to 64 max) // n..n = hex dump of global_id (0 to 128 bytes max) // m..m = hex dump of branch_qualifier (0 to 128 bytes max) // 1+2+1+2+1+9+1+1+1 int maxLength = 20+(global_id.length+branch_id.length)*2; StringBuffer hexdump = new StringBuffer(maxLength); hexdump.append(COLON). append(Integer.toString(global_id.length)).append(COLON). append(Integer.toString(branch_id.length)).append(COLON). append(Integer.toString(format_id, 16)).append(COLON). append(org.apache.derby.iapi.util.StringUtil.toHexString(global_id, 0, global_id.length)).append(COLON). append(org.apache.derby.iapi.util.StringUtil.toHexString(branch_id, 0, branch_id.length)).append(COLON); return hexdump.toString(); }