org.jboss.ejb.client.SessionID 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.io.Serializable;
import java.util.Arrays;
/**
* A session ID for a stateful Enterprise Beans. Session IDs can be stored in multiple formats with different
* characteristics.
*
* @author David M. Lloyd
*/
public abstract class SessionID implements Serializable, Comparable {
private static final long serialVersionUID = 3872192729805797520L;
// The transient flags aren't really respected since we use object replacement.
private final byte[] encodedForm;
private final transient int hashCode;
/**
* Construct a new instance. The given array is used as-is, so if it comes from an untrusted source,
* it should first be cloned.
*
* @param encodedForm the encoded form of this session ID
*/
SessionID(final byte[] encodedForm) {
this.encodedForm = encodedForm;
hashCode = Arrays.hashCode(encodedForm);
}
/**
* Get a copy of the encoded form of this session ID.
*
* @return the copy of the encoded form
*/
public byte[] getEncodedForm() {
return encodedForm.clone();
}
/**
* Get the encoded form of this session ID. Note that callers must take care to avoid
* modifying the encoded form.
*
* @return the encoded form
*/
protected byte[] getEncodedFormRaw() {
return encodedForm;
}
/**
* Determine whether this object is equal to another. Session IDs are equal if their encoded form is
* equal and the class is equal.
*
* @param other the other object
* @return {@code true} if they are equal, {@code false} otherwise
*/
public final boolean equals(Object other) {
return this == other || other != null && other.getClass() == getClass() && equals((SessionID) other);
}
private boolean equals(SessionID other) {
return Arrays.equals(encodedForm, other.encodedForm);
}
public final int hashCode() {
return hashCode;
}
@Override
public int compareTo(SessionID id) {
int result = this.encodedForm.length - id.encodedForm.length;
for (int i = 0; (result == 0) && (i < this.encodedForm.length); ++i) {
result = Byte.compare(this.encodedForm[i], id.encodedForm[i]);
}
return result;
}
/**
* Create a session ID object for the given encoded representation.
*
* @param encoded the encoded representation
* @return the session ID object
*/
public static SessionID createSessionID(byte[] encoded) {
final int length = encoded.length;
if (length >= 19 && encoded[0] == 0x07) {
return new BasicSessionID(encoded.clone());
} else if (length == 17 && encoded[0] == 0x09) {
return new UUIDSessionID(encoded.clone());
}
return new UnknownSessionID(encoded.clone());
}
/**
* Substitute this session ID with a serialized representation.
*
* @return the serialized representation
*/
protected final Object writeReplace() {
return new Serialized(encodedForm);
}
/**
* Serialized representation of a session ID..
*/
public static final class Serialized implements Serializable {
private static final long serialVersionUID = -6014782612354158572L;
/**
* The bytes of the session ID.
*
* @serial
*/
private final byte[] id;
Serialized(final byte[] id) {
this.id = id;
}
/**
* Reconstitute the session ID from this serialized representation.
*
* @return the session ID object
*/
protected Object readResolve() {
return createSessionID(id);
}
}
@Override
public String toString() {
return String.format("%s [%s]", getClass().getSimpleName(), ArrayUtil.bytesToString(encodedForm, 0, encodedForm.length));
}
}