-
Notifications
You must be signed in to change notification settings - Fork 33
/
XidImpl.java
350 lines (301 loc) · 10.5 KB
/
XidImpl.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
/*
* Copyright (c) 2000, 2017 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2020 Payara Services Ltd.
* Copyright (c) 2021, 2022 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package com.sun.messaging.jmq.util;
import javax.transaction.xa.Xid;
/**
* The XID class provides an implementation of the X/Open transaction identifier it implements the
* javax.transaction.xa.Xid interface.
*
* Taken from the RI
*
* @see javax.transaction.xa.Xid
*/
public class XidImpl implements Xid, java.io.Serializable {
private static final long serialVersionUID = -8490751945727661234L;
// -----------------------------------------------------------------------//
// Data
// -----------------------------------------------------------------------//
protected int formatId; // Format identifier (-1) means null
protected byte branchQualifier[];
protected byte globalTxnId[];
protected int gtLength;
protected int bqLength;
// -----------------------------------------------------------------------//
// Constants //
// -----------------------------------------------------------------------//
/**
* The maximum size of the global transaction identifier.
*/
public static final int MAXGTXNSIZE = 64;
/**
* The maximum size of the branch qualifier.
*/
public static final int MAXBQUALSIZE = 64;
/**
* Specified by X/Open Spec. as identifier for NULL Xid. Not mentioned in JTA.
*/
public static final int NULL_XID = -1;
/**
* Standard Xid format. Will be used by JTA
*/
public static final int OSICCR_XID = 0;
/**
* Constructs a new null XidImpl. After construction the data within the XidImpl should be initialized.
*/
public XidImpl() {
branchQualifier = new byte[MAXBQUALSIZE];
globalTxnId = new byte[MAXGTXNSIZE];
formatId = NULL_XID;
bqLength = 0;
gtLength = 0;
}
/**
* Constructs an XidImpl using another XID as the source of data. This makes no assumptions about the actual XID
* implementation. As such it only uses the XID interface methods.
*
* @param xid the Xid to initialize this XID from
*
*/
public XidImpl(Xid xid) {
branchQualifier = new byte[MAXBQUALSIZE];
globalTxnId = new byte[MAXGTXNSIZE];
this.copy(xid);
}
/**
* Initialize an XID using another XID as the source of data. This makes no assumptions about the actual XID
* implementation. As such it only uses the XID interface methods.
*
* @param xid the Xid to initialize this XID from
*
*/
public void copy(Xid xid) {
byte[] tmp;
if ((xid == null) || (xid.getFormatId() == NULL_XID)) {
formatId = NULL_XID;
bqLength = 0;
gtLength = 0;
return;
}
formatId = xid.getFormatId();
tmp = xid.getBranchQualifier();
bqLength = (tmp.length > MAXBQUALSIZE) ? MAXBQUALSIZE : tmp.length;
System.arraycopy(tmp, 0, branchQualifier, 0, bqLength);
tmp = xid.getGlobalTransactionId();
gtLength = (tmp.length > MAXGTXNSIZE) ? MAXGTXNSIZE : tmp.length;
System.arraycopy(tmp, 0, globalTxnId, 0, gtLength);
}
/**
* Determine whether or not two Xid's represent the same transaction. This makes no assumptions about the actual Xid
* implementation. As such it only uses the Xid interface methods.
*
* @param obj the object to be compared with this Xid.
*
* @return Returns true of the supplied xid represents the same global transaction as this, otherwise returns false.
*/
@Override
public boolean equals(Object obj) {
return this.equals((Xid) obj);
}
public boolean equals(Xid xid) {
// If the the other xid is null or this one is uninitialized than the Xid's
// are not equal. Since the other Xid may be a different implementation we
// can't assume that the formatId has a special value of -1 if not initialized.
if ((xid == null) || (formatId == NULL_XID)) {
return false;
}
return (formatId == xid.getFormatId()) && this.isEqualGlobalTxnId(xid.getGlobalTransactionId())
&& this.isEqualBranchQualifier(xid.getBranchQualifier());
}
/**
* Compute the hash code. It is necessary to override the Object hashcode() which uses addresses to hash. Xid's are more
* like Strings in that we are interested in the contents of the Xid, not its object identity. This is because two Xid's
* equal in value but different objects (i.e. different addresses) would generate different hashcodes.
*
* @return the computed hashcode
*/
@Override
public int hashCode() {
int hash = 0;
// Use the first and last byte of the transaction ID and branch
// qualifier to make up a 4 byte hash code. . This creates a decent
// hash.
if (bqLength >= 2) {
hash += branchQualifier[bqLength - 1] << 8;
}
if (bqLength >= 1) {
hash += branchQualifier[0];
}
if (gtLength >= 2) {
hash += globalTxnId[gtLength - 1] << 24;
}
if (gtLength >= 1) {
hash += globalTxnId[0] << 16;
}
return hash;
}
/**
* Return a string representing this XID.
*
* @return the string representation of this XID
*/
private static final String hextab = "0123456789ABCDEF";
public String toLongString() {
StringBuffer data = new StringBuffer(200);
int i;
int value;
data.append("{XID:hash(").append(this.hashCode()).append(")fmt(").append(formatId).append(")bq(");
// Add branch qualifierConvert data string to hex
for (i = 0; i < bqLength; i++) {
value = branchQualifier[i] & 0xff;
data.append("0x").append(hextab.charAt(value / 16)).append(hextab.charAt(value & 15));
if (i != (bqLength - 1)) {
data.append(',');
}
}
data.append(")gt(");
// Add global transaction id
for (i = 0; i < gtLength; i++) {
value = globalTxnId[i] & 0xff;
data.append("0x").append(hextab.charAt(value / 16)).append(hextab.charAt(value & 15));
if (i != (gtLength - 1)) {
data.append(',');
}
}
data.append(")}");
return new String(data);
}
/**
* Return a short string representing this XID. Used for lookup and database key.
*
* @return the string representation of this XID
*/
@Override
public String toString() {
StringBuffer data = new StringBuffer(256);
int i;
int value;
if (formatId == NULL_XID) {
return "NULL_XID";
}
// Add branch qualifier. Convert data string to hex
for (i = 0; i < bqLength; i++) {
value = branchQualifier[i] & 0xff;
data.append(hextab.charAt(value / 16));
data.append(hextab.charAt(value & 15));
}
// Add global transaction id
for (i = 0; i < gtLength; i++) {
value = globalTxnId[i] & 0xff;
data.append(hextab.charAt(value / 16));
data.append(hextab.charAt(value & 15));
}
return new String(data);
}
/**
* Returns the branch qualifier for this XID.
*
* @return the branch qualifier
*/
@Override
public byte[] getBranchQualifier() {
byte[] bq = new byte[bqLength];
System.arraycopy(branchQualifier, 0, bq, 0, bqLength);
return bq;
}
/**
* Set the branch qualifier for this XID.
*
* @param bq Byte array containing the branch qualifier to be set. If the size of the array exceeds MAXBQUALSIZE, only
* the first MAXBQUALSIZE elements of bq will be used.
*/
public void setBranchQualifier(byte[] bq) {
bqLength = (bq.length > MAXBQUALSIZE) ? MAXBQUALSIZE : bq.length;
System.arraycopy(bq, 0, branchQualifier, 0, bqLength);
}
/**
* Obtain the format identifier part of the XID.
*
* @return Format identifier.
*/
@Override
public int getFormatId() {
return formatId;
}
/**
* Set the format identifier part of the XID.
*
* @param formatId Format identifier.
*/
public void setFormatId(int formatId) {
this.formatId = formatId;
return;
}
/**
* Compares the input parameter with the branch qualifier for equality.
*
* @return true if equal
*/
public boolean isEqualBranchQualifier(byte[] bq) {
if (bq == null) {
return bqLength == 0;
}
if (bq.length != bqLength) {
return false;
}
for (int i = 0; i < bqLength; i++) {
if (bq[i] != branchQualifier[i]) {
return false;
}
}
return true;
}
/**
* Compares the input parameter with the global transaction Id for equality.
*
* @return true if equal
*/
public boolean isEqualGlobalTxnId(byte[] gt) {
if (gt == null) {
return gtLength == 0;
}
if (gt.length != gtLength) {
return false;
}
for (int i = 0; i < gtLength; i++) {
if (gt[i] != globalTxnId[i]) {
return false;
}
}
return true;
}
/**
* Returns the global transaction identifier for this XID.
*
* @return the global transaction identifier
*/
@Override
public byte[] getGlobalTransactionId() {
byte[] gt = new byte[gtLength];
System.arraycopy(globalTxnId, 0, gt, 0, gtLength);
return gt;
}
public void setGlobalTransactionId(byte[] gt) {
gtLength = (gt.length > MAXGTXNSIZE) ? MAXGTXNSIZE : gt.length;
System.arraycopy(gt, 0, globalTxnId, 0, gtLength);
}
}