org.jboss.ejb.client.XidTransactionID Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* JBoss, Home of Professional Open Source.
* Copyright 2017 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jboss.ejb.client;
import java.util.Arrays;
import javax.transaction.xa.Xid;
import static java.lang.Math.min;
import static java.util.Arrays.copyOfRange;
/**
* A transaction ID for an XID, used to propagate transactions from a transaction controller running on this or
* a calling node.
*
* @deprecated Retained only for protocol compatibility.
*
* @author David M. Lloyd
*/
@Deprecated
public final class XidTransactionID extends TransactionID {
private static final long serialVersionUID = -1895745528459825578L;
private final Xid xid = new XidImpl();
/*
* The format is:
* byte 0: 0x02
* byte 1..4: XID format ID
* byte 5: gtid length == g
* byte 6..6+g-1: gtid
* byte 6+g: bqal length == b
* byte 7+g..7+g+b-1: bqal
*
* assert g = length - 7 - b
* assert b = length - 7 - g
* assert length = g + b + 7
*/
XidTransactionID(final byte[] encodedBytes) {
super(encodedBytes);
final byte gtidLen = encodedBytes[5];
final int length = encodedBytes.length;
if (gtidLen > min(Byte.MAX_VALUE, Xid.MAXGTRIDSIZE) || gtidLen > length - 7) {
throw new IllegalArgumentException("Invalid global transaction ID length");
}
final byte bqalLen = encodedBytes[6 + gtidLen];
if (bqalLen > min(Byte.MAX_VALUE, Xid.MAXBQUALSIZE) || bqalLen != length - gtidLen - 7) {
throw new IllegalArgumentException("Invalid branch qualifier length");
}
}
public XidTransactionID(final Xid original) {
this(encode(original));
}
private static byte[] encode(final Xid original) {
final byte[] gtid = original.getGlobalTransactionId();
final byte[] bqal = original.getBranchQualifier();
final int formatId = original.getFormatId();
final byte[] target = new byte[gtid.length + bqal.length + 7];
target[0] = 0x02;
target[1] = (byte) (formatId >>> 24);
target[2] = (byte) (formatId >>> 16);
target[3] = (byte) (formatId >>> 8);
target[4] = (byte) (formatId);
target[5] = (byte) gtid.length;
System.arraycopy(gtid, 0, target, 6, gtid.length);
target[6 + gtid.length] = (byte) bqal.length;
System.arraycopy(bqal, 0, target, 7 + gtid.length, bqal.length);
return target;
}
static int getGtidLen(byte[] raw) {
return raw[5];
}
static int getBqalLen(byte[] raw) {
return raw[getGtidLen(raw) + 6];
}
/**
* Get the corresponding XID for this transaction.
*
* @return the XID
*/
public Xid getXid() {
return xid;
}
/**
* Determine whether the given Xid is the same as this Xid.
*
* @param xid the xid to test
* @return {@code true} if it is the same Xid
*/
public boolean isSameXid(Xid xid) {
return this.xid.equals(xid);
}
final class XidImpl implements Xid {
public int getFormatId() {
final byte[] raw = getEncodedFormRaw();
return (raw[1] & 0xff) << 24 | (raw[2] & 0xff) << 16 | (raw[3] & 0xff) << 8 | (raw[4] & 0xff);
}
public byte[] getGlobalTransactionId() {
final byte[] raw = getEncodedFormRaw();
return copyOfRange(raw, 6, getGtidLen(raw) + 6);
}
public byte[] getBranchQualifier() {
final byte[] raw = getEncodedFormRaw();
assert raw.length == 7 + getGtidLen(raw) + getBqalLen(raw);
return copyOfRange(raw, 7 + getGtidLen(raw), raw.length);
}
public boolean equals(Object other) {
return other instanceof XidImpl && equals((XidImpl) other) || other instanceof Xid && equals((Xid) other);
}
private boolean equals(XidImpl other) {
return this == other || other != null && XidTransactionID.this.equals(other.getXidTransactionID());
}
private boolean equals(Xid other) {
return other != null && Arrays.equals(encode(other), getEncodedFormRaw());
}
public int hashCode() {
return XidTransactionID.this.hashCode();
}
XidTransactionID getXidTransactionID() {
return XidTransactionID.this;
}
}
}