org.apache.jackrabbit.oak.management

Class RepositoryManager

java.lang.Object

javax.management.StandardMBean

org.apache.jackrabbit.oak.commons.jmx.AnnotatedStandardMBean

org.apache.jackrabbit.oak.management.RepositoryManager

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, RepositoryManagementMBean

public class RepositoryManager
extends AnnotatedStandardMBean
implements RepositoryManagementMBean

Default implementation of the RepositoryManagementMBean based on a Whiteboard instance, which is used to look up individual service providers for backup (FileStoreBackupRestoreMBean), data store garbage collections (BlobGCMBean) and revision store garbage collections (RevisionGCMBean).

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

RepositoryManagementMBean.StatusCode

Field Summary

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

TYPE

Constructor Summary

Constructors

Constructor and Description
RepositoryManager(@NotNull Whiteboard whiteboard)

Method Summary

Modifier and Type	Method and Description
@NotNull CompositeData	cancelRevisionGC() Cancel a running revision garbage collection operation.
@NotNull CompositeData	cancelRevisionGCForRole(String role) Cancel a running revision garbage collection operation for a given role.
String	checkpoint(long lifetime) Creates a new checkpoint of the latest root of the tree.
CompositeData	getBackupStatus() Backup status
CompositeData	getDataStoreGCStatus() Data store garbage collection status
String	getName()
CompositeData	getPropertyIndexAsyncReindexStatus() Asynchronous Property Index reindexing status
CompositeData	getRestoreStatus() Restore status
CompositeData	getRevisionGCStatus() Revision garbage collection status
@NotNull CompositeData	getRevisionGCStatusForRole(String role) Revision garbage collection status for a given role.
TabularData	refreshAllSessions() Refresh all currently open sessions.
CompositeData	startBackup() Initiate a backup operation.
CompositeData	startDataStoreGC(boolean markOnly) Initiate a data store garbage collection operation
CompositeData	startPropertyIndexAsyncReindex() Initiate a reindex operation for the property indexes marked for reindexing
CompositeData	startRestore() Initiate a restore operation.
CompositeData	startRevisionGC() Initiate a revision garbage collection operation
CompositeData	startRevisionGCForRole(String role) Initiate a revision garbage collection operation

Methods inherited from class org.apache.jackrabbit.oak.commons.jmx.AnnotatedStandardMBean

getDescription, getDescription, getDescription, getDescription, getImpact, getParameterName

Methods inherited from class javax.management.StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryManager

public RepositoryManager(@NotNull
                         @NotNull Whiteboard whiteboard)

Method Detail

getName

public String getName()

startBackup

public CompositeData startBackup()

Description copied from interface: RepositoryManagementMBean

Initiate a backup operation.

Specified by:

startBackup in interface RepositoryManagementMBean

Returns:

the status of the operation right after it was initiated

getBackupStatus

public CompositeData getBackupStatus()

Description copied from interface: RepositoryManagementMBean

Backup status

Specified by:

getBackupStatus in interface RepositoryManagementMBean

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 CompositeData startRestore()

Description copied from interface: RepositoryManagementMBean

Initiate a restore operation.

Specified by:

startRestore in interface RepositoryManagementMBean

Returns:

the status of the operation right after it was initiated

getRestoreStatus

public CompositeData getRestoreStatus()

Description copied from interface: RepositoryManagementMBean

Restore status

Specified by:

getRestoreStatus in interface RepositoryManagementMBean

Returns:

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

startDataStoreGC

public CompositeData startDataStoreGC(boolean markOnly)

Description copied from interface: RepositoryManagementMBean

Initiate a data store garbage collection operation

Specified by:

startDataStoreGC in interface RepositoryManagementMBean

Parameters:

markOnly - whether to only mark references and not sweep in the mark and sweep operation.

Returns:

the status of the operation right after it was initiated

getDataStoreGCStatus

public CompositeData getDataStoreGCStatus()

Description copied from interface: RepositoryManagementMBean

Data store garbage collection status

Specified by:

getDataStoreGCStatus in interface RepositoryManagementMBean

Returns:

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

startRevisionGC

public CompositeData startRevisionGC()

Description copied from interface: RepositoryManagementMBean

Initiate a revision garbage collection operation

Specified by:

startRevisionGC in interface RepositoryManagementMBean

Returns:

the status of the operation right after it was initiated

startRevisionGCForRole

public CompositeData startRevisionGCForRole(String role)

Description copied from interface: RepositoryManagementMBean

Initiate a revision garbage collection operation

Specified by:

startRevisionGCForRole in interface RepositoryManagementMBean

Returns:

the status of the operation right after it was initiated

cancelRevisionGC

@NotNull
public @NotNull CompositeData cancelRevisionGC()

Description copied from interface: RepositoryManagementMBean

Cancel a running revision garbage collection operation. Does nothing if revision garbage collection is not running.

Specified by:

cancelRevisionGC in interface RepositoryManagementMBean

Returns:

the status of the operation right after it was initiated

cancelRevisionGCForRole

@NotNull
public @NotNull CompositeData cancelRevisionGCForRole(String role)

Description copied from interface: RepositoryManagementMBean

Cancel a running revision garbage collection operation for a given role. Does nothing if revision garbage collection is not running.

Specified by:

cancelRevisionGCForRole in interface RepositoryManagementMBean

Returns:

the status of the operation right after it was initiated

getRevisionGCStatus

public CompositeData getRevisionGCStatus()

Description copied from interface: RepositoryManagementMBean

Revision garbage collection status

Specified by:

getRevisionGCStatus in interface RepositoryManagementMBean

Returns:

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

getRevisionGCStatusForRole

@NotNull
public @NotNull CompositeData getRevisionGCStatusForRole(String role)

Description copied from interface: RepositoryManagementMBean

Revision garbage collection status for a given role.

Specified by:

getRevisionGCStatusForRole in interface RepositoryManagementMBean

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 String checkpoint(long lifetime)

Description copied from interface: RepositoryManagementMBean

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 RepositoryManagementMBean

Parameters:

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

Returns:

string reference of this checkpoint or null if the checkpoint could not be set.

startPropertyIndexAsyncReindex

public CompositeData startPropertyIndexAsyncReindex()

Description copied from interface: RepositoryManagementMBean

Initiate a reindex operation for the property indexes marked for reindexing

Specified by:

startPropertyIndexAsyncReindex in interface RepositoryManagementMBean

Returns:

the status of the operation right after it was initiated

getPropertyIndexAsyncReindexStatus

public CompositeData getPropertyIndexAsyncReindexStatus()

Description copied from interface: RepositoryManagementMBean

Asynchronous Property Index reindexing status

Specified by:

getPropertyIndexAsyncReindexStatus in interface RepositoryManagementMBean

Returns:

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

refreshAllSessions

public TabularData refreshAllSessions()

Description copied from interface: RepositoryManagementMBean

Refresh all currently open sessions. Warning: this operation might be disruptive to the owner of the affected sessions

Specified by:

refreshAllSessions in interface RepositoryManagementMBean