org.apache.jackrabbit.oak.plugins.backup

Class FileStoreBackupRestore

java.lang.Object

org.apache.jackrabbit.oak.plugins.backup.FileStoreBackupRestore

All Implemented Interfaces:

FileStoreBackupRestoreMBean

public class FileStoreBackupRestore
extends java.lang.Object
implements FileStoreBackupRestoreMBean

Default implementation of FileStoreBackupRestoreMBean based on a file.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BACKUP_OP_NAME
static java.lang.String	RESTORE_OP_NAME

Constructor Summary

Constructors

Constructor and Description
FileStoreBackupRestore(NodeStore store, java.io.File file, java.util.concurrent.Executor executor)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

BACKUP_OP_NAME

public static final java.lang.String BACKUP_OP_NAME

See Also:

Constant Field Values

RESTORE_OP_NAME

public static final java.lang.String RESTORE_OP_NAME

See Also:

Constant Field Values

Constructor Detail

FileStoreBackupRestore

public FileStoreBackupRestore(NodeStore store,
                              java.io.File file,
                              java.util.concurrent.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

public javax.management.openmbean.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

public javax.management.openmbean.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

public javax.management.openmbean.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

public javax.management.openmbean.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

public java.lang.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