org.apache.jackrabbit.oak.backup.impl

Class FileStoreBackupRestoreImpl

java.lang.Object

org.apache.jackrabbit.oak.backup.impl.FileStoreBackupRestoreImpl

All Implemented Interfaces:

FileStoreBackupRestoreMBean

public class FileStoreBackupRestoreImpl
extends Object
implements FileStoreBackupRestoreMBean

Default implementation of FileStoreBackupRestoreMBean based on a file.

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.api.jmx.FileStoreBackupRestoreMBean

TYPE

Constructor Summary

Constructors

Constructor and Description
FileStoreBackupRestoreImpl(SegmentNodeStore store, Revisions revisions, SegmentReader reader, File file, Executor executor)

Method Summary

Modifier and Type	Method and Description
String	checkpoint(long lifetime) Creates a new checkpoint of the latest root of the tree.
CompositeData	getBackupStatus() Backup status
CompositeData	getRestoreStatus() Restore status
CompositeData	startBackup() Initiate a backup operation.
CompositeData	startRestore() Initiate a restore operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStoreBackupRestoreImpl

public FileStoreBackupRestoreImpl(@Nonnull
                                  SegmentNodeStore store,
                                  @Nonnull
                                  Revisions revisions,
                                  @Nonnull
                                  SegmentReader reader,
                                  @Nonnull
                                  File file,
                                  @Nonnull
                                  Executor executor)

Parameters:

store - store to back up from or restore to

file - file to back up to or restore from

executor - executor for running the back up or restore operation

Method Detail

startBackup

@Nonnull
public CompositeData startBackup()

Description copied from interface: FileStoreBackupRestoreMBean

Initiate a backup operation.

Specified by:

startBackup in interface FileStoreBackupRestoreMBean

Returns:

the status of the operation right after it was initiated

getBackupStatus

@Nonnull
public CompositeData getBackupStatus()

Description copied from interface: FileStoreBackupRestoreMBean

Backup status

Specified by:

getBackupStatus in interface FileStoreBackupRestoreMBean

Returns:

the status of the ongoing operation or if none the terminal status of the last operation or Status not available if none.

startRestore

@Nonnull
public CompositeData startRestore()

Description copied from interface: FileStoreBackupRestoreMBean

Initiate a restore operation.

Specified by:

startRestore in interface FileStoreBackupRestoreMBean

Returns:

the status of the operation right after it was initiated

getRestoreStatus

@Nonnull
public CompositeData getRestoreStatus()

Description copied from interface: FileStoreBackupRestoreMBean

Restore status

Specified by:

getRestoreStatus in interface FileStoreBackupRestoreMBean

Returns:

the status of the ongoing operation or if none the terminal status of the last operation or Status not available if none.

checkpoint

@Nonnull
public String checkpoint(long lifetime)

Description copied from interface: FileStoreBackupRestoreMBean

Creates a new checkpoint of the latest root of the tree. The checkpoint remains valid for at least as long as requested and allows that state of the repository to be retrieved using the returned opaque string reference.

Specified by:

checkpoint in interface FileStoreBackupRestoreMBean

Parameters:

lifetime - time (in milliseconds, > 0) that the checkpoint should remain available

Returns:

string reference of this checkpoint