2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.cluster.access.concepts;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.base.MoreObjects;
13 import java.io.Externalizable;
14 import java.io.IOException;
15 import java.io.ObjectInput;
16 import java.io.ObjectOutput;
17 import java.io.Serializable;
18 import org.eclipse.jdt.annotation.NonNull;
19 import org.opendaylight.yangtools.concepts.Immutable;
20 import org.opendaylight.yangtools.concepts.WritableObjects;
22 public abstract class Envelope<T extends Message<?, ?>> implements Immutable, Serializable {
23 interface SerialForm<T extends Message<?, ?>, E extends Envelope<T>> extends Externalizable {
25 @NonNull E envelope();
27 void setEnvelope(@NonNull E envelope);
33 default void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
34 final byte header = WritableObjects.readLongHeader(in);
35 final var sessionId = WritableObjects.readFirstLong(in, header);
36 final var txSequence = WritableObjects.readSecondLong(in, header);
37 @SuppressWarnings("unchecked")
38 final var message = (T) in.readObject();
39 setEnvelope(readExternal(in, sessionId, txSequence, message));
42 E readExternal(ObjectInput in, long sessionId, long txSequence, T message) throws IOException;
45 default void writeExternal(final ObjectOutput out) throws IOException {
46 writeExternal(out, envelope());
49 default void writeExternal(final ObjectOutput out, final @NonNull E envelope) throws IOException {
50 WritableObjects.writeLongs(out, envelope.getSessionId(), envelope.getTxSequence());
51 out.writeObject(envelope.getMessage());
56 private static final long serialVersionUID = 1L;
58 private final @NonNull T message;
59 private final long txSequence;
60 private final long sessionId;
62 Envelope(final T message, final long sessionId, final long txSequence) {
63 this.message = requireNonNull(message);
64 this.sessionId = sessionId;
65 this.txSequence = txSequence;
69 * Get the enclosed message.
71 * @return enclose message
73 public @NonNull T getMessage() {
78 * Get the message transmission sequence of this envelope.
80 * @return Message sequence
82 public long getTxSequence() {
87 * Get the session identifier.
89 * @return Session identifier
91 public long getSessionId() {
96 public String toString() {
97 return MoreObjects.toStringHelper(Envelope.class).add("sessionId", Long.toHexString(sessionId))
98 .add("txSequence", Long.toHexString(txSequence)).add("message", message).toString();
102 final Object writeReplace() {
103 return createProxy();
106 abstract @NonNull SerialForm<T, ?> createProxy();