Package com.atlassian.confluence.plugins.edgeindex.tasks

Class RebuildIndexTask

java.lang.Object

com.atlassian.confluence.plugins.edgeindex.tasks.RebuildIndexTask

All Implemented Interfaces:

EdgeIndexTask, ConfluenceIndexTask, ConvertibleToJournalEntry, IndexTask

public class RebuildIndexTask
extends Object
implements EdgeIndexTask

Task to rebuild the edge index

Since:

8.8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RebuildIndexTask.RebuildIndexParams

Constructor Summary

Constructors

Constructor	Description
RebuildIndexTask(EdgeIndexTaskFactory edgeIndexTaskFactory, EdgeReindexer edgeReindexer, EdgeSearchIndexAccessor edgeSearchIndexAccessor, RebuildIndexTask.RebuildIndexParams rebuildIndexParams)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	A description of the task that can be presented to the user via the UI.
SearchIndex	getSearchIndex()
void	perform(SearchIndexWriter searchIndexWriter)	Executes this task against a document writer.

Methods inherited from class java.lang.Object

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

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

isRetryable

Methods inherited from interface com.atlassian.confluence.plugins.edgeindex.EdgeIndexTask

convertToJournalEntry

Constructor Details

RebuildIndexTask

public RebuildIndexTask(EdgeIndexTaskFactory edgeIndexTaskFactory,
 EdgeReindexer edgeReindexer,
 EdgeSearchIndexAccessor edgeSearchIndexAccessor,
 RebuildIndexTask.RebuildIndexParams rebuildIndexParams)

Method Details

getSearchIndex

public SearchIndex getSearchIndex()

Specified by:

getSearchIndex in interface ConfluenceIndexTask

Returns:

the SearchIndex that the task should write to

perform

public void perform(SearchIndexWriter searchIndexWriter)
             throws IOException

Description copied from interface: ConfluenceIndexTask

Executes this task against a document writer.

Specified by:

perform in interface ConfluenceIndexTask

Throws:

IOException

getDescription

public String getDescription()

Description copied from interface: IndexTask

A description of the task that can be presented to the user via the UI.

Specified by:

getDescription in interface IndexTask

Returns:

an readable message.