com.atlassian.bamboo.index
Interface IndexerManager

All Known Implementing Classes:

IndexerManagerImpl

@Internal
public interface IndexerManager

Method Summary

Date	getEstimatedReindexCompletionTime() Returns information on estimated completion time while full indexing operation is running.
long	getEstimatedReindexTime() How long will it take to reindex all indexes.
int	getNumberOfDocuments() How many documents all indexes have in total.
boolean	isPendingFullReindex() Check if instance is pending full reindex either because of call to setPendingFullReindex() or because of aborted full reindex
boolean	isPendingPartialReindex() Check if instance is pending full reindex of SOME indexers or because of aborted full reindex
boolean	isReindexInProgress()
com.google.common.util.concurrent.ListenableFuture<Boolean>	pauseIndexing() Pause indexing.
void	setPendingFullReindex() Persist information that full reindex is requested.
void	setPendingPartialReindex(List<String> indexerNames) Persist information that full reindex of SOME indexers is requested.
com.google.common.util.concurrent.ListenableFuture<Boolean>	triggerFullReindex() Triggers asynchronous full reindex.
com.google.common.util.concurrent.ListenableFuture<Boolean>	triggerPartialReindex() Trigger asynchronous reindex of previously selected indexers Selected indexes will be removed and all documents will be regenerated by Indexers.

Method Detail

triggerFullReindex

@NotNull
com.google.common.util.concurrent.ListenableFuture<Boolean> triggerFullReindex()

Triggers asynchronous full reindex. All indexes will be removed and all documents will be regenerated by Indexers.

Returns:

Future object that will return true on successful operation completion

triggerPartialReindex

@NotNull
com.google.common.util.concurrent.ListenableFuture<Boolean> triggerPartialReindex()

Trigger asynchronous reindex of previously selected indexers Selected indexes will be removed and all documents will be regenerated by Indexers.

Returns:

Future object that will return true on successful operation completion

getEstimatedReindexTime

long getEstimatedReindexTime()

How long will it take to reindex all indexes.

Returns:

seconds of how long

getNumberOfDocuments

int getNumberOfDocuments()

How many documents all indexes have in total.

Returns:

number of documents in all indexes

isReindexInProgress

boolean isReindexInProgress()

Returns:

true if reindex is running

setPendingFullReindex

void setPendingFullReindex()

Persist information that full reindex is requested. This flag will be used during Bamboo startup, it is supposed to be set by import/upgrade only and will be cleared by the next successful full reindex.

isPendingFullReindex

boolean isPendingFullReindex()

Check if instance is pending full reindex either because of call to setPendingFullReindex() or because of aborted full reindex

Returns:

true if there's full reindex pending

isPendingPartialReindex

boolean isPendingPartialReindex()

Check if instance is pending full reindex of SOME indexers or because of aborted full reindex

Returns:

true if there's reindex of some indexers pending pending

setPendingPartialReindex

void setPendingPartialReindex(List<String> indexerNames)

Persist information that full reindex of SOME indexers is requested. This flag will be used during Bamboo startup, it is supposed to be set by import/upgrade only and will be cleared by the next successful reindex.

getEstimatedReindexCompletionTime

Date getEstimatedReindexCompletionTime()

Returns information on estimated completion time while full indexing operation is running. Time is calculated based on previous indexer runs and is not refreshed during reindex operation.

Returns:

estimated completion date, null when no reindex operation is running at the moment

pauseIndexing

com.google.common.util.concurrent.ListenableFuture<Boolean> pauseIndexing()

Pause indexing.

Returns:

future which allows to be notified when index in progress is finished.