org.objectweb.transaction.api.xid
Interface XidState

All Superinterfaces:
State

public interface XidState
extends State

The format of XID must follow these rules :

Version:
0.1
Author:
Romain Rouvoy
ADL:
name="XID_STATE" value="xid-state"

Field Summary
static int BQUAL_LENGTH_MAX
          Branch Qualifier Maximal Length
static int BQUAL_LENGTH_MIN
          Branch Qualifier Minimal Length
static int TID_LENGTH_MAX
          Transaction Identifier Maximal Length
static int TID_LENGTH_MIN
          Transaction Identifier Minimal Length
static java.lang.String XID_STATE
          ADL Identifier
 
Fields inherited from interface org.objectweb.transaction.api.State
STATE
 
Method Summary
 byte[] getBranchQualifier()
          Provides the value of the Branch Qualifier of the XID
 int getFormatId()
          Provides the value of the Format Identifier used by the implementation
 byte[] getGlobalTransactionId()
          Provides the value of the Global Transaction Identifier
 void setBranchQualifier(byte[] bqual)
          Defines the value of the Branch Qualifier of the XID
 void setFormatId(int fid)
          Defines the value of the Format Identifier of the XID
 void setGlobalTransactionId(byte[] gtid)
          Defines the value of the Global Transaction Identifier
 

Field Detail

XID_STATE

public static final java.lang.String XID_STATE
ADL Identifier

See Also:
Constant Field Values

BQUAL_LENGTH_MIN

public static final int BQUAL_LENGTH_MIN
Branch Qualifier Minimal Length

See Also:
Constant Field Values

BQUAL_LENGTH_MAX

public static final int BQUAL_LENGTH_MAX
Branch Qualifier Maximal Length

See Also:
Constant Field Values

TID_LENGTH_MIN

public static final int TID_LENGTH_MIN
Transaction Identifier Minimal Length

See Also:
Constant Field Values

TID_LENGTH_MAX

public static final int TID_LENGTH_MAX
Transaction Identifier Maximal Length

See Also:
Constant Field Values
Method Detail

setBranchQualifier

public void setBranchQualifier(byte[] bqual)
Defines the value of the Branch Qualifier of the XID

Parameters:
bqual - - a byte array representing the Branch Qualifier

setFormatId

public void setFormatId(int fid)
Defines the value of the Format Identifier of the XID

Parameters:
fid - - the value of the Format Identifier

setGlobalTransactionId

public void setGlobalTransactionId(byte[] gtid)
Defines the value of the Global Transaction Identifier

Parameters:
gtid - - the global transaction identifier

getBranchQualifier

public byte[] getBranchQualifier()
Provides the value of the Branch Qualifier of the XID

Returns:
a byte array representing the Branch Qualifier

getFormatId

public int getFormatId()
Provides the value of the Format Identifier used by the implementation

Returns:
the encoded Format Identifier value

getGlobalTransactionId

public byte[] getGlobalTransactionId()
Provides the value of the Global Transaction Identifier

Returns:
the encoded Global Transaction Identifier value