Package com.atlassian.confluence.search

Interface IndexManager

  • All Known Implementing Classes:
    CompositeIndexManager
    public interface IndexManager
    The entry point to the Indexing Subsystem.
    Since:
    5.10

    • Method Detail

      • isFlushing

        boolean isFlushing()
        Returns true if the index queue is currently being flushed.
        Returns:
        true if flushing, false otherwise.

      • isReIndexing

        default boolean isReIndexing()
        Returns true if the system is currently being reindexed.
        Returns:
        true if flushing, false otherwise.

      • flushQueue

        boolean flushQueue​(IndexManager.IndexQueueFlushMode flushMode)
        Flushes the index queue, processing a batch of the tasks
        Parameters:
        flushMode - - whether to flush the entire queue, or just one batch of batchsize as specified by the system property index.queue.batch.size
        Returns:
        whether the flush actually took place

      • flushQueue

        default boolean flushQueue()
        Flushes the index queue, processing all of the tasks.
        Returns:
        whether the flush actually took place

      • reIndex

        default ReIndexTask reIndex()
        Triggers a system wide reindex of all content.

      • reIndex

        ReIndexTask reIndex​(EnumSet<ReIndexOption> options)
        Triggers a system wide reindex with specified options, entities are loaded from the database.

      • reIndex

        ReIndexTask reIndex​(EnumSet<ReIndexOption> options,
                    SearchQuery searchQuery)
        Triggers a system wide re-index.
        Parameters:
        options - Optional. Allows a subset of all searchable content to be re-indexed.
        searchQuery - A query that is used to load the entities to be re-indexed.

      • unIndexAll

        void unIndexAll()

      • getLastReindexingTask

        ReIndexTask getLastReindexingTask()

      • resetIndexQueue

        void resetIndexQueue()
        Resets the index queue removes all entries from the queue without processing them.

      • getTaskQueue

        @Deprecated
IndexTaskQueue getTaskQueue()
        Deprecated.
        since 7.9.0 Use IndexManager methods instead of calling corresponding methods on queue directly. This method is deprecated because Confluence will no longer have only one index queue
        Retrieves the index task queue that is being used by this manager.

      • getQueueSize

        int getQueueSize()
        Returns:
        the number of pending items in the corresponding index queue
        Since:
        7.9.0