Package com.atlassian.confluence.search

Interface ConfluenceIndexer

All Superinterfaces:
Indexer
All Known Implementing Classes:
QueuingConfluenceIndexer
public interface ConfluenceIndexer extends Indexer

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    index(Searchable obj)
    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 obj)
    Updates an object in the index
    void
    reIndexExcludingDependents(Searchable obj)
    Updates just an object itself in the index, excluding any dependents (attachments, comments, children, etc.)
    void
    reIndexExcludingDependentsAndChangeIndex(Searchable obj)
    Updates just an object itself in the Content index, excluding any dependents (attachments, comments, children, etc.)
    void
    reIndexPermissions(Searchable searchable)
    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
    default 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 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

  • Method Details

    • index

      void index(Searchable obj)
      Indexes the object without removing any existing copies from the index
      Specified by:
      index in interface Indexer

    • unIndex

      void unIndex(Searchable obj)
      Removes any existing copies of the object from the index
      Specified by:
      unIndex in interface Indexer

    • reIndex

      void reIndex(Searchable obj)
      Updates an object in the index
      Specified by:
      reIndex in interface Indexer

    • reIndexExcludingDependents

      void reIndexExcludingDependents(Searchable obj)
      Updates just an object itself in the index, excluding any dependents (attachments, comments, children, etc.)
      Since:
      6.13.0

    • reIndexExcludingDependentsAndChangeIndex

      void reIndexExcludingDependentsAndChangeIndex(Searchable obj)
      Updates just an object itself in the Content index, excluding any dependents (attachments, comments, children, etc.)
      Since:
      9.5.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

    • reIndexPermissions

      void reIndexPermissions(Searchable searchable)
      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.
      Parameters:
      searchable - The content to be reindexed for permissions
      Since:
      9.2.5

    • synchronous

      default ConfluenceIndexer synchronous()
      Return synchronous indexer that will perform index in the caller thread.