2 * Copyright (c) 2015 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;
10 import javax.annotation.Nullable;
11 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
14 * Interface for a class that participates in raft actor persistence recovery.
16 * @author Thomas Pantelis
18 public interface RaftActorRecoveryCohort {
21 * This method is called during recovery at the start of a batch of state entries. Derived
22 * classes should perform any initialization needed to start a batch.
24 * @param maxBatchSize the maximum batch size.
26 void startLogRecoveryBatch(int maxBatchSize);
29 * This method is called during recovery to append state data to the current batch. This method
30 * is called 1 or more times after {@link #startLogRecoveryBatch}.
32 * @param data the state data
34 void appendRecoveredLogEntry(Payload data);
37 * This method is called during recovery to reconstruct the state of the actor.
39 * @param snapshotBytes A snapshot of the state of the actor
41 void applyRecoverySnapshot(byte[] snapshotBytes);
44 * This method is called during recovery at the end of a batch to apply the current batched
45 * log entries. This method is called after {@link #appendRecoveredLogEntry}.
47 void applyCurrentLogRecoveryBatch();
50 * Returns the state snapshot to restore from on recovery.
52 * @return the snapshot bytes or null if there's no snapshot to restore
55 byte[] getRestoreFromSnapshot();