Package org.apache.jackrabbit.oak.plugins.document

Class VersionGarbageCollector

java.lang.Object

org.apache.jackrabbit.oak.plugins.document.VersionGarbageCollector

public class VersionGarbageCollector
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VersionGarbageCollector.VersionGCInfo
static class	VersionGarbageCollector.VersionGCStats

Field Summary

Fields

Modifier and Type	Field	Description
static String	SETTINGS_COLLECTION_FULL_GC_REMOVED_TOTAL_BSON_SIZE	Property name to sum the total size of removed garbage in bytes
static String	SETTINGS_COLLECTION_ID	Document id stored in settings collection that keeps info about version gc

Method Summary

Modifier and Type	Method	Description
void	cancel()
void	collectGarbageOnDocument(DocumentNodeStore store, NodeDocument doc, boolean verbose)
VersionGarbageCollector.VersionGCStats	gc(long maxRevisionAge, TimeUnit unit)
int	getFullGcBatchSize()
double	getFullGcDelayFactor()
Set<String>	getFullGCExcludePaths()
Set<String>	getFullGCIncludePaths()
long	getFullGcMaxAgeInMillis()
static FullGCMode	getFullGcMode()
int	getFullGcProgressSize()
String	getFullGCStatsReport()
VersionGarbageCollector.VersionGCInfo	getInfo(long maxRevisionAge, TimeUnit unit)
VersionGCOptions	getOptions()
String	getStatus()
boolean	isEmbeddedVerificationEnabled()
boolean	isFullGCDryRun()
boolean	isFullGCEnabled()
void	reset()
void	resetDryRun()
void	resetFullGC()
void	setFullGCMetricsExporter(FullGCMetricsExporter exporter)
void	setGCMonitor(@NotNull GCMonitor gcMonitor)
void	setOptions(VersionGCOptions options)
void	setStatisticsProvider(StatisticsProvider provider)
void	setStatisticsProvider(StatisticsProvider provider, boolean pushMetrics)

Methods inherited from class java.lang.Object

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

Field Detail

SETTINGS_COLLECTION_ID

public static final String SETTINGS_COLLECTION_ID

Document id stored in settings collection that keeps info about version gc

See Also:

Constant Field Values

SETTINGS_COLLECTION_FULL_GC_REMOVED_TOTAL_BSON_SIZE

public static final String SETTINGS_COLLECTION_FULL_GC_REMOVED_TOTAL_BSON_SIZE

Property name to sum the total size of removed garbage in bytes

See Also:

Constant Field Values

Method Detail

getFullGcMode

public static FullGCMode getFullGcMode()

isFullGCEnabled

public boolean isFullGCEnabled()

isFullGCDryRun

public boolean isFullGCDryRun()

isEmbeddedVerificationEnabled

public boolean isEmbeddedVerificationEnabled()

getFullGcDelayFactor

public double getFullGcDelayFactor()

getFullGcMaxAgeInMillis

public long getFullGcMaxAgeInMillis()

getFullGcBatchSize

public int getFullGcBatchSize()

getFullGcProgressSize

public int getFullGcProgressSize()

getFullGCIncludePaths

public Set<String> getFullGCIncludePaths()

getFullGCExcludePaths

public Set<String> getFullGCExcludePaths()

setStatisticsProvider

public void setStatisticsProvider(StatisticsProvider provider)

setStatisticsProvider

public void setStatisticsProvider(StatisticsProvider provider,
                                  boolean pushMetrics)

setFullGCMetricsExporter

public void setFullGCMetricsExporter(FullGCMetricsExporter exporter)

gc

public VersionGarbageCollector.VersionGCStats gc(long maxRevisionAge,
                                                 TimeUnit unit)
                                          throws IOException

Throws:

IOException

cancel

public void cancel()

getStatus

public String getStatus()

setGCMonitor

public void setGCMonitor(@NotNull
                         @NotNull GCMonitor gcMonitor)

getOptions

public VersionGCOptions getOptions()

setOptions

public void setOptions(VersionGCOptions options)

reset

public void reset()

resetFullGC

public void resetFullGC()

resetDryRun

public void resetDryRun()

getInfo

public VersionGarbageCollector.VersionGCInfo getInfo(long maxRevisionAge,
                                                     TimeUnit unit)
                                              throws IOException

Throws:

IOException

collectGarbageOnDocument

public void collectGarbageOnDocument(DocumentNodeStore store,
                                     NodeDocument doc,
                                     boolean verbose)

getFullGCStatsReport

public String getFullGCStatsReport()