Top Description Fields Constructors Methods
org.hsqldb.jdbc.pool

public Class JDBCXID

extends Object
implements Xid
Class Inheritance
All Implemented Interfaces
javax.transaction.xa.Xid
Imports
java.net.Inet4Address, java.util.Arrays, .Random, javax.transaction.xa.Xid
Implementation of Xid for tests. 
// Example usage:

JDBCXADataSource ds = new JDBCXADataSource();

ds.setUser(user);
ds.setPassword(password);
ds.setUrl(jdbcUrl);

XAConnection xaCon = ds.getConnection();
Connection con = xaCon.getConnection();
Xid xid = JDBCXID.getUniqueXid((int)Thread.currentThread().getId());
XAResource xaRes = xaCon.getXAResource();

 // Start the transaction.
System.out.println("Starting XA transaction with xid = " + xid.toString());

xaRes.setTransactionTimeout(0);
xaRes.start(xid,XAResource.TMNOFLAGS);

// Do work here ....

// Commit the transaction.
xaRes.end(xid,XAResource.TMSUCCESS);
xaRes.commit(xid,true);

// Cleanup.
con.close();
xaCon.close();
Authors
Fred Toussi (fredt@users dot sourceforge.net), Campbell Burnet (campbell-burnet@users dot sourceforge.net)
Version
2.1

Field Summary

Modifier and TypeField and Description
pack-priv int
formatID

pack-priv int
hash

pack-priv boolean
hashComputed

private static byte[]
s_localIp

private static int
s_txnSequenceNumber

pack-priv byte[]
txBranch

pack-priv byte[]
txID

private static final int
UXID_FORMAT_ID

Constructor Summary

AccessConstructor and Description
public
JDBCXID(int formatID, byte[] txID, byte[] txBranch)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public byte[]
getBranchQualifier()

Implements javax.transaction.xa.Xid.getBranchQualifier.

Obtain the transaction branch identifier part of XID as an array of bytes.

public int
getFormatId()

Implements javax.transaction.xa.Xid.getFormatId.

Obtain the format identifier part of the XID.

public byte[]
getGlobalTransactionId()

Implements javax.transaction.xa.Xid.getGlobalTransactionId.

Obtain the global transaction identifier part of XID as an array of bytes.

private static byte[]
getLocalIp()

public static Xid

Returns:

a randomly generated JDBCXID
getUniqueXid(final int
can be a real thread id or just some convenient tracking value.
threadId)

Retrieves a randomly generated JDBCXID.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

private static int
nextTxnSequenceNumber()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

formatIDback to summary
pack-priv int formatID
hashback to summary
pack-priv int hash
hashComputedback to summary
pack-priv boolean hashComputed
s_localIpback to summary
private static byte[] s_localIp
s_txnSequenceNumberback to summary
private static int s_txnSequenceNumber
txBranchback to summary
pack-priv byte[] txBranch
txIDback to summary
pack-priv byte[] txID
UXID_FORMAT_IDback to summary
private static final int UXID_FORMAT_ID

Constructor Detail

JDBCXIDback to summary
public JDBCXID(int formatID, byte[] txID, byte[] txBranch)

Method Detail

equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getBranchQualifierback to summary
public byte[] getBranchQualifier()

Implements javax.transaction.xa.Xid.getBranchQualifier.

Doc from javax.transaction.xa.Xid.getBranchQualifier.

Obtain the transaction branch identifier part of XID as an array of bytes.

getFormatIdback to summary
public int getFormatId()

Implements javax.transaction.xa.Xid.getFormatId.

Doc from javax.transaction.xa.Xid.getFormatId.

Obtain the format identifier part of the XID.

getGlobalTransactionIdback to summary
public byte[] getGlobalTransactionId()

Implements javax.transaction.xa.Xid.getGlobalTransactionId.

Doc from javax.transaction.xa.Xid.getGlobalTransactionId.

Obtain the global transaction identifier part of XID as an array of bytes.

getLocalIpback to summary
private static byte[] getLocalIp()
getUniqueXidback to summary
public static Xid getUniqueXid(final int threadId)

Retrieves a randomly generated JDBCXID.

The newly generated object is based on the local IP address, the given threadId and a randomly generated number using the current time in milliseconds as the random seed.

Note that java.util.Random is used, not java.security.SecureRandom.

Parameters
threadId:int

can be a real thread id or just some convenient tracking value.

Returns:Xid

a randomly generated JDBCXID

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
nextTxnSequenceNumberback to summary
private static int nextTxnSequenceNumber()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.