01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17:
18: package javax.transaction.xa;
19:
20: /**
21: * An interface which provides a mapping for the X/Open XID transaction
22: * identifier structure. The Xid interface is used by the Transaction Manager
23: * and the Resource managers. It is not typically used by application programs.
24: */
25: public interface Xid {
26:
27: /**
28: * The maximum number of bytes which will be returned by
29: * getGlobaltransaction Id
30: */
31: public static final int MAXGTRIDSIZE = 64;
32:
33: /**
34: * The maximum number of bytes which will be returned by getBranchQualifier
35: */
36: public static final int MAXBQUALSIZE = 64;
37:
38: /**
39: * Gets the transaction branch qualifier component of the XID.
40: *
41: * @return an array of bytes containing the transaction branch qualifier.
42: */
43: public byte[] getBranchQualifier();
44:
45: /**
46: * Gets the format identifier component of the XID.
47: *
48: * @return an integer containing the format identifier. 0 means the OSI CCR
49: * format.
50: */
51: public int getFormatId();
52:
53: /**
54: * Gets the global transaction identifier component of the XID.
55: *
56: * @return an array of bytes containing the global transaction identifier.
57: */
58: public byte[] getGlobalTransactionId();
59: }
|