io.zeebe.logstreams.spi

Interface ReadableSnapshot

All Superinterfaces:

SnapshotMetadata

All Known Implementing Classes:

FsReadableSnapshot

public interface ReadableSnapshot
extends SnapshotMetadata

Represents a snapshot of the log.

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the snapshot and related data.
InputStream	getData() Input stream to read the snapshot data.
default void	recoverFromSnapshot(SnapshotSupport snapshotSupport) Reads the snapshot data and recover the given snapshot object.
void	validateAndClose() Consumers of this API must call this method after having read the input stream.

Methods inherited from interface io.zeebe.logstreams.spi.SnapshotMetadata

getChecksum, getName, getPosition, getSize, isReplicable

Method Detail

getData

InputStream getData()

Input stream to read the snapshot data.

Returns:

the snapshot data as input stream

validateAndClose

void validateAndClose()
               throws InvalidSnapshotException

Consumers of this API must call this method after having read the input stream. The method validates that the bytes read are valid and closes any underlying resources.

Throws:

InvalidSnapshotException - if not valid

delete

void delete()

Deletes the snapshot and related data.

recoverFromSnapshot

default void recoverFromSnapshot(SnapshotSupport snapshotSupport)
                          throws Exception

Reads the snapshot data and recover the given snapshot object. At the end, it validates that the bytes read are valid and closes any underlying resources.

Parameters:

snapshotSupport - the snapshot object

Throws:

Exception - if fails to recover the snapshot object

InvalidSnapshotException - if the snapshot is not valid