opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorRecoveryCohort.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.raft;
   9
  10 import org.eclipse.jdt.annotation.Nullable;
  11 import org.opendaylight.controller.cluster.raft.messages.Payload;
  12 import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
  13
  14 /**
  15  * Interface for a class that participates in raft actor persistence recovery.
  16  *
  17  * @author Thomas Pantelis
  18  */
  19 public interface RaftActorRecoveryCohort {
  20
  21     /**
  22      * This method is called during recovery at the start of a batch of state entries. Derived
  23      * classes should perform any initialization needed to start a batch.
  24      *
  25      * @param maxBatchSize the maximum batch size.
  26      */
  27     void startLogRecoveryBatch(int maxBatchSize);
  28
  29     /**
  30      * This method is called during recovery to append state data to the current batch. This method
  31      * is called 1 or more times after {@link #startLogRecoveryBatch}.
  32      *
  33      * @param data the state data
  34      */
  35     void appendRecoveredLogEntry(Payload data);
  36
  37     /**
  38      * This method is called during recovery to reconstruct the state of the actor.
  39      *
  40      * @param snapshotState A snapshot of the state of the actor
  41      */
  42     void applyRecoverySnapshot(Snapshot.State snapshotState);
  43
  44     /**
  45      * This method is called during recovery at the end of a batch to apply the current batched
  46      * log entries. This method is called after {@link #appendRecoveredLogEntry}.
  47      */
  48     void applyCurrentLogRecoveryBatch();
  49
  50     /**
  51      * Returns the snapshot to restore from on recovery.
  52      *
  53      * @return the snapshot or null if there's no snapshot to restore
  54      */
  55     @Nullable Snapshot getRestoreFromSnapshot();
  56 }