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 org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
13 * Interface for a class that participates in raft actor persistence recovery.
15 * @author Thomas Pantelis
17 public interface RaftActorRecoveryCohort {
20 * This method is called during recovery at the start of a batch of state entries. Derived
21 * classes should perform any initialization needed to start a batch.
23 void startLogRecoveryBatch(int maxBatchSize);
26 * This method is called during recovery to append state data to the current batch. This method
27 * is called 1 or more times after {@link #startLogRecoveryBatch}.
29 * @param data the state data
31 void appendRecoveredLogEntry(Payload data);
34 * This method is called during recovery to reconstruct the state of the actor.
36 * @param snapshotBytes A snapshot of the state of the actor
38 void applyRecoverySnapshot(byte[] snapshotBytes);
41 * This method is called during recovery at the end of a batch to apply the current batched
42 * log entries. This method is called after {@link #appendRecoveredLogEntry}.
44 void applyCurrentLogRecoveryBatch();