Package io.camunda.zeebe.snapshots.impl

Class FileBasedSnapshotStoreImpl

java.lang.Object

io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStoreImpl

public final class FileBasedSnapshotStoreImpl
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHECKSUM_SUFFIX
static final String	METADATA_FILE_NAME
static final String	SNAPSHOTS_BOOTSTRAP_DIRECTORY
static final String	SNAPSHOTS_DIRECTORY
static final int	VERSION

Constructor Summary

Constructors

Constructor	Description
FileBasedSnapshotStoreImpl(int brokerId, Path root, CRC32CChecksumProvider checksumProvider, ConcurrencyControl actor, SnapshotMetrics metrics)

Method Summary

Modifier and Type	Method	Description
ActorFuture<Void>	abortPendingSnapshots()
ActorFuture<Boolean>	addSnapshotListener(PersistedSnapshotListener listener)
void	close()
ActorFuture<PersistedSnapshot>	copyForBootstrap(PersistedSnapshot persistedSnapshot, BiConsumer<Path,Path> copySnapshot)	Take a copy of the given persisted snapshot and move it to the bootstrap snapshots directory, applying the function to the files.
ActorFuture<Void>	delete()
ActorFuture<Set<PersistedSnapshot>>	getAvailableSnapshots()
Optional<PersistedSnapshot>	getBootstrapSnapshot()
ActorFuture<Long>	getCompactionBound()
long	getCurrentSnapshotIndex()
Optional<PersistedSnapshot>	getLatestSnapshot()
Path	getPath()
boolean	hasSnapshotId(String id)
ActorFuture<FileBasedReceivedSnapshot>	newReceivedSnapshot(String snapshotId)
Either<SnapshotException,TransientSnapshot>	newTransientSnapshot(long index, long term, long processedPosition, long exportedPosition, boolean forceSnapshot)
ActorFuture<Boolean>	removeSnapshotListener(PersistedSnapshotListener listener)
ActorFuture<Void>	restore(PersistedSnapshot snapshot)
void	restore(String snapshotId, Map<String,Path> snapshotFiles)
void	start()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

VERSION

public static final int VERSION

See Also:

• Constant Field Values

SNAPSHOTS_DIRECTORY

public static final String SNAPSHOTS_DIRECTORY

See Also:

• Constant Field Values

METADATA_FILE_NAME

public static final String METADATA_FILE_NAME

See Also:

• Constant Field Values

SNAPSHOTS_BOOTSTRAP_DIRECTORY

public static final String SNAPSHOTS_BOOTSTRAP_DIRECTORY

See Also:

• Constant Field Values

CHECKSUM_SUFFIX

public static final String CHECKSUM_SUFFIX

See Also:

• Constant Field Values

Constructor Details

FileBasedSnapshotStoreImpl

public FileBasedSnapshotStoreImpl(int brokerId,
 Path root,
 CRC32CChecksumProvider checksumProvider,
 ConcurrencyControl actor,
 SnapshotMetrics metrics)

Method Details

start

public void start()

close

public void close()

hasSnapshotId

public boolean hasSnapshotId(String id)

getLatestSnapshot

public Optional<PersistedSnapshot> getLatestSnapshot()

getAvailableSnapshots

public ActorFuture<Set<PersistedSnapshot>> getAvailableSnapshots()

getCompactionBound

public ActorFuture<Long> getCompactionBound()

abortPendingSnapshots

public ActorFuture<Void> abortPendingSnapshots()

addSnapshotListener

public ActorFuture<Boolean> addSnapshotListener(PersistedSnapshotListener listener)

removeSnapshotListener

public ActorFuture<Boolean> removeSnapshotListener(PersistedSnapshotListener listener)

getCurrentSnapshotIndex

public long getCurrentSnapshotIndex()

delete

public ActorFuture<Void> delete()

getPath

public Path getPath()

newReceivedSnapshot

public ActorFuture<FileBasedReceivedSnapshot> newReceivedSnapshot(String snapshotId)

newTransientSnapshot

public Either<SnapshotException,TransientSnapshot> newTransientSnapshot(long index,
 long term,
 long processedPosition,
 long exportedPosition,
 boolean forceSnapshot)

toString

public String toString()

Overrides:

toString in class Object

restore

public void restore(String snapshotId,
 Map<String,Path> snapshotFiles)
             throws IOException

Throws:

IOException

restore

public ActorFuture<Void> restore(PersistedSnapshot snapshot)

copyForBootstrap

public ActorFuture<PersistedSnapshot> copyForBootstrap(PersistedSnapshot persistedSnapshot,
 BiConsumer<Path,Path> copySnapshot)

Take a copy of the given persisted snapshot and move it to the bootstrap snapshots directory, applying the function to the files. Only one snapshot for bootstrap can be taken at a time. It will be located into the "bootstrap-snapshots" folder.

Parameters:

persistedSnapshot - to copy from

copySnapshot - function to copy the files from the snapshot into the target folder: the arguments are (sourcePath, targetPath)

Returns:

a future with the persisted snapshot for bootstrap.

getBootstrapSnapshot

public Optional<PersistedSnapshot> getBootstrapSnapshot()