opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/ABIVersion.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;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import java.io.DataInput;
  14 import java.io.DataOutput;
  15 import java.io.IOException;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.opendaylight.yangtools.concepts.WritableObject;
  18 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeStreamVersion;
  19 import org.slf4j.Logger;
  20 import org.slf4j.LoggerFactory;
  21
  22 /**
  23  * Enumeration of all ABI versions supported by this implementation of the client access API.
  24  */
  25 public enum ABIVersion implements WritableObject {
  26     // NOTE: enumeration values need to be sorted in ascending order of their version to keep Comparable working
  27
  28     /**
  29      * Version which is older than any other version. This version exists purely for testing purposes.
  30      */
  31     @VisibleForTesting
  32     TEST_PAST_VERSION(0) {
  33         @Override
  34         public NormalizedNodeStreamVersion getStreamVersion() {
  35             throw new UnsupportedOperationException();
  36         }
  37     },
  38
  39     // BORON was 5
  40     // NEON_SR2 was 6
  41     // SODIUM_SR1 was 7
  42     // MAGNESIUM was 8
  43
  44     /**
  45      * Oldest ABI version we support. The messages remain the same as {@code MAGNESIUM}, the serialization proxies in
  46      * use are flat objects without any superclasses.
  47      */
  48     CHLORINE_SR2(9) {
  49         @Override
  50         public NormalizedNodeStreamVersion getStreamVersion() {
  51             return NormalizedNodeStreamVersion.MAGNESIUM;
  52         }
  53     },
  54
  55     /**
  56      * Version which is newer than any other version. This version exists purely for testing purposes.
  57      */
  58     @VisibleForTesting
  59     TEST_FUTURE_VERSION(65535) {
  60         @Override
  61         public NormalizedNodeStreamVersion getStreamVersion() {
  62             throw new UnsupportedOperationException();
  63         }
  64     };
  65
  66     private static final Logger LOG = LoggerFactory.getLogger(ABIVersion.class);
  67
  68     private final short value;
  69
  70     ABIVersion(final int intVersion) {
  71         checkArgument(intVersion >= 0 && intVersion <= 65535);
  72         value = (short) intVersion;
  73     }
  74
  75     /**
  76      * Return the unsigned short integer identifying this version.
  77      *
  78      * @return Unsigned short integer identifying this version
  79      */
  80     public short shortValue() {
  81         return value;
  82     }
  83
  84     /**
  85      * Return the codebase-native ABI version. This version is the default version allocated to messages at runtime.
  86      * Conversion to previous versions may incur additional overhead (such as object allocation).
  87      *
  88      * @return Current {@link ABIVersion}
  89      */
  90     public static @NonNull ABIVersion current() {
  91         return CHLORINE_SR2;
  92     }
  93
  94     /**
  95      * Return the {@link ABIVersion} corresponding to an unsigned short integer. This method is provided for callers
  96      * which provide their own recovery strategy in case of version incompatibility.
  97      *
  98      * @param value Short integer as returned from {@link #shortValue()}
  99      * @return {@link ABIVersion}
 100      * @throws FutureVersionException if the specified integer identifies a future version
 101      * @throws PastVersionException if the specified integer identifies a past version which is no longer supported
 102      */
 103     public static @NonNull ABIVersion valueOf(final short value) throws FutureVersionException, PastVersionException {
 104         return switch (Short.toUnsignedInt(value)) {
 105             case 0, 1, 2, 3, 4, 6, 7, 8 -> throw new PastVersionException(value, CHLORINE_SR2);
 106             case 9 -> CHLORINE_SR2;
 107             default -> throw new FutureVersionException(value, CHLORINE_SR2);
 108         };
 109     }
 110
 111     /**
 112      * Return {@code true} if this version is earier than some {@code other} version.
 113      *
 114      * @param other Other {@link ABIVersion}
 115      * @return {@code true} if {@code other is later}
 116      * @throws NullPointerException if {@code other} is null
 117      */
 118     public boolean lt(final @NonNull ABIVersion other) {
 119         return compareTo(other) < 0;
 120     }
 121
 122     @Override
 123     public void writeTo(final DataOutput out) throws IOException {
 124         out.writeShort(value);
 125     }
 126
 127     /**
 128      * Return the NormalizedNode stream version corresponding to this particular ABI.
 129      *
 130      * @return Stream Version to use for this ABI version
 131      */
 132     public abstract @NonNull NormalizedNodeStreamVersion getStreamVersion();
 133
 134     /**
 135      * Read an {@link ABIVersion} from a {@link DataInput}. This method is provided for callers which do not have
 136      * a recovery strategy for dealing with unsupported versions.
 137      *
 138      * @param in Input from which to read
 139      * @return An {@link ABIVersion}
 140      * @throws IOException If read fails or an unsupported version is encountered
 141      */
 142     public static @NonNull ABIVersion readFrom(final @NonNull DataInput in) throws IOException {
 143         final short s = in.readShort();
 144         try {
 145             return valueOf(s);
 146         } catch (FutureVersionException | PastVersionException e) {
 147             throw new IOException("Unsupported version", e);
 148         }
 149     }
 150
 151     public static @NonNull ABIVersion inexactReadFrom(final @NonNull DataInput in) throws IOException {
 152         final short onWire = in.readShort();
 153         try {
 154             return ABIVersion.valueOf(onWire);
 155         } catch (FutureVersionException e) {
 156             LOG.debug("Received future version", e);
 157             return ABIVersion.TEST_FUTURE_VERSION;
 158         } catch (PastVersionException e) {
 159             LOG.debug("Received past version", e);
 160             return ABIVersion.TEST_PAST_VERSION;
 161         }
 162     }
 163 }