com.atlassian.confluence.search

Interface ConfluenceIndexer

All Superinterfaces:

com.atlassian.bonnie.Indexer

All Known Implementing Classes:

QueuingConfluenceIndexer

public interface ConfluenceIndexer
extends com.atlassian.bonnie.Indexer

Method Summary

Modifier and Type	Method and Description
void	index(com.atlassian.bonnie.Searchable obj) Indexes the object without removing any existing copies from the index
void	indexIncludingDependents(com.atlassian.bonnie.Searchable searchable) Add a content object and all its dependents (attachments, comments, children, etc.) to the index
void	reIndex(com.atlassian.bonnie.Searchable obj) Updates an object in the index
void	reIndexExcludingDependents(com.atlassian.bonnie.Searchable obj) Updates just an object itself in the index, excluding any dependents (attachments, comments, children, etc.)
void	reindexUsersInGroup(String groupName) Optimised reindex of all indexed information relating to the given group
default ConfluenceIndexer	synchronous() Return synchronous indexer that will perform index in the caller thread.
void	unIndex(com.atlassian.bonnie.Searchable obj) Removes any existing copies of the object from the index
void	unIndexIncludingDependents(com.atlassian.bonnie.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

Method Detail

index

void index(com.atlassian.bonnie.Searchable obj)

Indexes the object without removing any existing copies from the index

Specified by:

index in interface com.atlassian.bonnie.Indexer

unIndex

void unIndex(com.atlassian.bonnie.Searchable obj)

Removes any existing copies of the object from the index

Specified by:

unIndex in interface com.atlassian.bonnie.Indexer

reIndex

void reIndex(com.atlassian.bonnie.Searchable obj)

Updates an object in the index

Specified by:

reIndex in interface com.atlassian.bonnie.Indexer

reIndexExcludingDependents

void reIndexExcludingDependents(com.atlassian.bonnie.Searchable obj)

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

Since:

6.13.0

unIndexSpace

void unIndexSpace(Space space)

Optimised unindex of all content in a space

reindexUsersInGroup

void reindexUsersInGroup(String groupName)

Optimised reindex of all indexed information relating to the given group

Parameters:

groupName - the group to reindex

unIndexIncludingDependents

void unIndexIncludingDependents(com.atlassian.bonnie.Searchable searchable)

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

indexIncludingDependents

void indexIncludingDependents(com.atlassian.bonnie.Searchable searchable)

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

synchronous

default ConfluenceIndexer synchronous()

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