org.apache.jackrabbit.oak.plugins.segment.compaction

Class CompactionStrategy

java.lang.Object

org.apache.jackrabbit.oak.plugins.segment.compaction.CompactionStrategy

public abstract class CompactionStrategy
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompactionStrategy.CleanupType

Field Summary

Fields

Modifier and Type	Field and Description
static CompactionStrategy.CleanupType	CLEANUP_DEFAULT
static boolean	CLONE_BINARIES_DEFAULT
static boolean	FORCE_AFTER_FAIL_DEFAULT Default value for getForceAfterFail()
static byte	GAIN_THRESHOLD_DEFAULT
static byte	MEMORY_THRESHOLD_DEFAULT
static CompactionStrategy	NO_COMPACTION No compaction at all
static boolean	PAUSE_DEFAULT
static boolean	PERSIST_COMPACTION_MAP_DEFAULT
static int	RETRY_COUNT_DEFAULT Default value for getRetryCount()
static long	TIMESTAMP_DEFAULT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompactionStrategy(boolean paused, boolean cloneBinaries, CompactionStrategy.CleanupType cleanupType, long olderThan, byte memoryThreshold)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRemove(SegmentId id)
boolean	cloneBinaries()
abstract boolean	compacted(Callable<Boolean> setHead)
boolean	getForceAfterFail() Get whether or not to force compact concurrent commits on top of already compacted commits after the maximum number of retries has been reached.
byte	getGainThreshold() Get the compaction gain estimate threshold beyond which compaction should run
byte	getMemoryThreshold()
boolean	getPersistCompactionMap()
int	getRetryCount() Get the number of tries to compact concurrent commits on top of already compacted commits
boolean	isDiskSpaceSufficient(long repositoryDiskSpace, long availableDiskSpace) Check if the approximate repository size is getting too big compared with the available space on disk.
boolean	isOfflineCompaction()
boolean	isPaused()
void	setCleanupType(CompactionStrategy.CleanupType cleanupType)
void	setCloneBinaries(boolean cloneBinaries)
void	setCompactionStart(long ms)
void	setForceAfterFail(boolean forceAfterFail) Set whether or not to force compact concurrent commits on top of already compacted commits after the maximum number of retries has been reached.
void	setGainThreshold(byte gainThreshold) Set the compaction gain estimate threshold beyond which compaction should run
void	setMemoryThreshold(byte memoryThreshold)
void	setOfflineCompaction(boolean offlineCompaction)
void	setOlderThan(long olderThan)
void	setPaused(boolean paused)
void	setPersistCompactionMap(boolean persist)
void	setRetryCount(int retryCount) Set the number of tries to compact concurrent commits on top of already compacted commits
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PAUSE_DEFAULT

public static final boolean PAUSE_DEFAULT

See Also:

Constant Field Values

CLONE_BINARIES_DEFAULT

public static final boolean CLONE_BINARIES_DEFAULT

See Also:

Constant Field Values

CLEANUP_DEFAULT

public static final CompactionStrategy.CleanupType CLEANUP_DEFAULT

TIMESTAMP_DEFAULT

public static final long TIMESTAMP_DEFAULT

See Also:

Constant Field Values

MEMORY_THRESHOLD_DEFAULT

public static final byte MEMORY_THRESHOLD_DEFAULT

See Also:

Constant Field Values

PERSIST_COMPACTION_MAP_DEFAULT

public static final boolean PERSIST_COMPACTION_MAP_DEFAULT

See Also:

Constant Field Values

GAIN_THRESHOLD_DEFAULT

public static final byte GAIN_THRESHOLD_DEFAULT

See Also:

Constant Field Values

RETRY_COUNT_DEFAULT

public static final int RETRY_COUNT_DEFAULT

Default value for getRetryCount()

See Also:

Constant Field Values

FORCE_AFTER_FAIL_DEFAULT

public static final boolean FORCE_AFTER_FAIL_DEFAULT

Default value for getForceAfterFail()

See Also:

Constant Field Values

NO_COMPACTION

public static final CompactionStrategy NO_COMPACTION

No compaction at all

Constructor Detail

CompactionStrategy

protected CompactionStrategy(boolean paused,
                  boolean cloneBinaries,
                  @Nonnull
                  CompactionStrategy.CleanupType cleanupType,
                  long olderThan,
                  byte memoryThreshold)

Method Detail

canRemove

public boolean canRemove(SegmentId id)

cloneBinaries

public boolean cloneBinaries()

isPaused

public boolean isPaused()

setPaused

public void setPaused(boolean paused)

setCloneBinaries

public void setCloneBinaries(boolean cloneBinaries)

setCleanupType

public void setCleanupType(@Nonnull
                  CompactionStrategy.CleanupType cleanupType)

setOlderThan

public void setOlderThan(long olderThan)

toString

public String toString()

Overrides:

toString in class Object

setCompactionStart

public void setCompactionStart(long ms)

getMemoryThreshold

public byte getMemoryThreshold()

setMemoryThreshold

public void setMemoryThreshold(byte memoryThreshold)

getPersistCompactionMap

public boolean getPersistCompactionMap()

setPersistCompactionMap

public void setPersistCompactionMap(boolean persist)

getForceAfterFail

public boolean getForceAfterFail()

Get whether or not to force compact concurrent commits on top of already compacted commits after the maximum number of retries has been reached. Force committing tries to exclusively write lock the node store.

Returns:

true if force commit is on, false otherwise

setForceAfterFail

public void setForceAfterFail(boolean forceAfterFail)

Set whether or not to force compact concurrent commits on top of already compacted commits after the maximum number of retries has been reached. Force committing tries to exclusively write lock the node store.

Parameters:

forceAfterFail -

getRetryCount

public int getRetryCount()

Get the number of tries to compact concurrent commits on top of already compacted commits

Returns:

retry count

setRetryCount

public void setRetryCount(int retryCount)

Set the number of tries to compact concurrent commits on top of already compacted commits

Parameters:

retryCount -

getGainThreshold

public byte getGainThreshold()

Get the compaction gain estimate threshold beyond which compaction should run

Returns:

gainThreshold

setGainThreshold

public void setGainThreshold(byte gainThreshold)

Set the compaction gain estimate threshold beyond which compaction should run

Parameters:

gainThreshold -

compacted

public abstract boolean compacted(@Nonnull
                Callable<Boolean> setHead)
                           throws Exception

Throws:

Exception

isOfflineCompaction

public boolean isOfflineCompaction()

setOfflineCompaction

public void setOfflineCompaction(boolean offlineCompaction)

isDiskSpaceSufficient

public boolean isDiskSpaceSufficient(long repositoryDiskSpace,
                            long availableDiskSpace)

Check if the approximate repository size is getting too big compared with the available space on disk.

Parameters:

repositoryDiskSpace - Approximate size of the disk space occupied by the repository.

availableDiskSpace - Currently available disk space.

Returns:

true if the available disk space is considered enough for normal repository operations.