com.atlassian.confluence.search.lucene.tasks

Class ContentIndexTask

java.lang.Object

com.atlassian.confluence.search.lucene.tasks.ContentIndexTask

All Implemented Interfaces:

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

public class ContentIndexTask
extends Object
implements ConfluenceIndexTask

Since:

6.4.0

Constructor Summary

Constructors

Constructor and Description
ContentIndexTask(List<ContentType> contentTypes, List<ContentStatus> contentStatuses, JournalEntryType journalEntryType, PageDaoInternal pageDao, BatchOperationManager batchOperationManager, IndexTaskFactory indexTaskFactory)

Method Summary

Modifier and Type	Method and Description
Optional<JournalEntry>	convertToJournalEntry(JournalIdentifier journalId) Convert to journal entry.
String	getDescription() A description of the task that can be presented to the user via the UI.
SearchIndex	getSearchIndex()
void	perform(org.apache.lucene.index.IndexWriter writer)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentIndexTask

public ContentIndexTask(List<ContentType> contentTypes,
                        List<ContentStatus> contentStatuses,
                        JournalEntryType journalEntryType,
                        PageDaoInternal pageDao,
                        BatchOperationManager batchOperationManager,
                        IndexTaskFactory indexTaskFactory)

Method Detail

perform

public final void perform(org.apache.lucene.index.IndexWriter writer)
                   throws IOException

Specified by:

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

Throws:

IOException

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