2 * Copyright (c) 2016 Brocade Communications Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.raft.persisted;
10 import akka.dispatch.ControlMessage;
11 import java.io.Externalizable;
12 import java.io.IOException;
13 import java.io.ObjectInput;
14 import java.io.ObjectOutput;
15 import java.io.Serializable;
18 * This is an internal message that is stored in the akka's persistent journal. During recovery, this
19 * message is used to apply recovered journal entries to the state whose indexes range from the context's
20 * current lastApplied index to "toIndex" contained in the message. This message is sent internally from a
21 * behavior to the RaftActor to persist.
23 * @author Thomas Pantelis
25 public class ApplyJournalEntries implements Serializable, MigratedSerializable, ControlMessage {
26 private static final class Proxy implements Externalizable {
27 private static final long serialVersionUID = 1L;
29 private ApplyJournalEntries applyEntries;
31 // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't
32 // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection.
33 @SuppressWarnings("checkstyle:RedundantModifier")
38 Proxy(final ApplyJournalEntries applyEntries) {
39 this.applyEntries = applyEntries;
43 public void writeExternal(final ObjectOutput out) throws IOException {
44 out.writeLong(applyEntries.toIndex);
48 public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
49 applyEntries = new ApplyJournalEntries(in.readLong());
52 private Object readResolve() {
57 private static final long serialVersionUID = 1L;
59 private final long toIndex;
60 private final boolean migrated;
62 private ApplyJournalEntries(final long toIndex, final boolean migrated) {
63 this.toIndex = toIndex;
64 this.migrated = migrated;
67 public ApplyJournalEntries(final long toIndex) {
71 public long getToIndex() {
76 public boolean isMigrated() {
81 public Object writeReplace() {
82 return new Proxy(this);
86 public static ApplyJournalEntries createMigrated(final long fromIndex) {
87 return new ApplyJournalEntries(fromIndex, true);
91 public String toString() {
92 return "ApplyJournalEntries [toIndex=" + toIndex + "]";