com.atlassian.confluence.api.service.index

Interface IndexRecoveryService

All Known Implementing Classes:

DefaultIndexRecoveryService

public interface IndexRecoveryService

This service will support the recovery of a Lucene index.

Since:

5.8

Method Summary

Modifier and Type	Method and Description
boolean	isIndexRecoveryRequired(JournalIdentifier journalId, String indexDirName) Checks to see whether the index needs to be recovered.
boolean	recoverIndex(JournalIdentifier journalId, String indexDirName) Recovers the index required by asking other nodes in the cluster for a snapshot of their index and copying it to its local home directory.

Method Detail

isIndexRecoveryRequired

boolean isIndexRecoveryRequired(JournalIdentifier journalId,
                                String indexDirName)

Checks to see whether the index needs to be recovered. This will be true if the index folder does not exist, or, if the index is copied over from a live system and is invalid, or, if the journal has been purged past where the node is currently processing, Note, this will always return false if the instance is not clustered.

Parameters:

journalId - the index to check whether it needs to be recovered

indexDirName - the name of the subdirectory containing the Lucene index

recoverIndex

boolean recoverIndex(JournalIdentifier journalId,
                     String indexDirName)

Recovers the index required by asking other nodes in the cluster for a snapshot of their index and copying it to its local home directory. This will overwrite the local index files if it already exists.

Parameters:

journalId - the index to recover

indexDirName - the name of the subdirectory containing the Lucene index

Returns:

true if index recovery has been requested, false otherwise.