1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36
37 package javax.transaction.xa;
38
39 /**
40 * The Xid interface is a Java mapping of the X/Open transaction identifier
41 * XID structure. This interface specifies three accessor methods to
42 * retrieve a global transaction's format ID, global transaction ID,
43 * and branch qualifier. The Xid interface is used by the transaction
44 * manager and the resource managers. This interface is not visible to
45 * the application programs.
46 */
47 public interface Xid {
48
49 /**
50 * Maximum number of bytes returned by getGtrid.
51 */
52 final static int MAXGTRIDSIZE = 64;
53
54 /**
55 * Maximum number of bytes returned by getBqual.
56 */
57 final static int MAXBQUALSIZE = 64;
58
59 /**
60 * Obtain the format identifier part of the XID.
61 *
62 * @return Format identifier. O means the OSI CCR format.
63 */
64 int getFormatId();
65
66 /**
67 * Obtain the global transaction identifier part of XID as an array
68 * of bytes.
69 *
70 * @return Global transaction identifier.
71 */
72 byte[] getGlobalTransactionId();
73
74 /**
75 * Obtain the transaction branch identifier part of XID as an array
76 * of bytes.
77 *
78 * @return Global transaction identifier.
79 */
80 byte[] getBranchQualifier();
81 }
Save This Page