Package com.atlassian.confluence.internal.index.lucene

Class LuceneFullReindexManager

java.lang.Object

com.atlassian.confluence.internal.index.lucene.LuceneFullReindexManager

All Implemented Interfaces:

FullReindexManager

@LuceneIndependent
@ThreadSafe
public class LuceneFullReindexManager
extends Object
implements FullReindexManager

Since:

7.9.0

Field Summary

Fields

Modifier and Type	Field	Description
static String	REINDEX_METRIC_NAME
static long	STOP_TASK_POLLING_INTERVAL

Constructor Summary

Constructors

Constructor	Description
LuceneFullReindexManager(IndexLockService lockService, ReIndexer reIndexer, SearchableDao searchableDao, Collection<SearchIndexAccessor> searchIndexAccessors, com.atlassian.sal.api.features.DarkFeatureManager darkFeatureManager)

Method Summary

Modifier and Type	Method	Description
ReIndexTask	getLastReindexingTask()	Retrieve the last reindexing task.
boolean	isReIndexing()	Returns true if the system is currently being reindexed.
ReIndexTask	reIndex()	Triggers a system-wide reindex of all content and changes.
ReIndexTask	reIndex(EnumSet<ReIndexOption> options)	Triggers a system-wide reindex with specified options.
ReIndexTask	reIndex(EnumSet<ReIndexOption> options, @NonNull List<String> spaceKeys)	Triggers a re-index where entities are loaded using provided searchQuery.
ReIndexTask	reIndex(EnumSet<ReIndexOption> options, SearchQuery searchQuery)	Triggers a system-wide re-index where entities are loaded using provided searchQuery.
void	unIndexAll()	Drop everything from the search index.

Methods inherited from class java.lang.Object

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

Field Detail

REINDEX_METRIC_NAME

public static final String REINDEX_METRIC_NAME

See Also:

Constant Field Values

STOP_TASK_POLLING_INTERVAL

public static final long STOP_TASK_POLLING_INTERVAL

See Also:

Constant Field Values

Constructor Detail

LuceneFullReindexManager

public LuceneFullReindexManager(IndexLockService lockService,
                                ReIndexer reIndexer,
                                SearchableDao searchableDao,
                                Collection<SearchIndexAccessor> searchIndexAccessors,
                                com.atlassian.sal.api.features.DarkFeatureManager darkFeatureManager)

Method Detail

reIndex

public ReIndexTask reIndex()

Description copied from interface: FullReindexManager

Triggers a system-wide reindex of all content and changes. Entities are loaded from the database. If reindex is already in progress, returns its stats.

Specified by:

reIndex in interface FullReindexManager

reIndex

public ReIndexTask reIndex(EnumSet<ReIndexOption> options)

Description copied from interface: FullReindexManager

Triggers a system-wide reindex with specified options. Entities are loaded from the database. If reindex is already in progress, returns its stats.

Specified by:

reIndex in interface FullReindexManager

reIndex

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

Description copied from interface: FullReindexManager

Triggers a system-wide re-index where entities are loaded using provided searchQuery. If reindex is already in progress, returns its stats.

Specified by:

reIndex in interface FullReindexManager

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.

reIndex

public ReIndexTask reIndex(EnumSet<ReIndexOption> options,
                           @NonNull List<String> spaceKeys)

Description copied from interface: FullReindexManager

Triggers a re-index where entities are loaded using provided searchQuery. If reindex is already in progress, returns its stats.

Specified by:

reIndex in interface FullReindexManager

Parameters:

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

spaceKeys - Keys of the spaces to be re-indexed

Returns:

the ReIndexTask

getLastReindexingTask

public ReIndexTask getLastReindexingTask()

Description copied from interface: FullReindexManager

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 FullReindexManager

Returns:

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

isReIndexing

public boolean isReIndexing()

Description copied from interface: FullReindexManager

Returns true if the system is currently being reindexed.

Specified by:

isReIndexing in interface FullReindexManager

Returns:

true if full reindex is in progress, false otherwise.

unIndexAll

public void unIndexAll()

Description copied from interface: FullReindexManager

Drop everything from the search index. If the operation can't be performed, does nothing.

Specified by:

unIndexAll in interface FullReindexManager