com.atlassian.confluence.search.lucene

Class LuceneIndexManager

java.lang.Object

com.atlassian.confluence.search.lucene.LuceneIndexManager

All Implemented Interfaces:

IndexManager, ConfluenceIndexManager

public class LuceneIndexManager
extends Object
implements ConfluenceIndexManager

Entry point to the majority of the Lucene indexing subsystem.

Since:

5.10

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
LuceneIndexManager()

Method Summary

Modifier and Type	Method and Description
boolean	flushQueue(IndexManager.IndexQueueFlushMode flushMode) Flushes 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() 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) 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	setIndexTaskPerformer(IndexTaskPerformer indexTaskPerformer)
void	setLuceneConnection(com.atlassian.bonnie.ILuceneConnection luceneConnection)
void	setReIndexer(ReIndexer reIndexer)
void	setSearchableDao(SearchableDao searchableDao)
void	setSessionFactory(org.hibernate.SessionFactory sessionFactory)
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

Methods inherited from interface com.atlassian.confluence.search.lucene.ConfluenceIndexManager

flushQueue, reIndex, reIndex

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

flushQueue, isReIndexing, reIndex

Field Detail

QUEUE_BATCH_SIZE_KEY

public static final String QUEUE_BATCH_SIZE_KEY

See Also:

Constant Field Values

Constructor Detail

LuceneIndexManager

public LuceneIndexManager()

Method Detail

setIndexTaskPerformer

public void setIndexTaskPerformer(IndexTaskPerformer indexTaskPerformer)

setLuceneConnection

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

setSessionFactory

public void setSessionFactory(org.hibernate.SessionFactory sessionFactory)

setTaskQueue

public void setTaskQueue(IndexTaskQueue<ConfluenceIndexTask> taskQueue)

Parameters:

taskQueue - Set by dependency injection, required

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 IndexManager

unIndexAll

public void unIndexAll()

Specified by:

unIndexAll in interface IndexManager

setEventManager

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

Parameters:

eventManager - Set by dependency injection, required

setReIndexer

public void setReIndexer(ReIndexer reIndexer)

Parameters:

reIndexer - Set by dependency injection, required

setSearchableDao

public void setSearchableDao(SearchableDao searchableDao)

Parameters:

searchableDao - Set by dependency injection, required

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.

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

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 IndexManager

reIndex

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

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

Specified by:

reIndex in interface IndexManager

Parameters:

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

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

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

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 IndexManager

Returns:

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

getLastNonEmptyFlushStats

public FlushStatistics getLastNonEmptyFlushStats()

Specified by:

getLastNonEmptyFlushStats in interface IndexManager

Specified by:

getLastNonEmptyFlushStats in interface ConfluenceIndexManager