opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/VersionedExternalizableMessage.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications 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.datastore.messages;
   9
  10 import java.io.Externalizable;
  11 import java.io.IOException;
  12 import java.io.ObjectInput;
  13 import java.io.ObjectOutput;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.opendaylight.controller.cluster.datastore.DataStoreVersions;
  16 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeStreamVersion;
  17
  18 /**
  19  * Abstract base class for a versioned Externalizable message.
  20  *
  21  * @author Thomas Pantelis
  22  */
  23 public abstract class VersionedExternalizableMessage implements Externalizable, SerializableMessage {
  24     private static final long serialVersionUID = 1L;
  25
  26     private short version = DataStoreVersions.CURRENT_VERSION;
  27
  28     public VersionedExternalizableMessage() {
  29
  30     }
  31
  32     public VersionedExternalizableMessage(final short version) {
  33         this.version = version <= DataStoreVersions.CURRENT_VERSION ? version : DataStoreVersions.CURRENT_VERSION;
  34     }
  35
  36     public short getVersion() {
  37         return version;
  38     }
  39
  40     protected final @NonNull NormalizedNodeStreamVersion getStreamVersion() {
  41         if (version >= DataStoreVersions.PHOSPHORUS_VERSION) {
  42             return NormalizedNodeStreamVersion.MAGNESIUM;
  43         } else if (version == DataStoreVersions.SODIUM_SR1_VERSION) {
  44             return NormalizedNodeStreamVersion.SODIUM_SR1;
  45         } else if (version == DataStoreVersions.NEON_SR2_VERSION) {
  46             return NormalizedNodeStreamVersion.NEON_SR2;
  47         } else {
  48             return NormalizedNodeStreamVersion.LITHIUM;
  49         }
  50     }
  51
  52     @Override
  53     public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
  54         version = in.readShort();
  55     }
  56
  57     @Override
  58     public void writeExternal(final ObjectOutput out) throws IOException {
  59         out.writeShort(version);
  60     }
  61
  62     @Override
  63     public final Object toSerializable() {
  64         final short ver = getVersion();
  65         if (ver < DataStoreVersions.BORON_VERSION) {
  66             throw new UnsupportedOperationException("Version " + ver
  67                 + " is older than the oldest version supported version " + DataStoreVersions.BORON_VERSION);
  68         }
  69
  70         return this;
  71     }
  72
  73     @Override
  74     public String toString() {
  75         return getClass().getSimpleName() + " [version=" + getVersion() + "]";
  76     }
  77 }