com.atlassian.confluence.search.lucene

Class DefaultConfluenceIndexManager

java.lang.Object

com.atlassian.confluence.search.lucene.DefaultConfluenceIndexManager

All Implemented Interfaces:

ConfluenceIndexManager

public class DefaultConfluenceIndexManager
extends Object
implements ConfluenceIndexManager

The Confluence Index Manager is the entry point to the majority of the indexing subsystem..

Nested Class Summary

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

ConfluenceIndexManager.IndexQueueFlushMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	QUEUE_BATCH_SIZE_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultConfluenceIndexManager()

Method Summary

Modifier and Type	Method and Description
boolean	flushQueue() Flush the index queue, processing all of the tasks.
boolean	flushQueue(boolean batch) Deprecated.
boolean	flushQueue(ConfluenceIndexManager.IndexQueueFlushMode flushMode) Flush the index queue, processing a batch of the tasks
FlushStatistics	getLastNonEmptyFlushStats()
ReIndexTask	getLastReindexingTask() Retrieve the last reindexing task.
IndexTaskQueue	getTaskQueue() Retrieve the index task queue that is being used by Confluence.
boolean	isFlushing() Is the index queue currently being flushed?
boolean	isReIndexing() Check whether or not reindexing is currently in progress.
void	optimizeIndex() Enqueues an Optimize Index Task
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) Trigger an asynchronous reindex of the system.
void	resetIndexQueue() Delete all of the entries on the index queue.
void	setEventManager(com.atlassian.event.EventManager eventManager)
void	setIndexTaskFactory(IndexTaskFactory indexTaskFactory)
void	setIndexTaskPerformer(IndexTaskPerformer indexTaskPerformer)
void	setLuceneConnection(com.atlassian.bonnie.ILuceneConnection luceneConnection)
void	setReIndexer(ReIndexer reIndexer)
void	setSearchableDao(SearchableDao searchableDao)
void	setTaskQueue(IndexTaskQueue<ConfluenceIndexTask> taskQueue)
void	unIndexAll()

Methods inherited from class java.lang.Object

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

Field Detail

QUEUE_BATCH_SIZE_KEY

public static final String QUEUE_BATCH_SIZE_KEY

See Also:

Constant Field Values

Constructor Detail

DefaultConfluenceIndexManager

public DefaultConfluenceIndexManager()

Method Detail

isFlushing

public boolean isFlushing()

Is the index queue currently being flushed?

Specified by:

isFlushing in interface ConfluenceIndexManager

Returns:

true if the queue flush is in progress, false otherwise.

flushQueue

public boolean flushQueue()

Description copied from interface: ConfluenceIndexManager

Flush the index queue, processing all of the tasks.

Specified by:

flushQueue in interface ConfluenceIndexManager

Returns:

whether the flush actually took place

flushQueue

@Deprecated
public boolean flushQueue(boolean batch)

Deprecated.

Flush the index queue, processing a batch of the tasks

Specified by:

flushQueue in interface ConfluenceIndexManager

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

public boolean flushQueue(ConfluenceIndexManager.IndexQueueFlushMode flushMode)

Description copied from interface: ConfluenceIndexManager

Flush the index queue, processing a batch of the tasks

Specified by:

flushQueue in interface ConfluenceIndexManager

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

resetIndexQueue

public void resetIndexQueue()

Delete all of the entries on the index queue. This should NOT be called during the normal running of confluence since all pending Index Tasks will be deleted WITHOUT being processed.

Specified by:

resetIndexQueue in interface ConfluenceIndexManager

optimizeIndex

public void optimizeIndex()

Description copied from interface: ConfluenceIndexManager

Enqueues an Optimize Index Task

Specified by:

optimizeIndex in interface ConfluenceIndexManager

reIndex

public ReIndexTask reIndex()

Trigger a system wide reindex of all content.

Specified by:

reIndex in interface ConfluenceIndexManager

reIndex

public ReIndexTask reIndex(Set<ReIndexOption> options)

Trigger a system wide reindex with specified options.

Specified by:

reIndex in interface ConfluenceIndexManager

reIndex

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

Trigger an asynchronous reindex of the system. The progress of this task can be monitored via the getLastReindexingTask().

Specified by:

reIndex in interface ConfluenceIndexManager

Parameters:

options - 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.

isReIndexing

public boolean isReIndexing()

Check whether or not reindexing is currently in progress.

Specified by:

isReIndexing in interface ConfluenceIndexManager

Returns:

true if reindexing is running, false otherwise.

getLastReindexingTask

public ReIndexTask getLastReindexingTask()

Retrieve the last reindexing task. This task will provide all of the information required to track the progress/state of the reindexing process.

Specified by:

getLastReindexingTask in interface ConfluenceIndexManager

Returns:

the last executed reindex task, or null if no reindex has occured.

unIndexAll

public void unIndexAll()

Specified by:

unIndexAll in interface ConfluenceIndexManager

getTaskQueue

public IndexTaskQueue getTaskQueue()

Retrieve the index task queue that is being used by Confluence. This instance can also be retrieved by spring.

Specified by:

getTaskQueue in interface ConfluenceIndexManager

getLastNonEmptyFlushStats

public FlushStatistics getLastNonEmptyFlushStats()

Specified by:

getLastNonEmptyFlushStats in interface ConfluenceIndexManager

setIndexTaskFactory

public void setIndexTaskFactory(IndexTaskFactory indexTaskFactory)

setIndexTaskPerformer

public void setIndexTaskPerformer(IndexTaskPerformer indexTaskPerformer)

setEventManager

public void setEventManager(com.atlassian.event.EventManager eventManager)

setReIndexer

public void setReIndexer(ReIndexer reIndexer)

setSearchableDao

public void setSearchableDao(SearchableDao searchableDao)

setTaskQueue

public void setTaskQueue(IndexTaskQueue<ConfluenceIndexTask> taskQueue)

Parameters:

taskQueue - set by dependency injection, required

setLuceneConnection

public void setLuceneConnection(com.atlassian.bonnie.ILuceneConnection luceneConnection)

Parameters:

luceneConnection - set by dependency injection, required