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

Class RaftStorage

java.lang.Object

org.opendaylight.controller.cluster.raft.spi.RaftStorage

All Implemented Interfaces:

EntryStore, SnapshotStore

Direct Known Subclasses:

DisabledRaftStorage, EnabledRaftStorage

public abstract sealed class RaftStorage
extends Object
implements EntryStore, SnapshotStore
permits DisabledRaftStorage, EnabledRaftStorage

Internal interface towards storage entities.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	RaftStorage.CancellableTask<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NonNull RaftStorageCompleter	completer
protected final @NonNull CompressionType	compression
protected final @NonNull Path	directory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RaftStorage(RaftStorageCompleter completer, Path directory, CompressionType compression, FileBackedOutputStream.Configuration streamConfig)

Method Summary

Modifier and Type	Method	Description
protected MoreObjects.ToStringHelper	addToStringAtrributes(MoreObjects.ToStringHelper helper)
final @NonNull RaftStorageCompleter	completer()	Returns the RaftStorageCompleter.
final @Nullable SnapshotFile	lastSnapshot()	Returns the last available snapshot.
protected final String	memberId()
protected abstract void	postStart()
protected abstract void	preStop()
static final void	saveSnapshot(String memberId, Path directory, SnapshotFileFormat format, CompressionType compression, RaftSnapshot raftSnapshot, EntryInfo lastIncluded, @Nullable StateSnapshot.ToStorage<?> snapshot, Instant timestamp)
void	saveSnapshot(RaftSnapshot raftSnapshot, EntryInfo lastIncluded, @Nullable StateSnapshot.ToStorage<?> snapshot, Instant timestamp)	Saves a snapshot synchronously and delete any previous snapshots.
final void	saveSnapshot(RaftSnapshot raftSnapshot, EntryInfo lastIncluded, @Nullable StateSnapshot.ToStorage<?> snapshot, RaftCallback<Instant> callback)	Saves a snapshot asynchronously and delete any previous snapshots.
final void	start()
final void	stop()
final void	streamToInstall(EntryInfo lastIncluded, StateSnapshot.ToStorage<?> snapshot, RaftCallback<InstallableSnapshot> callback)	Serialize a StateSnapshot.ToStorage snapshot and make the result available as an InstallableSnapshot to the specified callback.
protected final void	submitTask(@NonNull RaftStorage.CancellableTask<?> task)
final String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opendaylight.controller.cluster.raft.spi.EntryStore

checkpointLastApplied, discardHead, discardTail, persistEntry, startPersistEntry

Field Details

completer

protected final @NonNull RaftStorageCompleter completer

compression

protected final @NonNull CompressionType compression

directory

protected final @NonNull Path directory

Constructor Details

RaftStorage

protected RaftStorage(RaftStorageCompleter completer,
 Path directory,
 CompressionType compression,
 FileBackedOutputStream.Configuration streamConfig)

Method Details

memberId

protected final String memberId()

start

public final void start()
                 throws IOException

Throws:

IOException

postStart

protected abstract void postStart()
                           throws IOException

Throws:

IOException

stop

public final void stop()

preStop

protected abstract void preStop()

completer

public final @NonNull RaftStorageCompleter completer()

Description copied from interface: EntryStore

Returns the RaftStorageCompleter.

Specified by:

completer in interface EntryStore

Returns:

the RaftStorageCompleter

lastSnapshot

public final @Nullable SnapshotFile lastSnapshot()
                                          throws IOException

Description copied from interface: SnapshotStore

Returns the last available snapshot.

Specified by:

lastSnapshot in interface SnapshotStore

Returns:

the last available snapshot

Throws:

IOException - if an I/O error occurs

streamToInstall

@NonNullByDefault
public final void streamToInstall(EntryInfo lastIncluded,
 StateSnapshot.ToStorage<?> snapshot,
 RaftCallback<InstallableSnapshot> callback)

Description copied from interface: SnapshotStore

Serialize a StateSnapshot.ToStorage snapshot and make the result available as an InstallableSnapshot to the specified callback.

Specified by:

streamToInstall in interface SnapshotStore

Parameters:

lastIncluded - last included index/term

snapshot - the snapshot

callback - the callback to invoke

saveSnapshot

public final void saveSnapshot(RaftSnapshot raftSnapshot,
 EntryInfo lastIncluded,
 @Nullable StateSnapshot.ToStorage<?> snapshot,
 RaftCallback<Instant> callback)

Description copied from interface: SnapshotStore

Saves a snapshot asynchronously and delete any previous snapshots.

Specified by:

saveSnapshot in interface SnapshotStore

Parameters:

raftSnapshot - the RaftSnapshot, receiving the snapshot timestamp

lastIncluded - last included index/term

snapshot - the snapshot, or null if not applicable

callback - the callback to invoke

saveSnapshot

public void saveSnapshot(RaftSnapshot raftSnapshot,
 EntryInfo lastIncluded,
 @Nullable StateSnapshot.ToStorage<?> snapshot,
 Instant timestamp)
                  throws IOException

Description copied from interface: SnapshotStore

Saves a snapshot synchronously and delete any previous snapshots. This method should only be called during recovery.

Specified by:

saveSnapshot in interface SnapshotStore

Parameters:

raftSnapshot - the RaftSnapshot

lastIncluded - last included index/term

snapshot - the snapshot, or null if not applicable

timestamp - snapshot timestamp

Throws:

IOException - when an I/O error occurs

saveSnapshot

@NonNullByDefault
public static final void saveSnapshot(String memberId,
 Path directory,
 SnapshotFileFormat format,
 CompressionType compression,
 RaftSnapshot raftSnapshot,
 EntryInfo lastIncluded,
 @Nullable StateSnapshot.ToStorage<?> snapshot,
 Instant timestamp)
                               throws IOException

Throws:

IOException

submitTask

protected final void submitTask(@NonNull RaftStorage.CancellableTask<?> task)

toString

public final String toString()

Overrides:

toString in class Object

addToStringAtrributes

protected MoreObjects.ToStringHelper addToStringAtrributes(MoreObjects.ToStringHelper helper)