opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/concepts/Message.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.cluster.access.concepts;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.VisibleForTesting;
  14 import com.google.common.base.MoreObjects;
  15 import com.google.common.base.MoreObjects.ToStringHelper;
  16 import java.io.Serial;
  17 import java.io.Serializable;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.opendaylight.controller.cluster.access.ABIVersion;
  20 import org.opendaylight.yangtools.concepts.Immutable;
  21 import org.opendaylight.yangtools.concepts.WritableIdentifier;
  22
  23 /**
  24  * An abstract concept of a Message. This class cannot be instantiated directly, use its specializations {@link Request}
  25  * and {@link Response}.
  26  *
  27  * <p>
  28  * Messages have a target and a sequence number. Sequence numbers are expected to be assigned monotonically on a
  29  * per-target basis, hence two targets can observe the same sequence number.
  30  *
  31  * <p>
  32  * This class includes explicit versioning for forward- and backward- compatibility of serialization format. This is
  33  * achieved by using the serialization proxy pattern. Subclasses are in complete control of what proxy is used to
  34  * serialize a particular object on the wire. This class can serve as an explicit version marker, hence no further
  35  * action is necessary in the deserialization path.
  36  *
  37  * <p>
  38  * For the serialization path an explicit call from the user is required to select the appropriate serialization
  39  * version. This is done via {@link #toVersion(ABIVersion)} method, which should return a copy of this object with
  40  * the requested ABI version recorded and should return the appropriate serialization proxy.
  41  *
  42  * <p>
  43  * This workflow allows least disturbance across ABI versions, as all messages not affected by a ABI version bump
  44  * will remain working with the same serialization format for the new ABI version.
  45  *
  46  * <p>
  47  * Note that this class specifies the {@link Immutable} contract, which means that all subclasses must follow this API
  48  * contract.
  49  *
  50  * @param <T> Target identifier type
  51  * @param <C> Message type
  52  */
  53 public abstract class Message<T extends WritableIdentifier, C extends Message<T, C>> implements Immutable,
  54         Serializable {
  55     @Serial
  56     private static final long serialVersionUID = 1L;
  57
  58     private final @NonNull ABIVersion version;
  59     private final long sequence;
  60     private final @NonNull T target;
  61
  62     private Message(final ABIVersion version, final T target, final long sequence) {
  63         this.target = requireNonNull(target);
  64         this.version = requireNonNull(version);
  65         this.sequence = sequence;
  66     }
  67
  68     Message(final T target, final long sequence) {
  69         this(ABIVersion.current(), target, sequence);
  70     }
  71
  72     Message(final C msg, final ABIVersion version) {
  73         this(version, msg.getTarget(), msg.getSequence());
  74     }
  75
  76     /**
  77      * Get the target identifier for this message.
  78      *
  79      * @return Target identifier
  80      */
  81     public final @NonNull T getTarget() {
  82         return target;
  83     }
  84
  85     /**
  86      * Get the logical sequence number.
  87      *
  88      * @return logical sequence number
  89      */
  90     public final long getSequence() {
  91         return sequence;
  92     }
  93
  94     @VisibleForTesting
  95     public final @NonNull ABIVersion getVersion() {
  96         return version;
  97     }
  98
  99     /**
 100      * Return a message which will end up being serialized in the specified {@link ABIVersion}.
 101      *
 102      * @param toVersion Request {@link ABIVersion}
 103      * @return A new message which will use ABIVersion as its serialization.
 104      */
 105     @SuppressWarnings("unchecked")
 106     public final @NonNull C toVersion(final @NonNull ABIVersion toVersion) {
 107         if (this.version == toVersion) {
 108             return (C)this;
 109         }
 110
 111         return switch (toVersion) {
 112             case BORON, NEON_SR2, SODIUM_SR1, MAGNESIUM -> verifyNotNull(cloneAsVersion(toVersion));
 113             default -> throw new IllegalArgumentException("Unhandled ABI version " + toVersion);
 114         };
 115     }
 116
 117     /**
 118      * Create a copy of this message which will serialize to a stream corresponding to the specified method. This
 119      * method should be implemented by the concrete final message class and should invoke the equivalent of
 120      * {@link #Message(Message, ABIVersion)}.
 121      *
 122      * @param targetVersion target ABI version
 123      * @return A message with the specified serialization stream
 124      * @throws IllegalArgumentException if this message does not support the target ABI
 125      */
 126     protected abstract @NonNull C cloneAsVersion(@NonNull ABIVersion targetVersion);
 127
 128     @Override
 129     public final String toString() {
 130         return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
 131     }
 132
 133     /**
 134      * Add attributes to the output of {@link #toString()}. Subclasses wanting to contribute additional information
 135      * should override this method. Any null attributes will be omitted from the output.
 136      *
 137      * @param toStringHelper a {@link ToStringHelper} instance
 138      * @return The {@link ToStringHelper} passed in as argument
 139      * @throws NullPointerException if toStringHelper is null
 140      */
 141     protected @NonNull ToStringHelper addToStringAttributes(final @NonNull ToStringHelper toStringHelper) {
 142         return toStringHelper.add("target", target).add("sequence", Long.toUnsignedString(sequence));
 143     }
 144
 145     /**
 146      * Instantiate a serialization proxy for this object for the target ABI version. Implementations should return
 147      * different objects for incompatible {@link ABIVersion}s. This method should never fail, as any compatibility
 148      * checks should have been done by {@link #cloneAsVersion(ABIVersion)}.
 149      *
 150      * @param reqVersion Requested ABI version
 151      * @return Proxy for this object
 152      */
 153     abstract @NonNull AbstractMessageProxy<T, C> externalizableProxy(@NonNull ABIVersion reqVersion);
 154
 155     @Serial
 156     protected final Object writeReplace() {
 157         return externalizableProxy(version);
 158     }
 159 }