com.atlassian.confluence.search.elasticsearch

Class ESIndexManager

java.lang.Object

com.atlassian.confluence.search.elasticsearch.ESIndexManager

All Implemented Interfaces:

IndexManager

@Internal
public class ESIndexManager
extends Object
implements IndexManager

Entry point to the majority of the ElasticSearch indexing subsystem.

Since:

5.10

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.search.IndexManager

IndexManager.IndexQueueFlushMode

Constructor Summary

Constructors

Constructor and Description
ESIndexManager(SearchableDao searchableDao, IndexTaskQueue<ESTask> taskQueue, ESIndexQueueFlusher esIndexQueueFlusher, ReIndexer reIndexer, Runnable unIndexer)

Method Summary

Modifier and Type	Method and Description
boolean	flushQueue(IndexManager.IndexQueueFlushMode flushMode) Flushes the index queue, processing a batch of the tasks
ReIndexTask	getLastReindexingTask()
IndexTaskQueue	getTaskQueue() Retrieves the index task queue that is being used by this manager.
boolean	isFlushing() Returns true if the the index queue is currently being flushed.
ReIndexTask	reIndex(EnumSet<ReIndexOption> options) Triggers a system wide reindex with specified options, entities are loaded from the database.
ReIndexTask	reIndex(EnumSet<ReIndexOption> options, SearchQuery searchQuery) Triggers a system wide re-index.
void	resetIndexQueue() Resets the index queue removes all entries from the queue without processing them.
void	unIndexAll()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.search.IndexManager

flushQueue, isReIndexing, reIndex

Constructor Detail

ESIndexManager

public ESIndexManager(SearchableDao searchableDao,
                      IndexTaskQueue<ESTask> taskQueue,
                      ESIndexQueueFlusher esIndexQueueFlusher,
                      ReIndexer reIndexer,
                      Runnable unIndexer)

Method Detail

resetIndexQueue

public void resetIndexQueue()

Description copied from interface: IndexManager

Resets the index queue removes all entries from the queue without processing them.

Specified by:

resetIndexQueue in interface IndexManager

flushQueue

public boolean flushQueue(IndexManager.IndexQueueFlushMode flushMode)

Description copied from interface: IndexManager

Flushes the index queue, processing a batch of the tasks

Specified by:

flushQueue in interface IndexManager

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

getLastReindexingTask

public ReIndexTask getLastReindexingTask()

Specified by:

getLastReindexingTask in interface IndexManager

isFlushing

public boolean isFlushing()

Description copied from interface: IndexManager

Returns true if the the index queue is currently being flushed.

Specified by:

isFlushing in interface IndexManager

Returns:

true if flushing, false otherwise.

unIndexAll

public void unIndexAll()

Specified by:

unIndexAll in interface IndexManager

reIndex

public ReIndexTask reIndex(EnumSet<ReIndexOption> options)

Description copied from interface: IndexManager

Triggers a system wide reindex with specified options, entities are loaded from the database.

Specified by:

reIndex in interface IndexManager

reIndex

public ReIndexTask reIndex(EnumSet<ReIndexOption> options,
                           SearchQuery searchQuery)

Description copied from interface: IndexManager

Triggers a system wide re-index.

Specified by:

reIndex in interface IndexManager

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.

getTaskQueue

public IndexTaskQueue getTaskQueue()

Description copied from interface: IndexManager

Retrieves the index task queue that is being used by this manager.

Specified by:

getTaskQueue in interface IndexManager