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

Interface SnapshotFile

All Superinterfaces:

InstallableSnapshot

@NonNullByDefault
public interface SnapshotFile
extends InstallableSnapshot

Access to the contents of a RAFT snapshot file.

Method Summary

Modifier and Type	Method	Description
Path	path()	Returns this file's Path.
RaftSnapshot	readRaftSnapshot(RestrictedObjectStreams objectStreams)	Returns the RaftSnapshot stored in this file.
default <T extends StateSnapshot> @Nullable T	readSnapshot(StateSnapshot.Reader<? extends T> reader)
Instant	timestamp()	Returns the instant this file was written.

Methods inherited from interface org.opendaylight.raft.spi.InstallableSnapshot

lastIncluded, source

Method Details

timestamp

Instant timestamp()

Returns the instant this file was written.

Returns:

the instant this file was written

path

Path path()

Returns this file's Path.

Returns:

this file's Path

readRaftSnapshot

@Beta
RaftSnapshot readRaftSnapshot(RestrictedObjectStreams objectStreams)
                       throws IOException

Returns the RaftSnapshot stored in this file.

Parameters:

objectStreams - the RestrictedObjectStreams context

Returns:

the RaftSnapshot

Throws:

IOException - if an I/O error occurs

readSnapshot

default <T extends StateSnapshot> @Nullable T readSnapshot(StateSnapshot.Reader<? extends T> reader)
                                                    throws IOException

Throws:

IOException