Package com.atlassian.confluence.internal.search.tasks

Class RebuildChangeDocumentsIndexTask

java.lang.Object

com.atlassian.confluence.internal.search.tasks.RebuildChangeDocumentsIndexTask

All Implemented Interfaces:

ConfluenceIndexTask, ConvertibleToJournalEntry, HandleAware, IndexTask

@LuceneIndependent
@Internal
public class RebuildChangeDocumentsIndexTask
extends Object
implements ConfluenceIndexTask, HandleAware

Responsible for rebuilding all change document(s) for a searchable (removing change documents for all versions of the searchable and then adding them back).

Constructor Summary

Constructors

Constructor	Description
RebuildChangeDocumentsIndexTask(Searchable searchable, ContentEntityObjectDaoInternal contentEntityObjectDao, IndexTaskFactoryInternal indexTaskFactory, HibernateSessionManager5 hibernateSessionManager, boolean skipDeletes)	Constructs a rebuild change document index task.

Method Summary

Modifier and Type	Method	Description
Optional<JournalEntry>	convertToJournalEntry(JournalIdentifier journalId)	Convert to journal entry.
boolean	equals(Object obj)
String	getDescription()	A description of the task that can be presented to the user via the UI.
Handle	getHandle()
SearchIndex	getSearchIndex()
int	hashCode()
void	perform(SearchIndexWriter writer)	Executes this task against a document writer.

Methods inherited from class java.lang.Object

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

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

isRetryable

Constructor Details

RebuildChangeDocumentsIndexTask

public RebuildChangeDocumentsIndexTask(Searchable searchable,
 ContentEntityObjectDaoInternal contentEntityObjectDao,
 IndexTaskFactoryInternal indexTaskFactory,
 HibernateSessionManager5 hibernateSessionManager,
 boolean skipDeletes)

Constructs a rebuild change document index task.

Parameters:

skipDeletes - flag to skip any deletions performed. Used during reindexing when deletion occurs at the start.

Throws:

IllegalArgumentException - if searchable is null, fails ChangeDocumentIndexPolicy.buildFor(Searchable) or is not the latest version.

Method Details

getHandle

public Handle getHandle()

Specified by:

getHandle in interface HandleAware

Returns:

the handle

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.

perform

public void perform(SearchIndexWriter writer)
             throws IOException

Description copied from interface: ConfluenceIndexTask

Executes this task against a document writer.

Specified by:

perform in interface ConfluenceIndexTask

Throws:

IOException

convertToJournalEntry

public Optional<JournalEntry> convertToJournalEntry(JournalIdentifier journalId)

Description copied from interface: ConvertibleToJournalEntry

Convert to journal entry.

Specified by:

convertToJournalEntry in interface ConvertibleToJournalEntry

Parameters:

journalId - journal identifier

Returns:

an optional containing a journal entry or empty if this cannot be converted.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getSearchIndex

public SearchIndex getSearchIndex()

Specified by:

getSearchIndex in interface ConfluenceIndexTask

Returns:

the SearchIndex that the task should write to