*/
package org.opendaylight.controller.cluster.access.concepts;
+import static java.util.Objects.requireNonNull;
+
import com.google.common.base.MoreObjects;
-import com.google.common.base.Preconditions;
import java.io.DataInput;
import java.io.DataOutput;
-import java.io.Externalizable;
import java.io.IOException;
-import java.io.ObjectInput;
-import java.io.ObjectOutput;
-import org.opendaylight.yangtools.concepts.Identifier;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.yangtools.concepts.WritableIdentifier;
+import org.opendaylight.yangtools.concepts.WritableObjects;
/**
- * Globally-unique identifier of a local history.
- *
- * @author Robert Varga
+ * Globally-unique identifier of a local history. This identifier is assigned on the frontend and is composed of
+ * - a {@link ClientIdentifier}, which uniquely identifies a single instantiation of a particular frontend
+ * - an unsigned long, which uniquely identifies the history on the backend
+ * - an unsigned long cookie, assigned by the client and meaningless on the backend, which just reflects it back
*/
-public final class LocalHistoryIdentifier implements Identifier, WritableObject {
- private static final class Proxy implements Externalizable {
- private static final long serialVersionUID = 1L;
- private ClientIdentifier clientId;
- private long historyId;
-
- public Proxy() {
- // For Externalizable
- }
-
- Proxy(final ClientIdentifier frontendId, final long historyId) {
- this.clientId = Preconditions.checkNotNull(frontendId);
- this.historyId = historyId;
- }
-
- @Override
- public void writeExternal(final ObjectOutput out) throws IOException {
- clientId.writeTo(out);
- WritableObjects.writeLong(out, historyId);
- }
-
- @Override
- public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
- clientId = ClientIdentifier.readFrom(in);
- historyId = WritableObjects.readLong(in);
- }
-
- private Object readResolve() {
- return new LocalHistoryIdentifier(clientId, historyId);
- }
- }
-
+public final class LocalHistoryIdentifier implements WritableIdentifier {
+ @java.io.Serial
private static final long serialVersionUID = 1L;
- private final ClientIdentifier clientId;
+
+ private final @NonNull ClientIdentifier clientId;
private final long historyId;
+ private final long cookie;
public LocalHistoryIdentifier(final ClientIdentifier frontendId, final long historyId) {
- this.clientId = Preconditions.checkNotNull(frontendId);
+ this(frontendId, historyId, 0);
+ }
+
+ public LocalHistoryIdentifier(final ClientIdentifier frontendId, final long historyId, final long cookie) {
+ clientId = requireNonNull(frontendId);
this.historyId = historyId;
+ this.cookie = cookie;
}
- public static LocalHistoryIdentifier readFrom(final DataInput in) throws IOException {
+ public static @NonNull LocalHistoryIdentifier readFrom(final DataInput in) throws IOException {
final ClientIdentifier clientId = ClientIdentifier.readFrom(in);
- return new LocalHistoryIdentifier(clientId, WritableObjects.readLong(in));
+
+ final byte header = WritableObjects.readLongHeader(in);
+ return new LocalHistoryIdentifier(clientId, WritableObjects.readFirstLong(in, header),
+ WritableObjects.readSecondLong(in, header));
}
@Override
public void writeTo(final DataOutput out) throws IOException {
clientId.writeTo(out);
- WritableObjects.writeLong(out, historyId);
+ WritableObjects.writeLongs(out, historyId, cookie);
}
- public ClientIdentifier getClientId() {
+ public @NonNull ClientIdentifier getClientId() {
return clientId;
}
return historyId;
}
+ public long getCookie() {
+ return cookie;
+ }
+
@Override
public int hashCode() {
- return clientId.hashCode() * 31 + Long.hashCode(historyId);
+ int ret = clientId.hashCode();
+ ret = 31 * ret + Long.hashCode(historyId);
+ ret = 31 * ret + Long.hashCode(cookie);
+ return ret;
}
@Override
- public boolean equals(final Object o) {
- if (this == o) {
+ public boolean equals(final Object obj) {
+ if (this == obj) {
return true;
}
- if (!(o instanceof LocalHistoryIdentifier)) {
+ if (!(obj instanceof LocalHistoryIdentifier other)) {
return false;
}
- final LocalHistoryIdentifier other = (LocalHistoryIdentifier) o;
- return historyId == other.historyId && clientId.equals(other.clientId);
+ return historyId == other.historyId && cookie == other.cookie && clientId.equals(other.clientId);
}
@Override
public String toString() {
return MoreObjects.toStringHelper(LocalHistoryIdentifier.class).add("client", clientId)
- .add("history", Long.toUnsignedString(historyId)).toString();
+ .add("history", Long.toUnsignedString(historyId, 16))
+ .add("cookie", Long.toUnsignedString(cookie, 16)).toString();
}
+ @java.io.Serial
private Object writeReplace() {
- return new Proxy(clientId, historyId);
+ return new HI(this);
}
}