com.atlassian.fisheye.spi.admin.data

Class RepositoryIndexingStatus

java.lang.Object

com.atlassian.fisheye.spi.admin.data.RepositoryIndexingStatus

public class RepositoryIndexingStatus
extends java.lang.Object

A snapshot of the status of a repository's indexer. Use RepositoryIndexer.getIndexingStatus() to get newer snapshots of the indexing status.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RepositoryIndexingStatus.Builder

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,? extends java.lang.Number>	getIndexingStateCounts() Get the counts of changesets in the repository which are in each indxing state.
java.util.Date	getLastScanTime() The time the last scan of the repository completed.
java.lang.String	getMessage() Human readable status/error message.
boolean	hasError() Whether there are any errors with the indexing.
boolean	isCrossRepositoryRescanInProgress() Indicates that a cross-repository search rescan request is running on the repository, and not complete yet.
boolean	isDoneFullRepositorySlurp() This indicates that the indexing phase of initial repository processing is complete.
boolean	isFullIndexingInProgress() This indicates that the repository is in the process of performing the initial indexing of a repository which includes both the scanning and indexing phases
boolean	isIncrementalIndexingInProgress() Indicates that incremental indexing is in progress (covering both scanning and indexing).
boolean	isInitialScanningComplete() This indicates that the scanning phase of initial repository processing is complete.
boolean	isLinesOfContentIndexingInProgress()

Methods inherited from class java.lang.Object

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

Method Detail

getLastScanTime

public java.util.Date getLastScanTime()

The time the last scan of the repository completed. Null if a repository has not completed a scan since being started.

Returns:

when the last scan of the repository was completed

isFullIndexingInProgress

public boolean isFullIndexingInProgress()

This indicates that the repository is in the process of performing the initial indexing of a repository which includes both the scanning and indexing phases

Returns:

true if an initial index is in progress currently.

isIncrementalIndexingInProgress

public boolean isIncrementalIndexingInProgress()

Indicates that incremental indexing is in progress (covering both scanning and indexing). This means that initial indexing of the reository has been completed and new changesets are now being processed.

Returns:

true if incremental indexing is currently in progress.

isLinesOfContentIndexingInProgress

public boolean isLinesOfContentIndexingInProgress()

hasError

public boolean hasError()

Whether there are any errors with the indexing. Use getMessage() to retrieve a description of the error if this is the case.

Returns:

true if there is any error with the indexing, false otherwise

getMessage

public java.lang.String getMessage()

Human readable status/error message.

The message is descriptive and subject to change.

Returns:

description of the status or error

getIndexingStateCounts

public java.util.Map<java.lang.String,? extends java.lang.Number> getIndexingStateCounts()

Get the counts of changesets in the repository which are in each indxing state. This is only applicable to repository types which support pipelined processing.

Returns:

a map of indexing state name to count, being the number of changesets in that state.

isDoneFullRepositorySlurp

public boolean isDoneFullRepositorySlurp()

This indicates that the indexing phase of initial repository processing is complete. This means that the changeset which was HEAD when the repository began processing has now been indexed. This is known as DoneFullRepositorySlurp for historical reasons.

Returns:

true if initial indexing is complete.

isInitialScanningComplete

public boolean isInitialScanningComplete()

This indicates that the scanning phase of initial repository processing is complete. In detail this means that the changeset which was HEAD when the repository began processing has now been scanned.

Returns:

true if initial scanning is complete.

isCrossRepositoryRescanInProgress

public boolean isCrossRepositoryRescanInProgress()

Indicates that a cross-repository search rescan request is running on the repository, and not complete yet. This might be the case if the search index format changes and the index is being rebuilt. Search results might be incomplete when this flag is true.