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