Package com.atlassian.confluence.search
Interface ConfluenceIndexer
-
- All Superinterfaces:
Indexer
- All Known Implementing Classes:
QueuingConfluenceIndexer
public interface ConfluenceIndexer extends Indexer
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
index(Searchable obj)
Indexes the object without removing any existing copies from the indexvoid
indexIncludingDependents(Searchable searchable)
Add a content object and all its dependents (attachments, comments, children, etc.) to the indexvoid
reIndex(Searchable obj)
Updates an object in the indexvoid
reIndexExcludingDependents(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 groupdefault ConfluenceIndexer
synchronous()
Return synchronous indexer that will perform index in the caller thread.void
unIndex(Searchable obj)
Removes any existing copies of the object from the indexvoid
unIndexIncludingDependents(Searchable searchable)
Remove a content object and all its dependents (attachments, comments, children, etc.) from the indexvoid
unIndexSpace(Space space)
Optimised unindex of all content in a space
-
-
-
Method Detail
-
index
void index(Searchable obj)
Indexes the object without removing any existing copies from the index
-
unIndex
void unIndex(Searchable obj)
Removes any existing copies of the object from the index
-
reIndex
void reIndex(Searchable obj)
Updates an object in the index
-
reIndexExcludingDependents
void reIndexExcludingDependents(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(Searchable searchable)
Remove a content object and all its dependents (attachments, comments, children, etc.) from the index
-
indexIncludingDependents
void indexIncludingDependents(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.
-
-