Package com.atlassian.confluence.search

Interface ReIndexSupport<T>

Type Parameters:
T - the type of entity being reindexed
All Known Implementing Classes:
AttachmentOnlyReIndexSupport, ContentOnlyReIndexSupport, ReIndexOption, UserOnlyReIndexSupport
public interface ReIndexSupport<T>
Interface for reindexing options in Confluence. Defines the contract for different types of reindexing operations.
Since:
10.1

  • Method Details

    • getDeleteQuery

      SearchQuery getDeleteQuery()
      Get the search query for deleting documents during reindexing.
      Returns:
      the delete query

    • getDeleteQuery

      SearchQuery getDeleteQuery(Optional<String> spaceKey)
      Get the search query for deleting documents during reindexing within a specific space.
      Parameters:
      spaceKey - the space key to limit the deletion to
      Returns:
      the delete query

    • getThreadCount

      Integer getThreadCount(JvmSystemResources jvmRuntime)
      Get the number of threads to use for reindexing with specific JVM resources.
      Parameters:
      jvmRuntime - the JVM system resources
      Returns:
      the thread count

    • getClassFilter

      default Predicate<String> getClassFilter()
      Get the class filter predicate for this reindex option.
      Returns:
      predicate to filter classes

    • getEntityClass

      default Class<T> getEntityClass()
      Get the entity class for this reindex option. Only required if using default implementations of getClassFilter() or getHandles().
      Returns:
      the entity class

    • getHandles

      default List<HibernateHandle> getHandles(SearchableDao dao)
      Get handles for reindexing.
      Parameters:
      dao - the searchable DAO
      Returns:
      list of hibernate handles

    • getHandles

      default List<HibernateHandle> getHandles(SearchableDao dao, Optional<String> spaceKey)
      Get handles for reindexing within a specific space.
      Parameters:
      dao - the searchable DAO
      spaceKey - the space key to limit to
      Returns:
      list of hibernate handles