org.elastos.hive.service

Interface BackupService

public interface BackupService

Backup service is for doing backup vault data from vault node server to backup server.

Backup server maybe another node server or third-party centered server like Google Driver.

As a restrict, only one vault can be used for one DID.

User also need just one backup copy for vault data.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BackupService.BackupResult

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<BackupService.BackupResult>	checkResult() Check the current status of the node side backup process.
java.util.concurrent.CompletableFuture<java.lang.Void>	restoreFrom() This is for restore vault data from backup server only once.
java.util.concurrent.CompletableFuture<java.lang.Void>	setupContext(BackupContext context) Set-up a context for get more detailed information for backup server.
java.util.concurrent.CompletableFuture<java.lang.Void>	startBackup() Backup process in node side is a continues process.
java.util.concurrent.CompletableFuture<java.lang.Void>	stopBackup() As startBackup() shows, this is just for stopping the async process in vault node side.
java.util.concurrent.CompletableFuture<java.lang.Void>	stopRestore() Stop the running restore process in background.

Method Detail

setupContext

java.util.concurrent.CompletableFuture<java.lang.Void> setupContext(BackupContext context)

Set-up a context for get more detailed information for backup server.

Parameters:

context - context for providing backup server details.

Returns:

Void

startBackup

java.util.concurrent.CompletableFuture<java.lang.Void> startBackup()

Backup process in node side is a continues process. Vault node server backup whole vault data to backup server and keep syncing with it. This is for user personal data security.

This function is for starting a background scheduler to update data to backup server. It's an async process.

Returns:

Void

stopBackup

java.util.concurrent.CompletableFuture<java.lang.Void> stopBackup()

As startBackup() shows, this is just for stopping the async process in vault node side.

Returns:

Void

restoreFrom

java.util.concurrent.CompletableFuture<java.lang.Void> restoreFrom()

This is for restore vault data from backup server only once. The action is processed async in node side.

Returns:

Void

stopRestore

java.util.concurrent.CompletableFuture<java.lang.Void> stopRestore()

Stop the running restore process in background.

Returns:

Void

checkResult

java.util.concurrent.CompletableFuture<BackupService.BackupResult> checkResult()

Check the current status of the node side backup process.

Returns:

Void