com.atlassian.confluence.api.model.index

Interface IndexRecoverer

All Known Implementing Classes:

EdgeIndexRecoverer, MainIndexRecoverer

@PublicSpi
 @ParametersAreNonnullByDefault
public interface IndexRecoverer

Provides lucene index operations to be used when trying to recover an out of date or invalid index

Since:

5.8

Method Summary

Modifier and Type	Method and Description
void	reindex() Trigger a reindex
void	reset(Runnable replaceIndex) Closes the reader and the writer and create new ones.
void	snapshot(File destDir) Allows taking a snapshot of the index.

Method Detail

snapshot

void snapshot(File destDir)
       throws IOException

Allows taking a snapshot of the index.

The snapshot should be taken in a safe way to prevent any write while it is copying index files over to the destination directory. Suggestions include to use LuceneConnection#snapshot(Directory) method or alternatively to take the snapshot with SnapshotDeletionPolicy.

Parameters:

destDir - directory in which the snapshot should be saved

Throws:

IOException

reset

void reset(Runnable replaceIndex)

Closes the reader and the writer and create new ones.

Parameters:

replaceIndex - method that should be executed before the index has been closed and before the index has been reopened

reindex

void reindex()

Trigger a reindex