KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > transaction > xa > Xid


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24 package javax.transaction.xa;
25
26 /**
27  * The Xid interface is a Java mapping of the X/Open transaction identifier
28  * XID structure. This interface specifies three accessor methods to
29  * retrieve a global transaction's format ID, global transaction ID,
30  * and branch qualifier. The Xid interface is used by the transaction
31  * manager and the resource managers. This interface is not visible to
32  * the application programs.
33  */
34 public interface Xid {
35     
36     /**
37      * Maximum number of bytes returned by getGtrid.
38      */
39     final static int MAXGTRIDSIZE = 64;
40
41     /**
42      * Maximum number of bytes returned by getBqual.
43      */
44     final static int MAXBQUALSIZE = 64;
45
46     /**
47      * Obtain the format identifier part of the XID.
48      *
49      * @return Format identifier. O means the OSI CCR format.
50      */
51     int getFormatId();
52
53     /**
54      * Obtain the global transaction identifier part of XID as an array
55      * of bytes.
56      *
57      * @return Global transaction identifier.
58      */
59     byte[] getGlobalTransactionId();
60
61     /**
62      * Obtain the transaction branch identifier part of XID as an array
63      * of bytes.
64      *
65      * @return Global transaction identifier.
66      */
67     byte[] getBranchQualifier();
68 }
69
Popular Tags