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

Class MarkSweepGarbageCollector

java.lang.Object
org.apache.jackrabbit.oak.plugins.blob.MarkSweepGarbageCollector
All Implemented Interfaces:
BlobGarbageCollector
@Deprecated(since="2024-09-23") public class MarkSweepGarbageCollector extends Object implements BlobGarbageCollector
Deprecated.
The Jackrabbit Oak Blob Plugins library is designed for Oak-internal use only and thus deprecated. It will not be part of the AEM SDK after April 2025.
Mark and sweep garbage collector. Uses the file system to store internal state while in process to account for huge data. This class is not thread safe.

  • Field Details

    • LOG

      public static final Logger LOG
      Deprecated.

    • TEMP_DIR

      public static final String TEMP_DIR
      Deprecated.

    • DEFAULT_BATCH_COUNT

      public static final int DEFAULT_BATCH_COUNT
      Deprecated.
      See Also:

    • DELIM

      public static final String DELIM
      Deprecated.
      See Also:

  • Constructor Details

    • MarkSweepGarbageCollector

      public MarkSweepGarbageCollector(BlobReferenceRetriever marker, GarbageCollectableBlobStore blobStore, Executor executor, String root, int batchCount, long maxLastModifiedInterval, boolean checkConsistencyAfterGc, boolean sweepIfRefsPastRetention, @Nullable @Nullable String repositoryId, @Nullable @Nullable Whiteboard whiteboard, @Nullable @Nullable StatisticsProvider statisticsProvider) throws IOException
      Deprecated.
      Creates an instance of MarkSweepGarbageCollector
      Parameters:
      marker - BlobReferenceRetriever instanced used to fetch refereed blob entries
      blobStore - the blob store instance
      executor - executor
      root - the root absolute path of directory under which temporary files would be created
      batchCount - batch sized used for saving intermediate state
      maxLastModifiedInterval - lastModifiedTime in millis. Only files with time less than this time would be considered for GC
      repositoryId - unique repository id for this node
      whiteboard - whiteboard instance
      statisticsProvider - statistics provider instance
      Throws:
      IOException

    • MarkSweepGarbageCollector

      public MarkSweepGarbageCollector(BlobReferenceRetriever marker, GarbageCollectableBlobStore blobStore, Executor executor, String root, int batchCount, long maxLastModifiedInterval, @Nullable @Nullable String repositoryId) throws IOException
      Deprecated.
      Throws:
      IOException

    • MarkSweepGarbageCollector

      public MarkSweepGarbageCollector(BlobReferenceRetriever marker, GarbageCollectableBlobStore blobStore, Executor executor, long maxLastModifiedInterval, @Nullable @Nullable String repositoryId, @Nullable @Nullable Whiteboard whiteboard, @Nullable @Nullable StatisticsProvider statisticsProvider) throws IOException
      Deprecated.
      Instantiates a new blob garbage collector.
      Throws:
      IOException

  • Method Details

    • collectGarbage

      public void collectGarbage(boolean markOnly) throws Exception
      Deprecated.
      Description copied from interface: BlobGarbageCollector
      Marks garbage blobs from the passed node store instance. Collects them only if markOnly is false.
      Specified by:
      collectGarbage in interface BlobGarbageCollector
      Parameters:
      markOnly - whether to only mark references and not sweep in the mark and sweep operation.
      Throws:
      Exception - the exception

    • collectGarbage

      public void collectGarbage(boolean markOnly, boolean forceBlobRetrieve) throws Exception
      Deprecated.
      Description copied from interface: BlobGarbageCollector
      Marks garbage blobs from the passed node store instance. Collects them only if markOnly is false. Also forces retrieval of blob ids from the blob store rather than using any local tracking.
      Specified by:
      collectGarbage in interface BlobGarbageCollector
      Parameters:
      markOnly - whether to only mark references and not sweep in the mark and sweep operation.
      forceBlobRetrieve - whether to force retrieve of blob ids from datastore
      Throws:
      Exception

    • getStats

      public List<GarbageCollectionRepoStats> getStats() throws Exception
      Deprecated.
      Returns the stats related to GC for all repos
      Specified by:
      getStats in interface BlobGarbageCollector
      Returns:
      a list of GarbageCollectionRepoStats objects
      Throws:
      Exception

    • getOperationStats

      public OperationsStatsMBean getOperationStats()
      Deprecated.
      Description copied from interface: BlobGarbageCollector
      Returns operation statistics
      Specified by:
      getOperationStats in interface BlobGarbageCollector
      Returns:
      stats object

    • getConsistencyOperationStats

      public OperationsStatsMBean getConsistencyOperationStats()
      Deprecated.
      Description copied from interface: BlobGarbageCollector
      Returns consistency operation statistics
      Specified by:
      getConsistencyOperationStats in interface BlobGarbageCollector
      Returns:
      stats object

    • checkConsistency

      public long checkConsistency(boolean markOnly) throws Exception
      Deprecated.
      Description copied from interface: BlobGarbageCollector
      Collects the blob references and consolidates references from other repositories if available in the DataStore. Adds relevant metrics.
      Specified by:
      checkConsistency in interface BlobGarbageCollector
      Returns:
      Throws:
      Exception

    • checkConsistency

      public long checkConsistency() throws Exception
      Deprecated.
      Checks for the DataStore consistency and reports the number of missing blobs still referenced.
      Specified by:
      checkConsistency in interface BlobGarbageCollector
      Returns:
      the missing blobs
      Throws:
      Exception

    • setTraceOutput

      public void setTraceOutput(boolean trace)
      Deprecated.

    • setClock

      public void setClock(Clock clock)
      Deprecated.