com.atlassian.confluence.search.lucene.tasks

Interface ConfluenceIndexTask

All Superinterfaces:

ConvertibleToJournalEntry, com.atlassian.bonnie.ILuceneConnection.WriterAction, IndexTask

All Known Implementing Classes:

AddChangeDocumentIndexTask, AddDocumentIndexTask, ContentIndexTask, DeleteChangeDocumentsIndexTask, DeleteDocumentIndexTask, NoOpIndexTask, RebuildChangeDocumentsIndexTask, ReindexAllBlogsChangeIndexTask, ReindexAllBlogsContentIndexTask, ReindexAllSpacesChangeIndexTask, ReindexAllSpacesContentIndexTask, ReindexAllUsersChangeIndexTask, ReindexAllUsersContentIndexTask, ReindexUsersInGroupChangeIndexTask, ReindexUsersInGroupContentIndexTask, UnindexContentTypeChangeIndexTask, UnindexContentTypeContentIndexTask, UnIndexSpaceChangeIndexTask, UnIndexSpaceContentIndexTask, UpdateDocumentIndexTask

@Internal
public interface ConfluenceIndexTask
extends IndexTask, com.atlassian.bonnie.ILuceneConnection.WriterAction, ConvertibleToJournalEntry

An index task that will perform writing to the index.

Method Summary

Modifier and Type	Method and Description
SearchIndex	getSearchIndex()
default Map<SearchIndex,SearchIndexAccessor>	getSearchIndexAccessor() Temporary method used by perform(IndexWriter)to maintain back compatibility with CQ.
default void	perform(org.apache.lucene.index.IndexWriter indexWriter)
void	perform(SearchIndexWriter searchIndexWriter) Executes this task against a document writer.

Methods inherited from interface com.atlassian.confluence.search.IndexTask

getDescription

Methods inherited from interface com.atlassian.confluence.search.ConvertibleToJournalEntry

convertToJournalEntry

Method Detail

getSearchIndex

SearchIndex getSearchIndex()

Returns:

the SearchIndex that the task should write to

Since:

7.9.0

perform

void perform(SearchIndexWriter searchIndexWriter)
      throws IOException

Executes this task against a document writer.

Throws:

IOException

Since:

7.14

getSearchIndexAccessor

@Internal
default Map<SearchIndex,SearchIndexAccessor> getSearchIndexAccessor()

Temporary method used by perform(IndexWriter)to maintain back compatibility with CQ. It will be removed along with ILuceneConnection.WriterAction once CQ is migrated to be independent from Lucene.

perform

default void perform(org.apache.lucene.index.IndexWriter indexWriter)
              throws IOException

Specified by:

perform in interface com.atlassian.bonnie.ILuceneConnection.WriterAction

Throws:

IOException