Package io.camunda.zeebe.backup.management

Class NoopBackupManager

java.lang.Object

io.camunda.zeebe.backup.management.NoopBackupManager

All Implemented Interfaces:

BackupManager

public class NoopBackupManager
extends Object
implements BackupManager

Constructor Summary

Constructors

Constructor	Description
NoopBackupManager(String errorMessage)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

NoopBackupManager

public NoopBackupManager(String errorMessage)

Parameters:

errorMessage - reason for installing NoopBackupManager. All operations will fail with this message.

Method Details

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.

closeAsync

public ActorFuture<Void> closeAsync()

Description copied from interface: BackupManager

Close Backup manager

Specified by:

closeAsync in interface BackupManager

failInProgressBackup

public void failInProgressBackup(long lastCheckpointId)

Specified by:

failInProgressBackup in interface BackupManager