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

   1 /*
   2  * Copyright (c) 2016 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 com.google.common.base.Preconditions;
  11 import java.io.IOException;
  12 import java.io.ObjectInput;
  13 import java.io.ObjectOutput;
  14 import org.opendaylight.controller.cluster.datastore.DataStoreVersions;
  15
  16 /**
  17  * Base class for a 3PC message.
  18  *
  19  * @author Thomas Pantelis
  20  */
  21 public abstract class AbstractThreePhaseCommitMessage extends VersionedExternalizableMessage {
  22     private static final long serialVersionUID = 1L;
  23
  24     private String transactionID;
  25
  26     protected AbstractThreePhaseCommitMessage() {
  27     }
  28
  29     protected AbstractThreePhaseCommitMessage(final String transactionID, final short version) {
  30         super(version);
  31         this.transactionID = Preconditions.checkNotNull(transactionID);
  32     }
  33
  34     protected abstract Object newLegacySerializedInstance();
  35
  36     public String getTransactionID() {
  37         return transactionID;
  38     }
  39
  40     @Override
  41     public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
  42         super.readExternal(in);
  43         transactionID = in.readUTF();
  44     }
  45
  46     @Override
  47     public void writeExternal(ObjectOutput out) throws IOException {
  48         super.writeExternal(out);
  49         out.writeUTF(transactionID);
  50     }
  51
  52     @Override
  53     public Object toSerializable() {
  54         return getVersion() >= DataStoreVersions.BORON_VERSION ? this : newLegacySerializedInstance();
  55     }
  56
  57     @Override
  58     public String toString() {
  59         return getClass().getSimpleName() + " [transactionID=" + transactionID + ", version=" + getVersion()
  60                 + "]";
  61     }
  62 }