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

Interface BlobGarbageCollector

All Known Implementing Classes:

MarkSweepGarbageCollector

public interface BlobGarbageCollector

Interface for blob garbage collector

Method Summary

Modifier and Type	Method	Description
long	checkConsistency()	Checks for consistency in the blob store and reporting the number of missing blobs.
long	checkConsistency(boolean markOnly)	Collects the blob references and consolidates references from other repositories if available in the DataStore.
void	collectGarbage(boolean markOnly)	Marks garbage blobs from the passed node store instance.
void	collectGarbage(boolean markOnly, boolean forceBlobRetrieve)	Marks garbage blobs from the passed node store instance.
OperationsStatsMBean	getConsistencyOperationStats()	Returns consistency operation statistics
OperationsStatsMBean	getOperationStats()	Returns operation statistics
java.util.List<GarbageCollectionRepoStats>	getStats()	Retuns the list of stats

Method Detail

collectGarbage

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

Marks garbage blobs from the passed node store instance. Collects them only if markOnly is false.

Parameters:

markOnly - whether to only mark references and not sweep in the mark and sweep operation.

Throws:

java.lang.Exception - the exception

collectGarbage

void collectGarbage(boolean markOnly,
                    boolean forceBlobRetrieve)
             throws java.lang.Exception

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.

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:

java.lang.Exception

getStats

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

Retuns the list of stats

Returns:

stats

Throws:

java.lang.Exception

checkConsistency

long checkConsistency()
               throws java.lang.Exception

Checks for consistency in the blob store and reporting the number of missing blobs.

Returns:

number of inconsistencies

Throws:

java.lang.Exception

checkConsistency

long checkConsistency(boolean markOnly)
               throws java.lang.Exception

Collects the blob references and consolidates references from other repositories if available in the DataStore. Adds relevant metrics.

Returns:

Throws:

java.lang.Exception

getOperationStats

OperationsStatsMBean getOperationStats()
                                throws java.lang.Exception

Returns operation statistics

Returns:

stats object

Throws:

java.lang.Exception

getConsistencyOperationStats

OperationsStatsMBean getConsistencyOperationStats()

Returns consistency operation statistics

Returns:

stats object