Xid.java |
/* * JBoss, the OpenSource EJB server * * Distributable under LGPL license. * See terms of license at gnu.org. */ package javax.transaction.xa; /** * The Xid interface is a Java mapping of the X/Open transaction identifier * XID structure. * <p> * A transaction id is an aggregate of three parts: * <ul> * <li> The format identifier indicates the transaction family and tells * how the other two parts should be interpreted. * </li> * <li> The global transaction id denotes, with the format specifier, the * id of the global transaction. * </li> * <li> The branch qualifier denotes a particular branch of the global * transaction. * </li> * </ul> * <p> * 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: 1.2 $ */ public interface Xid { /** * The maximum possible size of a global transaction id. * This is the largest possible array returned by the * {@link #getGlobalTransactionId() getGlobalTransactionId} method. */ public static final int MAXGTRIDSIZE = 64; /** * The maximum possible size of a transaction branch qualifier. * This is the largest possible array returned by the * {@link #getBranchQualifier() getBranchQualifier} method. */ public static final int MAXBQUALSIZE = 64; /** * Get the format identifier. * * @return An integer denoting the family of this transaction, and * telling how the two other parts can be interpreted. */ public int getFormatId(); /** * 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. * * @return A byte array that together with the format ID * defines the globally unique ID of this transaction. */ public byte[] getGlobalTransactionId(); /** * 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. * * @return A byte array that identifies the branch of this * transaction. */ public byte[] getBranchQualifier(); }
Xid.java |