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

Class ContentIndexTask

java.lang.Object

com.atlassian.confluence.internal.search.tasks.ContentIndexTask

All Implemented Interfaces:

ConfluenceIndexTask, ConvertibleToJournalEntry, IndexTask

@LuceneIndependent
@Internal
public class ContentIndexTask
extends Object
implements ConfluenceIndexTask

Since:

6.4.0

Constructor Summary

Constructors

Constructor	Description
ContentIndexTask(List<ContentType> contentTypes, List<ContentStatus> contentStatuses, JournalEntryType journalEntryType, PageManagerInternal pageManagerInternal, BatchOperationManager batchOperationManager, IndexTaskFactoryInternal indexTaskFactory)

Method Summary

Modifier and Type	Method	Description
final Optional<JournalEntry>	convertToJournalEntry(JournalIdentifier journalId)	Convert to journal entry.
final String	getDescription()	A description of the task that can be presented to the user via the UI.
SearchIndex	getSearchIndex()
boolean	isRetryable()
final void	perform(SearchIndexWriter writer)	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

Constructor Details

ContentIndexTask

public ContentIndexTask(List<ContentType> contentTypes,
 List<ContentStatus> contentStatuses,
 JournalEntryType journalEntryType,
 PageManagerInternal pageManagerInternal,
 BatchOperationManager batchOperationManager,
 IndexTaskFactoryInternal indexTaskFactory)

Method Details

perform

public final 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

isRetryable

public boolean isRetryable()

Specified by:

isRetryable in interface ConfluenceIndexTask

Returns:

true if this task is retryable in journal queue, false otherwise.

getDescription

public final 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.

convertToJournalEntry

public final 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.

getSearchIndex

public SearchIndex getSearchIndex()

Specified by:

getSearchIndex in interface ConfluenceIndexTask

Returns:

the SearchIndex that the task should write to