Package com.atlassian.confluence.internal.search

Class QueuingConfluenceIndexer

java.lang.Object

com.atlassian.confluence.internal.search.QueuingConfluenceIndexer

All Implemented Interfaces:

Indexer, ConfluenceIndexer

@LuceneIndependent
@Internal
public class QueuingConfluenceIndexer
extends Object
implements ConfluenceIndexer

Constructor Summary

Constructors

Constructor	Description
QueuingConfluenceIndexer()

Method Summary

Modifier and Type	Method	Description
void	index(Searchable searchable)	Indexes the object without removing any existing copies from the index
void	indexIncludingDependents(Searchable searchable)	Add a content object and all its dependents (attachments, comments, children, etc.) to the index
void	reIndex(Searchable searchable)	Updates an object in the index
void	reIndexExcludingDependents(Searchable searchable)	Updates just an object itself in the index, excluding any dependents (attachments, comments, children, etc.)
void	reIndexExcludingDependentsAndChangeIndex(Searchable searchable)	Updates just an object itself in the Content index, excluding any dependents (attachments, comments, children, etc.)
void	reIndexPermissions(Searchable obj)	Add a content object and all its dependents (attachments, comments, children, etc.) to the index, but (in place) update only the permissions in the index document.
void	reindexUsersInGroup(String groupName)	Optimised reindex of all indexed information relating to the given group
void	setAsyncIndexer(Supplier<ConfluenceIndexer> asyncIndexer)
void	setChangeIndexer(ChangeIndexer changeIndexer)
void	setIndexerControl(IndexerControl indexerControl)
void	setIndexTaskFactory(IndexTaskFactoryInternal indexTaskFactory)
void	setSearchableResolver(SearchableResolver searchableResolver)
void	setSearchIndexAccessor(SearchIndexAccessor searchIndexAccessor)
void	setTaskQueue(IndexTaskQueue<ConfluenceIndexTask> taskQueue)
ConfluenceIndexer	synchronous()	Return synchronous indexer that will perform index in the caller thread.
void	unIndex(Searchable searchable)	Removes any existing copies of the object from the index
void	unIndexIncludingDependents(Searchable searchable)	Remove a content object and all its dependents (attachments, comments, children, etc.) from the index
void	unIndexSpace(Space space)	Optimised unindex of all content in a space

Methods inherited from class java.lang.Object

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

Constructor Details

QueuingConfluenceIndexer

public QueuingConfluenceIndexer()

Method Details

index

public void index(Searchable searchable)

Description copied from interface: ConfluenceIndexer

Indexes the object without removing any existing copies from the index

Specified by:

index in interface ConfluenceIndexer

Specified by:

index in interface Indexer

unIndex

public void unIndex(Searchable searchable)

Description copied from interface: ConfluenceIndexer

Removes any existing copies of the object from the index

Specified by:

unIndex in interface ConfluenceIndexer

Specified by:

unIndex in interface Indexer

reIndex

public void reIndex(Searchable searchable)

Description copied from interface: ConfluenceIndexer

Updates an object in the index

Specified by:

reIndex in interface ConfluenceIndexer

Specified by:

reIndex in interface Indexer

reIndexExcludingDependents

public void reIndexExcludingDependents(Searchable searchable)

Description copied from interface: ConfluenceIndexer

Updates just an object itself in the index, excluding any dependents (attachments, comments, children, etc.)

Specified by:

reIndexExcludingDependents in interface ConfluenceIndexer

reIndexExcludingDependentsAndChangeIndex

public void reIndexExcludingDependentsAndChangeIndex(Searchable searchable)

Description copied from interface: ConfluenceIndexer

Updates just an object itself in the Content index, excluding any dependents (attachments, comments, children, etc.)

Specified by:

reIndexExcludingDependentsAndChangeIndex in interface ConfluenceIndexer

unIndexSpace

public void unIndexSpace(Space space)

Description copied from interface: ConfluenceIndexer

Optimised unindex of all content in a space

Specified by:

unIndexSpace in interface ConfluenceIndexer

reindexUsersInGroup

public void reindexUsersInGroup(String groupName)

Description copied from interface: ConfluenceIndexer

Optimised reindex of all indexed information relating to the given group

Specified by:

reindexUsersInGroup in interface ConfluenceIndexer

Parameters:

groupName - the group to reindex

unIndexIncludingDependents

public void unIndexIncludingDependents(Searchable searchable)

Description copied from interface: ConfluenceIndexer

Remove a content object and all its dependents (attachments, comments, children, etc.) from the index

Specified by:

unIndexIncludingDependents in interface ConfluenceIndexer

indexIncludingDependents

public void indexIncludingDependents(Searchable searchable)

Description copied from interface: ConfluenceIndexer

Add a content object and all its dependents (attachments, comments, children, etc.) to the index

Specified by:

indexIncludingDependents in interface ConfluenceIndexer

reIndexPermissions

public void reIndexPermissions(Searchable obj)

Description copied from interface: ConfluenceIndexer

Add a content object and all its dependents (attachments, comments, children, etc.) to the index, but (in place) update only the permissions in the index document. OpenSearch Only. DO NOT USE for Lucene.

Specified by:

reIndexPermissions in interface ConfluenceIndexer

Parameters:

obj - The content to be reindexed for permissions

synchronous

public ConfluenceIndexer synchronous()

Description copied from interface: ConfluenceIndexer

Return synchronous indexer that will perform index in the caller thread.

Specified by:

synchronous in interface ConfluenceIndexer

setAsyncIndexer

public void setAsyncIndexer(Supplier<ConfluenceIndexer> asyncIndexer)

setTaskQueue

public void setTaskQueue(IndexTaskQueue<ConfluenceIndexTask> taskQueue)

setIndexTaskFactory

public void setIndexTaskFactory(IndexTaskFactoryInternal indexTaskFactory)

setSearchableResolver

public void setSearchableResolver(SearchableResolver searchableResolver)

setIndexerControl

public void setIndexerControl(IndexerControl indexerControl)

setChangeIndexer

public void setChangeIndexer(ChangeIndexer changeIndexer)

setSearchIndexAccessor

public void setSearchIndexAccessor(SearchIndexAccessor searchIndexAccessor)