org.apache.jackrabbit.oak.plugins.blob

Class MarkSweepGarbageCollector

java.lang.Object

org.apache.jackrabbit.oak.plugins.blob.MarkSweepGarbageCollector

All Implemented Interfaces:

BlobGarbageCollector

public class MarkSweepGarbageCollector
extends java.lang.Object
implements BlobGarbageCollector

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 Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BATCH_COUNT
static java.lang.String	DELIM
static org.slf4j.Logger	LOG
static java.lang.String	NEWLINE
static java.lang.String	TEMP_DIR

Constructor Summary

Constructors

Constructor and Description
MarkSweepGarbageCollector(BlobReferenceRetriever marker, GarbageCollectableBlobStore blobStore, java.util.concurrent.Executor executor, long maxLastModifiedInterval, java.lang.String repositoryId)
MarkSweepGarbageCollector(BlobReferenceRetriever marker, GarbageCollectableBlobStore blobStore, java.util.concurrent.Executor executor, java.lang.String repositoryId) Instantiates a new blob garbage collector.
MarkSweepGarbageCollector(BlobReferenceRetriever marker, GarbageCollectableBlobStore blobStore, java.util.concurrent.Executor executor, java.lang.String root, int batchCount, long maxLastModifiedInterval, java.lang.String repositoryId) Creates an instance of MarkSweepGarbageCollector

Method Summary

Modifier and Type	Method and Description
long	checkConsistency() Checks for the DataStore consistency and reports the number of missing blobs still referenced.
void	collectGarbage(boolean markOnly) Marks garbage blobs from the passed node store instance.
java.util.List<GarbageCollectionRepoStats>	getStats() Returns the stats related to GC for all repos

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

NEWLINE

public static final java.lang.String NEWLINE

TEMP_DIR

public static final java.lang.String TEMP_DIR

DEFAULT_BATCH_COUNT

public static final int DEFAULT_BATCH_COUNT

See Also:

Constant Field Values

DELIM

public static final java.lang.String DELIM

See Also:

Constant Field Values

Constructor Detail

MarkSweepGarbageCollector

public MarkSweepGarbageCollector(BlobReferenceRetriever marker,
                                 GarbageCollectableBlobStore blobStore,
                                 java.util.concurrent.Executor executor,
                                 java.lang.String root,
                                 int batchCount,
                                 long maxLastModifiedInterval,
                                 java.lang.String repositoryId)
                          throws java.io.IOException

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

Throws:

java.io.IOException

MarkSweepGarbageCollector

public MarkSweepGarbageCollector(BlobReferenceRetriever marker,
                                 GarbageCollectableBlobStore blobStore,
                                 java.util.concurrent.Executor executor,
                                 java.lang.String repositoryId)
                          throws java.io.IOException

Instantiates a new blob garbage collector.

Throws:

java.io.IOException

MarkSweepGarbageCollector

public MarkSweepGarbageCollector(BlobReferenceRetriever marker,
                                 GarbageCollectableBlobStore blobStore,
                                 java.util.concurrent.Executor executor,
                                 long maxLastModifiedInterval,
                                 java.lang.String repositoryId)
                          throws java.io.IOException

Throws:

java.io.IOException

Method Detail

collectGarbage

public void collectGarbage(boolean markOnly)
                    throws java.lang.Exception

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:

java.lang.Exception - the exception

getStats

public java.util.List<GarbageCollectionRepoStats> getStats()
                                                    throws java.lang.Exception

Returns the stats related to GC for all repos

Specified by:

getStats in interface BlobGarbageCollector

Returns:

a list of GarbageCollectionRepoStats objects

Throws:

java.lang.Exception

checkConsistency

public long checkConsistency()
                      throws java.lang.Exception

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:

java.lang.Exception