Package org.apache.jackrabbit.oak.indexversion

Class PurgeOldIndexVersion

java.lang.Object

org.apache.jackrabbit.oak.indexversion.PurgeOldIndexVersion

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

LucenePurgeOldIndexVersion

public abstract class PurgeOldIndexVersion
extends Object
implements Closeable

Field Summary

Fields

Modifier and Type	Field	Description
protected Closer	closer

Constructor Summary

Constructors

Constructor	Description
PurgeOldIndexVersion()

Method Summary

Modifier and Type	Method	Description
void	close()
void	execute(NodeStore nodeStore, boolean isReadWriteRepository, long purgeThresholdMillis, List<String> indexPaths)	Execute purging index based on the index version naming and last time index time.
void	execute(NodeStore nodeStore, boolean isReadWriteRepository, long purgeThresholdMillis, List<String> indexPaths, boolean shouldPurgeBaseIndex)	Execute purging index based on the index version naming and last time index time
protected abstract @NotNull String	getIndexType()
protected abstract IndexVersionOperation	getIndexVersionOperationInstance(IndexName indexName)
List<IndexVersionOperation>	getPurgeIndexes(NodeStore nodeStore, long purgeThresholdMillis, List<String> indexPaths)
List<IndexVersionOperation>	getPurgeIndexes(NodeStore nodeStore, long purgeThresholdMillis, List<String> indexPaths, boolean shouldPurgeBaseIndex)
protected abstract void	postDeleteOp(String idxPath)
protected abstract void	preserveDetailsFromIndexDefForPostOp(NodeBuilder builder)	To preserve any required details from index def builder to be used in post op

Methods inherited from class java.lang.Object

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

Field Detail

closer

protected final Closer closer

Constructor Detail

PurgeOldIndexVersion

public PurgeOldIndexVersion()

Method Detail

execute

public void execute(NodeStore nodeStore,
                    boolean isReadWriteRepository,
                    long purgeThresholdMillis,
                    List<String> indexPaths)
             throws IOException,
                    CommitFailedException

Execute purging index based on the index version naming and last time index time. This will purge base index.

Parameters:

nodeStore - the node store

isReadWriteRepository - bool to indicate if it's read write repository, if yes, the purge index will not execute

purgeThresholdMillis - the threshold of time length since last time index time to determine, will purge if exceed that

indexPaths - the index path or parent path

Throws:

IOException

CommitFailedException

execute

public void execute(NodeStore nodeStore,
                    boolean isReadWriteRepository,
                    long purgeThresholdMillis,
                    List<String> indexPaths,
                    boolean shouldPurgeBaseIndex)
             throws IOException,
                    CommitFailedException

Execute purging index based on the index version naming and last time index time

Parameters:

nodeStore - the node store

isReadWriteRepository - bool to indicate if it's read write repository, if yes, the purge index will not execute

purgeThresholdMillis - the threshold of time length since last time index time to determine, will purge if exceed that

indexPaths - the index path or parent path

shouldPurgeBaseIndex - If set to true, will apply purge operations on active base index i.e. DELETE or DELETE_HIDDEN_AND_DISABLE

Throws:

IOException

CommitFailedException

getPurgeIndexes

public List<IndexVersionOperation> getPurgeIndexes(NodeStore nodeStore,
                                                   long purgeThresholdMillis,
                                                   List<String> indexPaths,
                                                   boolean shouldPurgeBaseIndex)
                                            throws IOException,
                                                   CommitFailedException

Throws:

IOException

CommitFailedException

getPurgeIndexes

public List<IndexVersionOperation> getPurgeIndexes(NodeStore nodeStore,
                                                   long purgeThresholdMillis,
                                                   List<String> indexPaths)
                                            throws IOException,
                                                   CommitFailedException

Throws:

IOException

CommitFailedException

getIndexType

@NotNull
protected abstract @NotNull String getIndexType()

Returns:

IndexType served by the implementation like lucene or elasticsearch

postDeleteOp

protected abstract void postDeleteOp(String idxPath)

Parameters:

idxPath - - index path on which to perform post delete operations

preserveDetailsFromIndexDefForPostOp

protected abstract void preserveDetailsFromIndexDefForPostOp(NodeBuilder builder)

To preserve any required details from index def builder to be used in post op

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getIndexVersionOperationInstance

protected abstract IndexVersionOperation getIndexVersionOperationInstance(IndexName indexName)