com.atlassian.confluence.search.lucene

Interface ConfluenceIndexManager

All Known Implementing Classes:

DefaultConfluenceIndexManager

public interface ConfluenceIndexManager

The Confluence Index Manager is the entry point to the Indexing Subsystem

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConfluenceIndexManager.IndexQueueFlushMode Enum indicating the mode in which to flush the queue.

Method Summary

Modifier and Type	Method and Description
boolean	flushQueue() Flush the index queue, processing all of the tasks.
boolean	flushQueue(boolean batch) Deprecated. since 4.3 use flushQueue(com.atlassian.confluence.search.lucene.ConfluenceIndexManager.IndexQueueFlushMode)
boolean	flushQueue(ConfluenceIndexManager.IndexQueueFlushMode flushMode) Flush the index queue, processing a batch of the tasks
FlushStatistics	getLastNonEmptyFlushStats()
ReIndexTask	getLastReindexingTask()
IndexTaskQueue	getTaskQueue() Retrieve an instance of the systems index queue.
boolean	isFlushing() Returns true if the the index queue is currently being flushed.
boolean	isReIndexing() Returns true if the system is currently being reindexed.
void	optimizeIndex() Deprecated. since 5.2. Optimize index (i.e. force merging to 1 segment is no longer required) CONFDEV-16098
ReIndexTask	reIndex() Trigger a system wide reindex of all content.
ReIndexTask	reIndex(Set<ReIndexOption> options) Trigger a system wide reindex with specified options.
ReIndexTask	reIndex(Set<ReIndexOption> options, SearchQuery luceneQuery) Triggers a system wide re-index.
void	resetIndexQueue() Resetting the index queue removes all entries from the queue without processing them.
void	unIndexAll()

Method Detail

isFlushing

boolean isFlushing()

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

Returns:

true if flushing, false otherwise.

isReIndexing

boolean isReIndexing()

Returns true if the system is currently being reindexed.

Returns:

true if flushing, false otherwise.

flushQueue

boolean flushQueue(ConfluenceIndexManager.IndexQueueFlushMode flushMode)

Flush 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

@Deprecated
boolean flushQueue(boolean batch)

Deprecated. since 4.3 use flushQueue(com.atlassian.confluence.search.lucene.ConfluenceIndexManager.IndexQueueFlushMode)

Flush the index queue, processing a batch of the tasks

Parameters:

batch - - 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

boolean flushQueue()

Flush the index queue, processing all of the tasks.

Returns:

whether the flush actually took place

reIndex

ReIndexTask reIndex()

Trigger a system wide reindex of all content.

reIndex

ReIndexTask reIndex(Set<ReIndexOption> options)

Trigger a system wide reindex with specified options.

reIndex

ReIndexTask reIndex(Set<ReIndexOption> options,
                    SearchQuery luceneQuery)

Triggers a system wide re-index.

Parameters:

options - Optional. Allows a subset of all searchable content to be re-indexed.

luceneQuery - Optional. A lucene query that may be used to load the entities to be re-indexed. Pass null to index all entities from the database.

unIndexAll

void unIndexAll()

optimizeIndex

void optimizeIndex()

Deprecated. since 5.2. Optimize index (i.e. force merging to 1 segment is no longer required) CONFDEV-16098

Enqueues an Optimize Index Task

getTaskQueue

IndexTaskQueue getTaskQueue()

Retrieve an instance of the systems index queue.

getLastReindexingTask

ReIndexTask getLastReindexingTask()

getLastNonEmptyFlushStats

FlushStatistics getLastNonEmptyFlushStats()

resetIndexQueue

void resetIndexQueue()

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