com.atlassian.confluence.search.lucene.tasks

Class ReindexUsersInGroupContentIndexTask

java.lang.Object

com.atlassian.confluence.search.lucene.tasks.ReindexUsersInGroupContentIndexTask

All Implemented Interfaces:

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

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

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

Since:

7.9.0

Constructor Summary

Constructors

Constructor and Description
ReindexUsersInGroupContentIndexTask(BatchOperationManager batchOperationManager, PersonalInformationManager personalInformationManager, GroupResolver groupResolver, GroupMembershipAccessor groupMembershipAccessor, IndexTaskFactory indexTaskFactory, String groupName)
ReindexUsersInGroupContentIndexTask(BatchOperationManager batchOperationManager, PersonalInformationManager personalInformationManager, UserAccessor userAccessor, IndexTaskFactory indexTaskFactory, String groupName) Deprecated. since 7.17

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()
SearchIndex	getSearchIndex()
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

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

getSearchIndexAccessor, perform

Constructor Detail

ReindexUsersInGroupContentIndexTask

public ReindexUsersInGroupContentIndexTask(BatchOperationManager batchOperationManager,
                                           PersonalInformationManager personalInformationManager,
                                           GroupResolver groupResolver,
                                           GroupMembershipAccessor groupMembershipAccessor,
                                           IndexTaskFactory indexTaskFactory,
                                           String groupName)

Since:

7.17

ReindexUsersInGroupContentIndexTask

@Deprecated
public ReindexUsersInGroupContentIndexTask(BatchOperationManager batchOperationManager,
                                                       PersonalInformationManager personalInformationManager,
                                                       UserAccessor userAccessor,
                                                       IndexTaskFactory indexTaskFactory,
                                                       String groupName)

Deprecated. since 7.17

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(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.

getHandle

public com.atlassian.bonnie.Handle getHandle()

Specified by:

getHandle in interface HandleAware

Returns:

the handle

getSearchIndex

public SearchIndex getSearchIndex()

Specified by:

getSearchIndex in interface ConfluenceIndexTask

Returns:

the SearchIndex that the task should write to