Package org.apache.jackrabbit.oak.spi.state

Interface RevisionGCMBean

  • All Known Implementing Classes:
    RevisionGC
    public interface RevisionGCMBean
    MBean for starting and monitoring the progress of revision garbage collection.
    See Also:
    RepositoryManagementMBean

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String TYPE  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @NotNull javax.management.openmbean.CompositeData cancelRevisionGC()
      Cancel a running revision garbage collection operation.
      @NotNull javax.management.openmbean.CompositeData getRevisionGCStatus()
      Revision garbage collection status
      @NotNull javax.management.openmbean.CompositeData startRevisionGC()
      Initiate a revision garbage collection operation

    • Method Detail

      • startRevisionGC

        @NotNull
@NotNull javax.management.openmbean.CompositeData startRevisionGC()
        Initiate a revision garbage collection operation
        Returns:
        the status of the operation right after it was initiated

      • cancelRevisionGC

        @NotNull
@NotNull javax.management.openmbean.CompositeData cancelRevisionGC()
        Cancel a running revision garbage collection operation. Does nothing if revision garbage collection is not running.
        Returns:
        the status of the operation right after it was initiated

      • getRevisionGCStatus

        @NotNull
@NotNull javax.management.openmbean.CompositeData getRevisionGCStatus()
        Revision garbage collection status
        Returns:
        the status of the ongoing operation or if none the terminal status of the last operation or Status not available if none.