Package org.opendaylight.controller.cluster.raft.spi

Interface StateSnapshot

All Superinterfaces:

Immutable

All Known Subinterfaces:

Snapshot.State

All Known Implementing Classes:

EmptyState, ShardSnapshotState

@NonNullByDefault
public interface StateSnapshot
extends Immutable

Marker interface for objects representing a snapshot of RAFT-replicated user state. A StateSnapshot represents a logical sum of all StateCommands applied to the journal at a particular point in time.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	StateSnapshot.Reader<T extends StateSnapshot>
static interface	StateSnapshot.Support<T extends StateSnapshot>	A combination of a StateSnapshot.Reader and a StateSnapshot.Writer for a concrete StateSnapshot type, as indicated by StateSnapshot.Support.snapshotType().
static final class	StateSnapshot.ToStorage<T extends StateSnapshot>	A StateSnapshot on its way to storage.
static interface	StateSnapshot.Writer<T extends StateSnapshot>

Method Summary

Modifier and Type	Method	Description
default boolean	needsMigration()	Indicate whether the snapshot requires migration, i.e. a new snapshot should be created after recovery.

Method Details

needsMigration

default boolean needsMigration()

Indicate whether the snapshot requires migration, i.e. a new snapshot should be created after recovery. Default implementation returns false, i.e. do not re-snapshot.

Returns:

true if complete recovery based upon this snapshot should trigger a new snapshot.