Package com.atlassian.confluence.api.service.index

Interface IndexService

All Known Implementing Classes:
IndexServiceImpl
public interface IndexService
Service for reindexing contents in Confluence
Since:
10.1

  • Field Details

    • REINDEX_CLUSTER_LOCK_NAME

      static final String REINDEX_CLUSTER_LOCK_NAME
      See Also:

    • REINDEX_CLUSTER_LOCK_ACQUIRE_TIMEOUT_MS

      static final long REINDEX_CLUSTER_LOCK_ACQUIRE_TIMEOUT_MS

  • Method Details

    • isReIndexing

      boolean isReIndexing()
      Returns:
      false if the last re-indexing job has completed or the re-indexing job has never been run

    • reindex

      boolean reindex(@NonNull List<String> spaceKeys, @NonNull EnumSet<ReIndexOption> reIndexOptions) throws InterruptedException
      Triggers a reindex with the specified space keys and options.
      Parameters:
      spaceKeys - List of space keys to reindex
      reIndexOptions - Set of reindex options for reindexing
      Returns:
      true if reindex was started successfully
      Throws:
      InterruptedException - if the operation is interrupted

    • resetJobStatus

      void resetJobStatus()
      Resets the status of the reindexing job.

    • getLastReindexingTask

      ReIndexTaskInfo getLastReindexingTask()
      Retrieves the last reindexing task.
      Returns:
      the last reindexing task, or null if no reindexing has been performed

    • unIndexAll

      void unIndexAll()
      Unindexes all content in the index.