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

Class BlobGC

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String CONSISTENCY_OP_NAME  
      static java.lang.String OP_NAME  

      • Fields inherited from interface org.apache.jackrabbit.oak.plugins.blob.BlobGCMBean

        TYPE

    • Constructor Summary

      Constructors 
      Constructor Description
      BlobGC​(@NotNull BlobGarbageCollector blobGarbageCollector, @NotNull java.util.concurrent.Executor executor)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.management.openmbean.CompositeData checkConsistency()
      Data Store consistency check
      @NotNull javax.management.openmbean.CompositeData getBlobGCStatus()
      Data store garbage collection status
      @NotNull javax.management.openmbean.CompositeData getConsistencyCheckStatus()
      Consistency check status
      javax.management.openmbean.TabularData getGlobalMarkStats()
      Show details of the data Store garbage collection process.
      javax.management.openmbean.TabularData getOperationStats()
      Show details of the data Store garbage collection invocations.
      @NotNull javax.management.openmbean.CompositeData startBlobGC​(boolean markOnly)
      Initiate a data store garbage collection operation.
      javax.management.openmbean.CompositeData startBlobGC​(boolean markOnly, boolean forceBlobIdRetrieve)
      Initiate a data store garbage collection operation.

      • Methods inherited from class javax.management.StandardMBean

        getAttribute, getAttributes, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • BlobGC

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

    • Method Detail

      • startBlobGC

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