Package io.camunda.zeebe.backup.filesystem

Class FilesystemBackupStore

java.lang.Object

io.camunda.zeebe.backup.filesystem.FilesystemBackupStore

All Implemented Interfaces:

BackupStore

public final class FilesystemBackupStore
extends Object
implements BackupStore

BackupStore for local filesystem. Stores all backups in a given baseDir.

All created object keys are prefixed by the BackupIdentifier, with the following scheme: basePath/partitionId/checkpointId/nodeId.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_MSG_BACKUP_NOT_FOUND
static final String	ERROR_MSG_BACKUP_WRONG_STATE_TO_RESTORE
static final String	SEGMENTS_FILESET_NAME
static final String	SNAPSHOT_FILESET_NAME

Constructor Summary

Constructors

Constructor	Description
FilesystemBackupStore(FilesystemBackupConfig config, ExecutorService executor)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	closeAsync()
CompletableFuture<Void>	delete(BackupIdentifier id)
CompletableFuture<BackupStatus>	getStatus(BackupIdentifier id)
CompletableFuture<Collection<BackupStatus>>	list(BackupIdentifierWildcard wildcard)
CompletableFuture<BackupStatusCode>	markFailed(BackupIdentifier id, String failureReason)
CompletableFuture<Backup>	restore(BackupIdentifier id, Path targetFolder)
CompletableFuture<Void>	save(Backup backup)
static void	validateConfig(FilesystemBackupConfig config)

Methods inherited from class java.lang.Object

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

Field Details

ERROR_MSG_BACKUP_NOT_FOUND

public static final String ERROR_MSG_BACKUP_NOT_FOUND

See Also:

• Constant Field Values

ERROR_MSG_BACKUP_WRONG_STATE_TO_RESTORE

public static final String ERROR_MSG_BACKUP_WRONG_STATE_TO_RESTORE

See Also:

• Constant Field Values

SNAPSHOT_FILESET_NAME

public static final String SNAPSHOT_FILESET_NAME

See Also:

• Constant Field Values

SEGMENTS_FILESET_NAME

public static final String SEGMENTS_FILESET_NAME

See Also:

• Constant Field Values

Constructor Details

FilesystemBackupStore

public FilesystemBackupStore(FilesystemBackupConfig config,
 ExecutorService executor)

Method Details

save

public CompletableFuture<Void> save(Backup backup)

Specified by:

save in interface BackupStore

getStatus

public CompletableFuture<BackupStatus> getStatus(BackupIdentifier id)

Specified by:

getStatus in interface BackupStore

list

public CompletableFuture<Collection<BackupStatus>> list(BackupIdentifierWildcard wildcard)

Specified by:

list in interface BackupStore

delete

public CompletableFuture<Void> delete(BackupIdentifier id)

Specified by:

delete in interface BackupStore

restore

public CompletableFuture<Backup> restore(BackupIdentifier id,
 Path targetFolder)

Specified by:

restore in interface BackupStore

markFailed

public CompletableFuture<BackupStatusCode> markFailed(BackupIdentifier id,
 String failureReason)

Specified by:

markFailed in interface BackupStore

closeAsync

public CompletableFuture<Void> closeAsync()

Specified by:

closeAsync in interface BackupStore

validateConfig

public static void validateConfig(FilesystemBackupConfig config)