io.zeebe.logstreams.spi

Interface SnapshotWriter

All Known Implementing Classes:

FsSnapshotWriter, FsTemporarySnapshotWriter

public interface SnapshotWriter

Writer to create a snapshot.

Method Summary

Modifier and Type	Method and Description
void	abort() Refuse the snapshot by closing the output stream and deleting the snapshot data.
void	commit() Completes the snapshot by closing the output stream and writing the checksum.
OutputStream	getOutputStream() Returns the output stream of the snapshot which should be used to write the snapshot data.
void	validateAndCommit(byte[] checksum) Completes the snapshot by closing the output stream and writing its checksum, iff the checksum is equal to the given checksum.
default long	writeSnapshot(SnapshotSupport snapshotSupport) Writes the given snapshot to the output stream.

Method Detail

getOutputStream

OutputStream getOutputStream()

Returns the output stream of the snapshot which should be used to write the snapshot data. Finish the write operation with commit() or abort().

Returns:

the snapshot output stream

commit

void commit()
     throws Exception

Completes the snapshot by closing the output stream and writing the checksum.

Throws:

Exception - if fails to write the checksum

abort

void abort()

Refuse the snapshot by closing the output stream and deleting the snapshot data.

writeSnapshot

default long writeSnapshot(SnapshotSupport snapshotSupport)
                    throws Exception

Writes the given snapshot to the output stream.

Parameters:

snapshotSupport - the snapshot object

Returns:

Throws:

Exception - if fails to write the snapshot

validateAndCommit

void validateAndCommit(byte[] checksum)
                throws Exception

Completes the snapshot by closing the output stream and writing its checksum, iff the checksum is equal to the given checksum.

It will call abort on exception, or if the checksums do not match.

Parameters:

checksum - checksum to check against

Throws:

Exception