javax.transaction.xa

Interface Xid

All Known Implementing Classes:

DummyNoXaXid, DummyXid, JdbcXid, SerializableXid, XidImpl

public interface Xid

The Xid interface is a Java mapping of the X/Open transaction identifier XID structure.

A transaction id is an aggregate of three parts:

• The format identifier indicates the transaction family and tells how the other two parts should be interpreted.
• The global transaction id denotes, with the format specifier, the id of the global transaction.
• The branch qualifier denotes a particular branch of the global transaction.

The Xid interface is used by the application server, the transaction manager and the resource managers, and is not used in application programs.

Version:

$Revision$

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAXBQUALSIZE The maximum possible size of a transaction branch qualifier.
static int	MAXGTRIDSIZE The maximum possible size of a global transaction id.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getBranchQualifier() Get the transaction branch qualifier of this transaction.
int	getFormatId() Get the format identifier.
byte[]	getGlobalTransactionId() Get the global transaction id of this transaction.

Field Detail

MAXGTRIDSIZE

static final int MAXGTRIDSIZE

The maximum possible size of a global transaction id. This is the largest possible array returned by the getGlobalTransactionId method.

See Also:

Constant Field Values

MAXBQUALSIZE

static final int MAXBQUALSIZE

The maximum possible size of a transaction branch qualifier. This is the largest possible array returned by the getBranchQualifier method.

See Also:

Constant Field Values

Method Detail

getFormatId

int getFormatId()

Get the format identifier.

Returns:

An integer denoting the family of this transaction, and telling how the two other parts can be interpreted.

getGlobalTransactionId

byte[] getGlobalTransactionId()

Get the global transaction id of this transaction. Please note that JTA does not define if this method returns a copy or a reference to an internal byte array. For maximum portability, do not modify the returned array.

Returns:

A byte array that together with the format ID defines the globally unique ID of this transaction.

getBranchQualifier

byte[] getBranchQualifier()

Get the transaction branch qualifier of this transaction. Please note that JTA does not define if this method returns a copy or a reference to an internal byte array. For maximum portability, do not modify the returned array.

Returns:

A byte array that identifies the branch of this transaction.