io.zeebe.logstreams.impl.snapshot.fs

Class FsSnapshotStorage

java.lang.Object

io.zeebe.logstreams.impl.snapshot.fs.FsSnapshotStorage

All Implemented Interfaces:

SnapshotStorage

public class FsSnapshotStorage
extends Object
implements SnapshotStorage

Field Summary

Fields

Modifier and Type	Field and Description
protected FsSnapshotStorageConfiguration	cfg
static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
FsSnapshotStorage(FsSnapshotStorageConfiguration cfg)

Method Summary

Modifier and Type	Method and Description
FsSnapshotWriter	createSnapshot(String name, long logPosition) Returns a writer to create a new snapshot.
FsTemporarySnapshotWriter	createTemporarySnapshot(String name, long logPosition) Returns a writer to create a temporary snapshot.
FsReadableSnapshot	getLastSnapshot(String name) Returns the last snapshot for the given name.
List<SnapshotMetadata>	listSnapshots() Returns a list of available snapshots; for each snapshot item, it returns the latest file.
protected long	position(File file, String snapshotName)
boolean	purgeSnapshot(String name) Deletes all existing snapshot and checksum files.
boolean	snapshotExists(String name, long logPosition) Returns whether or not there already exists a snapshot for the given name + position.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

cfg

protected final FsSnapshotStorageConfiguration cfg

Constructor Detail

FsSnapshotStorage

public FsSnapshotStorage(FsSnapshotStorageConfiguration cfg)

Method Detail

getLastSnapshot

public FsReadableSnapshot getLastSnapshot(String name)

Description copied from interface: SnapshotStorage

Returns the last snapshot for the given name.

Specified by:

getLastSnapshot in interface SnapshotStorage

Parameters:

name - the name of the snapshot

Returns:

the snapshot or null if none exists

purgeSnapshot

public boolean purgeSnapshot(String name)

Description copied from interface: SnapshotStorage

Deletes all existing snapshot and checksum files.

Specified by:

purgeSnapshot in interface SnapshotStorage

Parameters:

name - the name of the snapshot

Returns:

true if the purging was successful otherwise false

createSnapshot

public FsSnapshotWriter createSnapshot(String name,
                                       long logPosition)
                                throws Exception

Description copied from interface: SnapshotStorage

Returns a writer to create a new snapshot.

Specified by:

createSnapshot in interface SnapshotStorage

Parameters:

name - the name of the snapshot

logPosition - the log position at which the snapshot is taken

Returns:

the writer to create the snapshot

Throws:

Exception - if fails to create the snapshot

listSnapshots

public List<SnapshotMetadata> listSnapshots()

Description copied from interface: SnapshotStorage

Returns a list of available snapshots; for each snapshot item, it returns the latest file.

Specified by:

listSnapshots in interface SnapshotStorage

Returns:

all available snapshots

createTemporarySnapshot

public FsTemporarySnapshotWriter createTemporarySnapshot(String name,
                                                         long logPosition)
                                                  throws Exception

Description copied from interface: SnapshotStorage

Returns a writer to create a temporary snapshot.

Specified by:

createTemporarySnapshot in interface SnapshotStorage

Parameters:

name - the snapshot name

logPosition - the logPosition

Returns:

pre-configured SnapshotWriter

Throws:

Exception - if it fails to prepare the necessary resources for the temporary snapshot

snapshotExists

public boolean snapshotExists(String name,
                              long logPosition)

Description copied from interface: SnapshotStorage

Returns whether or not there already exists a snapshot for the given name + position.

Specified by:

snapshotExists in interface SnapshotStorage

position

protected long position(File file,
                        String snapshotName)