Package io.camunda.zeebe.backup.management

Class BackupService

java.lang.Object

io.camunda.zeebe.scheduler.Actor

io.camunda.zeebe.backup.management.BackupService

All Implemented Interfaces:

BackupManager, AsyncClosable, ConcurrencyControl, AutoCloseable

public final class BackupService
extends Actor
implements BackupManager

Backup manager that takes and manages backup asynchronously

Nested Class Summary

Nested classes/interfaces inherited from class io.camunda.zeebe.scheduler.Actor

Actor.ActorBuilder

Field Summary

Fields inherited from class io.camunda.zeebe.scheduler.Actor

actor, ACTOR_PROP_NAME, ACTOR_PROP_PARTITION_ID

Constructor Summary

Constructors

Constructor	Description
BackupService(int nodeId, int partitionId, int numberOfPartitions, BackupStore backupStore, PersistedSnapshotStore snapshotStore, Path segmentsDirectory, Predicate<Path> isSegmentsFile)

Method Summary

Modifier and Type	Method	Description
ActorFuture<Void>	deleteBackup(long checkpointId)	Deletes the backup.
void	failInProgressBackup(long lastCheckpointId)
ActorFuture<BackupStatus>	getBackupStatus(long checkpointId)	Get the status of the backup
String	getName()
ActorFuture<Collection<BackupStatus>>	listBackups()	Get all available backups where status is one of BackupStatusCode.COMPLETED, BackupStatusCode.FAILED, BackupStatusCode.IN_PROGRESS
protected void	onActorClosing()
void	takeBackup(long checkpointId, long checkpointPosition)	Takes backup with id checkpointId.

Methods inherited from class io.camunda.zeebe.scheduler.Actor

buildActorName, buildActorName, close, closeAsync, createContext, getContext, handleFailure, isActorClosed, newActor, onActorClosed, onActorCloseRequested, onActorFailed, onActorStarted, onActorStarting, run, runOnCompletion, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.zeebe.backup.api.BackupManager

closeAsync

Methods inherited from interface io.camunda.zeebe.scheduler.ConcurrencyControl

createCompletedFuture, createFuture

Constructor Details

BackupService

public BackupService(int nodeId,
 int partitionId,
 int numberOfPartitions,
 BackupStore backupStore,
 PersistedSnapshotStore snapshotStore,
 Path segmentsDirectory,
 Predicate<Path> isSegmentsFile)

Method Details

getName

public String getName()

Overrides:

getName in class Actor

onActorClosing

protected void onActorClosing()

Overrides:

onActorClosing in class Actor

takeBackup

public void takeBackup(long checkpointId,
 long checkpointPosition)

Description copied from interface: BackupManager

Takes backup with id checkpointId. The method returns immediately after triggering the backup. BackupManager.getBackupStatus(long) must be used to check if the backup is completed or not. If a completed backup with same id already exists, no new backup will be taken.

The implementation of this method should be non-blocking to not block the caller.

Specified by:

takeBackup in interface BackupManager

Parameters:

checkpointId - id of the backup

checkpointPosition - position of the record until which must be included in the backup.

getBackupStatus

public ActorFuture<BackupStatus> getBackupStatus(long checkpointId)

Description copied from interface: BackupManager

Get the status of the backup

Specified by:

getBackupStatus in interface BackupManager

Returns:

backup status

listBackups

public ActorFuture<Collection<BackupStatus>> listBackups()

Description copied from interface: BackupManager

Get all available backups where status is one of BackupStatusCode.COMPLETED, BackupStatusCode.FAILED, BackupStatusCode.IN_PROGRESS

Specified by:

listBackups in interface BackupManager

Returns:

a collection of backup status

deleteBackup

public ActorFuture<Void> deleteBackup(long checkpointId)

Description copied from interface: BackupManager

Deletes the backup.

Specified by:

deleteBackup in interface BackupManager

Returns:

future which will be completed after the backup is deleted.

failInProgressBackup

public void failInProgressBackup(long lastCheckpointId)

Specified by:

failInProgressBackup in interface BackupManager