duke@1: /*
ohair@158:  * Copyright (c) 2000, 2002, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@158:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@158:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@158:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@158:  * or visit www.oracle.com if you need additional information or have any
ohair@158:  * questions.
duke@1:  */
duke@1: 
duke@1: package javax.transaction.xa;
duke@1: 
duke@1: /**
duke@1:  * The Xid interface is a Java mapping of the X/Open transaction identifier
duke@1:  * XID structure. This interface specifies three accessor methods to
duke@1:  * retrieve a global transaction format ID, global transaction ID,
duke@1:  * and branch qualifier. The Xid interface is used by the transaction
duke@1:  * manager and the resource managers. This interface is not visible to
duke@1:  * the application programs.
duke@1:  */
duke@1: public interface Xid {
duke@1: 
duke@1:     /**
duke@1:      * Maximum number of bytes returned by getGtrid.
duke@1:      */
duke@1:     final static int MAXGTRIDSIZE = 64;
duke@1: 
duke@1:     /**
duke@1:      * Maximum number of bytes returned by getBqual.
duke@1:      */
duke@1:     final static int MAXBQUALSIZE = 64;
duke@1: 
duke@1:     /**
duke@1:      * Obtain the format identifier part of the XID.
duke@1:      *
duke@1:      * @return Format identifier. O means the OSI CCR format.
duke@1:      */
duke@1:     int getFormatId();
duke@1: 
duke@1:     /**
duke@1:      * Obtain the global transaction identifier part of XID as an array
duke@1:      * of bytes.
duke@1:      *
duke@1:      * @return Global transaction identifier.
duke@1:      */
duke@1:     byte[] getGlobalTransactionId();
duke@1: 
duke@1:     /**
duke@1:      * Obtain the transaction branch identifier part of XID as an array
duke@1:      * of bytes.
duke@1:      *
duke@1:      * @return Global transaction identifier.
duke@1:      */
duke@1:     byte[] getBranchQualifier();
duke@1: }