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

Class DefaultIndexTaskFactory

java.lang.Object

com.atlassian.confluence.internal.search.tasks.DefaultIndexTaskFactory

All Implemented Interfaces:

IndexTaskFactoryInternal, IndexTaskFactory

@LuceneIndependent
@Internal
public class DefaultIndexTaskFactory
extends Object
implements IndexTaskFactoryInternal

Creates index tasks and provides conversion into queue entries for implementations of IndexTaskQueue

Constructor Summary

Constructors

Constructor

Description

DefaultIndexTaskFactory(BatchOperationManager batchOperationManager, AtlassianDocumentBuilder<Searchable> documentBuilder, AtlassianDocumentBuilder<Searchable> changeDocumentBuilder, AtlassianDocumentBuilder<Searchable> selectiveFieldsDocumentBuilder, ContentEntityObjectDaoInternal contentEntityObjectDao, PersonalInformationManager personalInformationManager, UserAccessor userAccessor, PersonalInformationDao personalInformationDao, SpaceDao spaceDao, PageManagerInternal pageManager, HibernateSessionManager5 hibernateSessionManager, com.atlassian.config.internal.ApplicationConfig applicationConfig, SearchableResolver searchableResolver)

Method Summary

Modifier and Type	Method	Description
ConfluenceIndexTask	createAddChangeDocumentTask(Searchable searchable)	Constructs an add change document task.
ConfluenceIndexTask	createAddChangeDocumentTask(Searchable searchable, PrefetchAtlassianDocumentRetriever documentRetriever)
ConfluenceIndexTask	createAddDocumentTask(Searchable searchable)	NOTE: Do not call this method without first calling createDeleteDocumentTask(Searchable) for the same object.
ConfluenceIndexTask	createAddDocumentTask(Searchable searchable, PrefetchAtlassianDocumentRetriever documentRetriever)
ContentIndexTask	createContentIndexTask(List<ContentType> contentTypes, List<ContentStatus> contentStatuses, JournalEntryType journalEntryType)
ConfluenceIndexTask	createDeleteChangeDocumentsIndexTask(Searchable searchable)
ConfluenceIndexTask	createDeleteChangeDocumentsIndexTask(String handle)
ConfluenceIndexTask	createDeleteDocumentTask(Searchable searchable)
ConfluenceIndexTask	createDeleteDocumentTask(String handle)
ContentIndexTask	createIndexDraftsTask()
ConfluenceIndexTask	createRebuildChangeDocumentsIndexTask(Searchable searchable)
ReindexAllBlogsChangeIndexTask	createReindexAllBlogsChangeTask()
ReindexAllBlogsContentIndexTask	createReindexAllBlogsContentTask()
ReindexAllSpacesChangeIndexTask	createReindexAllSpacesChangeTask()
ReindexAllSpacesContentIndexTask	createReindexAllSpacesContentTask()
ReindexAllUsersChangeIndexTask	createReindexAllUsersChangeTask()
ReindexAllUsersContentIndexTask	createReindexAllUsersContentTask()
ConfluenceIndexTask	createReIndexPermissionsTask(Searchable searchable)	Creates a task to re-index permissions only for the given content.
ReindexUsersInGroupChangeIndexTask	createReindexUsersInGroupChangeTask(String groupName)
ReindexUsersInGroupContentIndexTask	createReindexUsersInGroupContentTask(String groupName)
UnindexContentTypeChangeIndexTask	createUnindexContentTypeChangeTask(String contentType)
UnindexContentTypeContentIndexTask	createUnindexContentTypeContentTask(String contentType)
UnIndexSpaceChangeIndexTask	createUnIndexSpaceChangeIndexTask(Space space)
UnIndexSpaceChangeIndexTask	createUnIndexSpaceChangeIndexTask(String handle)
UnIndexSpaceContentIndexTask	createUnIndexSpaceContentIndexTask(Space space)
UnIndexSpaceContentIndexTask	createUnIndexSpaceContentIndexTask(String handle)
ConfluenceIndexTask	createUpdateDocumentTask(Searchable searchable)	Returns an update document task.
ConfluenceIndexTask	createUpdateDocumentTask(Searchable searchable, boolean includeDependents)
ConfluenceIndexTask	createUpdateDocumentTask(Searchable searchable, PrefetchAtlassianDocumentRetriever documentRetriever)
ConfluenceIndexTask	createUpdateDocumentTask(Searchable searchable, PrefetchAtlassianDocumentRetriever documentRetriever, boolean includeDependents)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultIndexTaskFactory

public DefaultIndexTaskFactory(BatchOperationManager batchOperationManager,
 AtlassianDocumentBuilder<Searchable> documentBuilder,
 AtlassianDocumentBuilder<Searchable> changeDocumentBuilder,
 AtlassianDocumentBuilder<Searchable> selectiveFieldsDocumentBuilder,
 ContentEntityObjectDaoInternal contentEntityObjectDao,
 PersonalInformationManager personalInformationManager,
 UserAccessor userAccessor,
 PersonalInformationDao personalInformationDao,
 SpaceDao spaceDao,
 PageManagerInternal pageManager,
 HibernateSessionManager5 hibernateSessionManager,
 com.atlassian.config.internal.ApplicationConfig applicationConfig,
 SearchableResolver searchableResolver)

Since:

8.0

Method Details

createContentIndexTask

public ContentIndexTask createContentIndexTask(List<ContentType> contentTypes,
 List<ContentStatus> contentStatuses,
 JournalEntryType journalEntryType)

Specified by:

createContentIndexTask in interface IndexTaskFactoryInternal

createIndexDraftsTask

public ContentIndexTask createIndexDraftsTask()

Specified by:

createIndexDraftsTask in interface IndexTaskFactoryInternal

createUnIndexSpaceContentIndexTask

public UnIndexSpaceContentIndexTask createUnIndexSpaceContentIndexTask(String handle)

Specified by:

createUnIndexSpaceContentIndexTask in interface IndexTaskFactoryInternal

Parameters:

handle - space key

createUnIndexSpaceContentIndexTask

public UnIndexSpaceContentIndexTask createUnIndexSpaceContentIndexTask(Space space)

Specified by:

createUnIndexSpaceContentIndexTask in interface IndexTaskFactoryInternal

createUnIndexSpaceChangeIndexTask

public UnIndexSpaceChangeIndexTask createUnIndexSpaceChangeIndexTask(String handle)

Specified by:

createUnIndexSpaceChangeIndexTask in interface IndexTaskFactoryInternal

createUnIndexSpaceChangeIndexTask

public UnIndexSpaceChangeIndexTask createUnIndexSpaceChangeIndexTask(Space space)

Specified by:

createUnIndexSpaceChangeIndexTask in interface IndexTaskFactoryInternal

createUnindexContentTypeContentTask

public UnindexContentTypeContentIndexTask createUnindexContentTypeContentTask(String contentType)

Specified by:

createUnindexContentTypeContentTask in interface IndexTaskFactoryInternal

createUnindexContentTypeChangeTask

public UnindexContentTypeChangeIndexTask createUnindexContentTypeChangeTask(String contentType)

Specified by:

createUnindexContentTypeChangeTask in interface IndexTaskFactoryInternal

createReindexAllUsersContentTask

public ReindexAllUsersContentIndexTask createReindexAllUsersContentTask()

Specified by:

createReindexAllUsersContentTask in interface IndexTaskFactoryInternal

createReindexAllUsersChangeTask

public ReindexAllUsersChangeIndexTask createReindexAllUsersChangeTask()

Specified by:

createReindexAllUsersChangeTask in interface IndexTaskFactoryInternal

createReindexAllBlogsContentTask

public ReindexAllBlogsContentIndexTask createReindexAllBlogsContentTask()

Specified by:

createReindexAllBlogsContentTask in interface IndexTaskFactoryInternal

createReindexAllBlogsChangeTask

public ReindexAllBlogsChangeIndexTask createReindexAllBlogsChangeTask()

Specified by:

createReindexAllBlogsChangeTask in interface IndexTaskFactoryInternal

createReindexUsersInGroupContentTask

public ReindexUsersInGroupContentIndexTask createReindexUsersInGroupContentTask(String groupName)

Specified by:

createReindexUsersInGroupContentTask in interface IndexTaskFactoryInternal

createReindexUsersInGroupChangeTask

public ReindexUsersInGroupChangeIndexTask createReindexUsersInGroupChangeTask(String groupName)

Specified by:

createReindexUsersInGroupChangeTask in interface IndexTaskFactoryInternal

createDeleteDocumentTask

public ConfluenceIndexTask createDeleteDocumentTask(Searchable searchable)

Specified by:

createDeleteDocumentTask in interface IndexTaskFactory

createDeleteDocumentTask

public ConfluenceIndexTask createDeleteDocumentTask(String handle)

Specified by:

createDeleteDocumentTask in interface IndexTaskFactory

createUpdateDocumentTask

public ConfluenceIndexTask createUpdateDocumentTask(Searchable searchable)

Returns an update document task.

Specified by:

createUpdateDocumentTask in interface IndexTaskFactory

Parameters:

searchable - the searchable

Returns:

an update document task or null if searchable is null or not indexable

createUpdateDocumentTask

public ConfluenceIndexTask createUpdateDocumentTask(Searchable searchable,
 boolean includeDependents)

Specified by:

createUpdateDocumentTask in interface IndexTaskFactory

createUpdateDocumentTask

public ConfluenceIndexTask createUpdateDocumentTask(Searchable searchable,
 PrefetchAtlassianDocumentRetriever documentRetriever)

Specified by:

createUpdateDocumentTask in interface IndexTaskFactoryInternal

createUpdateDocumentTask

public ConfluenceIndexTask createUpdateDocumentTask(Searchable searchable,
 PrefetchAtlassianDocumentRetriever documentRetriever,
 boolean includeDependents)

Specified by:

createUpdateDocumentTask in interface IndexTaskFactoryInternal

createAddDocumentTask

public ConfluenceIndexTask createAddDocumentTask(Searchable searchable)

NOTE: Do not call this method without first calling createDeleteDocumentTask(Searchable) for the same object. The index flushing strategy is intentionally inaccurate and relies on an in-memory 'flushed entries' cache to prevent the same object being flushed twice, which risks duplicate entries being created in the index immediately after the application is restarted. CONF-29072 has additional details.

You probably want to use createUpdateDocumentTask(Searchable) instead - the delete operation will fail silently :)

Specified by:

createAddDocumentTask in interface IndexTaskFactory

Parameters:

searchable - the searchable

Returns:

an add document task or null if searchable is null or not indexable

createAddDocumentTask

public ConfluenceIndexTask createAddDocumentTask(Searchable searchable,
 PrefetchAtlassianDocumentRetriever documentRetriever)

Specified by:

createAddDocumentTask in interface IndexTaskFactoryInternal

createDeleteChangeDocumentsIndexTask

public ConfluenceIndexTask createDeleteChangeDocumentsIndexTask(Searchable searchable)

Specified by:

createDeleteChangeDocumentsIndexTask in interface IndexTaskFactory

Parameters:

searchable - the searchable

Returns:

an index task to remove the change documents for this searchable, or a no op task otherwise.

createDeleteChangeDocumentsIndexTask

public ConfluenceIndexTask createDeleteChangeDocumentsIndexTask(String handle)

Specified by:

createDeleteChangeDocumentsIndexTask in interface IndexTaskFactory

Parameters:

handle - handle to the latest version

Returns:

delete index task

createRebuildChangeDocumentsIndexTask

public ConfluenceIndexTask createRebuildChangeDocumentsIndexTask(Searchable searchable)

Specified by:

createRebuildChangeDocumentsIndexTask in interface IndexTaskFactory

createAddChangeDocumentTask

public ConfluenceIndexTask createAddChangeDocumentTask(Searchable searchable)

Constructs an add change document task.

Specified by:

createAddChangeDocumentTask in interface IndexTaskFactory

Parameters:

searchable - the searchable

Returns:

an add change document task or NoOpIndexTask if searchable is null

createAddChangeDocumentTask

public ConfluenceIndexTask createAddChangeDocumentTask(Searchable searchable,
 PrefetchAtlassianDocumentRetriever documentRetriever)

Specified by:

createAddChangeDocumentTask in interface IndexTaskFactoryInternal

createReIndexPermissionsTask

public ConfluenceIndexTask createReIndexPermissionsTask(Searchable searchable)

Description copied from interface: IndexTaskFactoryInternal

Creates a task to re-index permissions only for the given content. OpenSearch Only. DO NOT USE for Lucene.

Specified by:

createReIndexPermissionsTask in interface IndexTaskFactoryInternal

Parameters:

searchable - The content for which the task is to be created.

createReindexAllSpacesContentTask

public ReindexAllSpacesContentIndexTask createReindexAllSpacesContentTask()

Specified by:

createReindexAllSpacesContentTask in interface IndexTaskFactoryInternal

createReindexAllSpacesChangeTask

public ReindexAllSpacesChangeIndexTask createReindexAllSpacesChangeTask()

Specified by:

createReindexAllSpacesChangeTask in interface IndexTaskFactoryInternal