Package org.apache.jackrabbit.oak.api.jmx

Interface FileStoreBackupRestoreMBean

All Known Implementing Classes:

FileStoreBackupRestoreImpl

@ProviderType
public interface FileStoreBackupRestoreMBean

MBean for backing up and restoring a NodeStore.

See Also:

RepositoryManagementMBean

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE

Method Summary

Modifier and Type	Method	Description
@NotNull String	checkpoint(long lifetime)	Deprecated. Use CheckpointMBean instead
@NotNull CompositeData	getBackupStatus()	Backup status
@NotNull CompositeData	getRestoreStatus()	Restore status
@NotNull CompositeData	startBackup()	Initiate a backup operation.
@NotNull CompositeData	startRestore()	Initiate a restore operation.

Field Detail

TYPE

static final String TYPE

See Also:

Constant Field Values

Method Detail

startBackup

@NotNull
@NotNull CompositeData startBackup()

Initiate a backup operation.

Returns:

the status of the operation right after it was initiated

getBackupStatus

@NotNull
@NotNull CompositeData getBackupStatus()

Backup status

Returns:

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

startRestore

@NotNull
@NotNull CompositeData startRestore()

Initiate a restore operation.

Returns:

the status of the operation right after it was initiated

getRestoreStatus

@NotNull
@NotNull CompositeData getRestoreStatus()

Restore status

Returns:

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

checkpoint

@Deprecated
@NotNull
@NotNull String checkpoint(long lifetime)

Deprecated.

Use CheckpointMBean instead

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.

Parameters:

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

Returns:

string reference of this checkpoint