Fix warnings and javadocs in sal-akka-raft

[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / RaftActorRecoveryCohort.java

diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorRecoveryCohort.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorRecoveryCohort.java
index a9f00aa80bcb93621d6f1ef3fadb4695dbe3b8c5..c3760472ac2a11614b1bbb55ad64578deb21dc8f 100644 (file)
--- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorRecoveryCohort.java
+++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorRecoveryCohort.java
@@ -7,6 +7,7 @@
  */
 package org.opendaylight.controller.cluster.raft;
 
+import javax.annotation.Nullable;
 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
 
 /**
@@ -19,6 +20,8 @@ public interface RaftActorRecoveryCohort {
     /**
      * This method is called during recovery at the start of a batch of state entries. Derived
      * classes should perform any initialization needed to start a batch.
+     *
+     * @param maxBatchSize the maximum batch size.
      */
     void startLogRecoveryBatch(int maxBatchSize);
 
@@ -42,4 +45,12 @@ public interface RaftActorRecoveryCohort {
      * log entries. This method is called after {@link #appendRecoveredLogEntry}.
      */
     void applyCurrentLogRecoveryBatch();
+
+    /**
+     * Returns the state snapshot to restore from on recovery.
+     *
+     * @return the snapshot bytes or null if there's no snapshot to restore
+     */
+    @Nullable
+    byte[] getRestoreFromSnapshot();
 }