Xid (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.transaction.xa
Interface Xid

public interface Xid

The Xid interface is a Java mapping of the X/Open transaction identifier XID structure. This interface specifies three accessor methods to retrieve a global transaction's format ID, global transaction ID, and branch qualifier. The Xid interface is used by the transaction manager and the resource managers. This interface is not visible to the application programs.

Field Summary

static int MAXBQUALSIZE
          Maximum number of bytes returned by getBqual.

static int MAXGTRIDSIZE
          Maximum number of bytes returned by getGtrid.

Method Summary

byte[] getBranchQualifier()
          Obtain the transaction branch identifier part of XID as an array of bytes.

int getFormatId()
          Obtain the format identifier part of the XID.

byte[] getGlobalTransactionId()
          Obtain the global transaction identifier part of XID as an array of bytes.

Field Summary
`static int`	`MAXBQUALSIZE` Maximum number of bytes returned by getBqual.
`static int`	`MAXGTRIDSIZE` Maximum number of bytes returned by getGtrid.

Method Summary
`byte[]`	`getBranchQualifier()` Obtain the transaction branch identifier part of XID as an array of bytes.
`int`	`getFormatId()` Obtain the format identifier part of the XID.
`byte[]`	`getGlobalTransactionId()` Obtain the global transaction identifier part of XID as an array of bytes.

Field Detail

MAXGTRIDSIZE

static final int MAXGTRIDSIZE

Maximum number of bytes returned by getGtrid.

See Also:: Constant Field Values

MAXBQUALSIZE

static final int MAXBQUALSIZE

Maximum number of bytes returned by getBqual.

See Also:: Constant Field Values

Method Detail

getFormatId

int getFormatId()

Obtain the format identifier part of the XID.

Returns:: Format identifier. O means the OSI CCR format.

getGlobalTransactionId

byte[] getGlobalTransactionId()

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

Returns:: Global transaction identifier.

getBranchQualifier

byte[] getBranchQualifier()

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

Returns:: Global transaction identifier.