Package org.apache.jackrabbit.oak.plugins.blob

Class BlobGC

java.lang.Object
javax.management.StandardMBean
org.apache.jackrabbit.oak.commons.jmx.AnnotatedStandardMBean
org.apache.jackrabbit.oak.plugins.blob.BlobGC
All Implemented Interfaces:
DynamicMBean, MBeanRegistration, BlobGCMBean
public class BlobGC extends org.apache.jackrabbit.oak.commons.jmx.AnnotatedStandardMBean implements BlobGCMBean
Default implementation of BlobGCMBean based on a BlobGarbageCollector.

  • Field Details

  • Constructor Details

    • BlobGC

      public BlobGC(@NotNull @NotNull BlobGarbageCollector blobGarbageCollector, @NotNull @NotNull Executor executor)
      Parameters:
      blobGarbageCollector - Blob garbage collector
      executor - executor for running the garbage collection task

  • Method Details

    • startBlobGC

      @NotNull public @NotNull CompositeData startBlobGC(boolean markOnly)
      Description copied from interface: BlobGCMBean
      Initiate a data store garbage collection operation.
      Specified by:
      startBlobGC in interface BlobGCMBean
      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

    • startBlobGC

      public CompositeData startBlobGC(boolean markOnly, boolean forceBlobIdRetrieve)
      Description copied from interface: BlobGCMBean
      Initiate a data store garbage collection operation.
      Specified by:
      startBlobGC in interface BlobGCMBean
      Parameters:
      markOnly - whether to only mark references and not sweep in the mark and sweep operation.
      forceBlobIdRetrieve - whether to force retrieve blob ids from datastore
      Returns:
      the status of the operation right after it was initiated

    • getBlobGCStatus

      @NotNull public @NotNull CompositeData getBlobGCStatus()
      Description copied from interface: BlobGCMBean
      Data store garbage collection status
      Specified by:
      getBlobGCStatus in interface BlobGCMBean
      Returns:
      the status of the ongoing operation or if none the terminal status of the last operation or Status not available if none.

    • checkConsistency

      public CompositeData checkConsistency()
      Description copied from interface: BlobGCMBean
      Data Store consistency check
      Specified by:
      checkConsistency in interface BlobGCMBean
      Returns:
      the missing blobs

    • getConsistencyCheckStatus

      @NotNull public @NotNull CompositeData getConsistencyCheckStatus()
      Description copied from interface: BlobGCMBean
      Consistency check status
      Specified by:
      getConsistencyCheckStatus in interface BlobGCMBean
      Returns:
      the status of the ongoing operation or if none the terminal status of the last operation or Status not available if none.

    • getGlobalMarkStats

      public TabularData getGlobalMarkStats()
      Description copied from interface: BlobGCMBean
      Show details of the data Store garbage collection process.
      Specified by:
      getGlobalMarkStats in interface BlobGCMBean
      Returns:
      List of available repositories and their status

    • getOperationStats

      public TabularData getOperationStats()
      Description copied from interface: BlobGCMBean
      Show details of the data Store garbage collection invocations.
      Specified by:
      getOperationStats in interface BlobGCMBean
      Returns:
      Data about all the previous gc invocations