opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/persisted/ApplyJournalEntries.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.raft.persisted;
   9
  10 import java.io.Externalizable;
  11 import java.io.IOException;
  12 import java.io.ObjectInput;
  13 import java.io.ObjectOutput;
  14 import java.io.Serializable;
  15
  16 /**
  17  * This is an internal message that is stored in the akka's persistent journal. During recovery, this
  18  * message is used to apply recovered journal entries to the state whose indexes range from the context's
  19  * current lastApplied index to "toIndex" contained in the message. This message is sent internally from a
  20  * behavior to the RaftActor to persist.
  21  *
  22  * @author Thomas Pantelis
  23  */
  24 public class ApplyJournalEntries implements Serializable, MigratedSerializable {
  25     private static final class Proxy implements Externalizable {
  26         private static final long serialVersionUID = 1L;
  27
  28         private ApplyJournalEntries applyEntries;
  29
  30         public Proxy() {
  31             // For Externalizable
  32         }
  33
  34         Proxy(final ApplyJournalEntries applyEntries) {
  35             this.applyEntries = applyEntries;
  36         }
  37
  38         @Override
  39         public void writeExternal(final ObjectOutput out) throws IOException {
  40             out.writeLong(applyEntries.toIndex);
  41          }
  42
  43         @Override
  44         public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
  45             applyEntries = new ApplyJournalEntries(in.readLong());
  46         }
  47
  48         private Object readResolve() {
  49             return applyEntries;
  50         }
  51     }
  52
  53     private static final long serialVersionUID = 1L;
  54
  55     private final long toIndex;
  56     private final boolean migrated;
  57
  58     private ApplyJournalEntries(final long toIndex, final boolean migrated) {
  59         this.toIndex = toIndex;
  60         this.migrated = migrated;
  61     }
  62
  63     public ApplyJournalEntries(final long toIndex) {
  64         this(toIndex, false);
  65     }
  66
  67     public long getToIndex() {
  68         return toIndex;
  69     }
  70
  71     @Override
  72     public boolean isMigrated() {
  73         return migrated;
  74     }
  75
  76     @Override
  77     public Object writeReplace() {
  78         return new Proxy(this);
  79     }
  80
  81     @Deprecated
  82     public static ApplyJournalEntries createMigrated(final long fromIndex) {
  83         return new ApplyJournalEntries(fromIndex, true);
  84     }
  85
  86     @Override
  87     public String toString() {
  88         return "ApplyJournalEntries [toIndex=" + toIndex + "]";
  89     }
  90 }