com.atlassian.confluence.search.lucene.tasks

Class ReindexUsersInGroupIndexTask

java.lang.Object

com.atlassian.confluence.search.lucene.tasks.ReindexUsersInGroupIndexTask

All Implemented Interfaces:

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

public class ReindexUsersInGroupIndexTask
extends Object
implements ConfluenceIndexTask, HandleAware

Updates all personal information and associated user entries in the index for a particular group.

Since:

5.9

Constructor Summary

Constructors

Constructor and Description
ReindexUsersInGroupIndexTask(BatchOperationManager batchOperationManager, PersonalInformationManager personalInformationManager, UserAccessor userAccessor, IndexTaskFactory indexTaskFactory, String groupName)

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.
com.atlassian.bonnie.Handle	getHandle()
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

ReindexUsersInGroupIndexTask

public ReindexUsersInGroupIndexTask(BatchOperationManager batchOperationManager,
                                    PersonalInformationManager personalInformationManager,
                                    UserAccessor userAccessor,
                                    IndexTaskFactory indexTaskFactory,
                                    String groupName)

Method Detail

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(org.apache.lucene.index.IndexWriter writer)
             throws IOException

Specified by:

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

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.

getHandle

public com.atlassian.bonnie.Handle getHandle()

Specified by:

getHandle in interface HandleAware

Returns:

the handle