com.atlassian.jira.issue.index

Interface IssueIndexManager

All Superinterfaces:

IndexLifecycleManager, IssueIndexingService, Shutdown, Sized

All Known Implementing Classes:

BulkOnlyIndexManager, DefaultIndexManager

public interface IssueIndexManager
extends IndexLifecycleManager, IssueIndexingService

Manages Lucene search indexes.

Method Summary

Modifier and Type	Method and Description
void	deIndex(org.ofbiz.core.entity.GenericValue issue) Deprecated. Since v5.0 use IssueIndexingService.deIndex(Issue) instead. Since v7.0 use IssueIndexingService.deIndex(Issue) instead.
org.apache.lucene.analysis.Analyzer	getAnalyzerForIndexing() Returns an Analyzer for indexing.
org.apache.lucene.analysis.Analyzer	getAnalyzerForSearching() Returns an Analyzer for searching.
ManagedIndexSearcher	getChangeHistorySearcher() Get an IndexSearcher that can be used to search the change history index.
ManagedIndexSearcher	getCommentSearcher() Get an IndexSearcher that can be used to search the comment index.
Collection<String>	getExistingPluginsPaths() Returns a collection of Strings, each one representing the absolute path to the actual existing directory where a plugin keeps its indexes.
ManagedIndexSearcher	getIssueSearcher() Get an IndexSearcher that can be used to search the issue index.
java.time.Instant	getLatestIndexDate() Gets the latest index date based on the most recent issue updated date.
String	getPluginsRootPath() Get the root path of the index directory for plugins.
ManagedIndexSearcher	getWorklogSearcher() Get an IndexSearcher that can be used to search the worklog index.
void	hold() Temporarily suspend indexing on this thread.
boolean	isHeld() Return true if the index is held.
void	reIndex(org.ofbiz.core.entity.GenericValue issue) Deprecated. Since v5.0. Use reIndex(Issue) instead. Since v7.0, use IssueIndexingService.reIndex(Issue) instead.
void	reIndex(Issue issue) Deprecated. Call this as IssueIndexingService.reIndex(Issue) instead. Since v7.0.
void	reIndex(Issue issue, boolean reIndexComments, boolean reIndexChangeHistory) Deprecated. Since v6.4, use reIndex(Issue, IssueIndexingParams). Since v7.0, use IssueIndexingService.reIndex(Issue, IssueIndexingParams).
void	reIndex(Issue issue, IssueIndexingParams issueIndexingParams) Deprecated. Call this as IssueIndexingService.reIndex(Issue, IssueIndexingParams) instead. Since v7.0.
long	reIndexAll() Deprecated. Call this as IssueIndexingService.reIndexAll() instead. Since v7.0.
long	reIndexAll(Context context, boolean useBackgroundReindexing, boolean notifyCluster) Deprecated. Call this as IssueIndexingService.reIndexAll(Context, boolean, boolean) instead. Since v7.0.
long	reIndexAll(Context context, boolean useBackgroundReindexing, boolean reIndexComments, boolean reIndexChangeHistory, boolean notifyCluster) Deprecated. since v6.4 use reIndexAll(Context, boolean, IssueIndexingParams, boolean) instead. Since v7.0 use IssueIndexingService.reIndexAll(Context, boolean, IssueIndexingParams, boolean) instead.
long	reIndexAll(Context context, boolean useBackgroundReindexing, IssueIndexingParams issueIndexingParams, boolean notifyCluster) Deprecated. Call this as IssueIndexingService.reIndexAll(Context, boolean, IssueIndexingParams, boolean) instead. Since v7.0.
long	reIndexComments(Collection<Comment> comments) Deprecated. Call this as IssueIndexingService.reIndexComments(Collection) instead. Since v7.0.
long	reIndexComments(Collection<Comment> comments, Context context) Deprecated. Call this as IssueIndexingService.reIndexComments(Collection, Context) instead. Since v7.0.
long	reIndexComments(Collection<Comment> comments, Context context, boolean shouldReplicate) Deprecated. Call this as IssueIndexingService.reIndexComments(Collection, Context, boolean) instead. Since v7.0.
long	reIndexIssueObjects(Collection<? extends Issue> issueObjects) Deprecated. Call this as IssueIndexingService.reIndexIssueObjects(Collection) instead. Since v7.0.
long	reIndexIssueObjects(Collection<? extends Issue> issueObjects, boolean reIndexComments, boolean reIndexChangeHistory) Deprecated. Since v6.4, use reIndexIssueObjects(Collection, IssueIndexingParams). Since v7.0, use IssueIndexingService.reIndexIssueObjects(Collection, IssueIndexingParams).
long	reIndexIssueObjects(Collection<? extends Issue> issueObjects, boolean reIndexComments, boolean reIndexChangeHistory, boolean shouldReplicate) Deprecated. Since v6.4, use reIndexIssueObjects(Collection, IssueIndexingParams, boolean). Since v7.0, use IssueIndexingService.reIndexIssueObjects(Collection, IssueIndexingParams, boolean).
long	reIndexIssueObjects(Collection<? extends Issue> issueObjects, IssueIndexingParams issueIndexingParams) Deprecated. Call this as IssueIndexingService.reIndexIssueObjects(Collection, IssueIndexingParams) instead. Since v7.0.
long	reIndexIssueObjects(Collection<? extends Issue> issueObjects, IssueIndexingParams issueIndexingParams, boolean shouldReplicate) Deprecated. Call this as IssueIndexingService.reIndexIssueObjects(Collection, IssueIndexingParams, boolean) instead. Since v7.0.
long	reIndexIssues(Collection<org.ofbiz.core.entity.GenericValue> issues) Deprecated. Since v5.0, use reIndexIssueObjects(Collection) instead. Since v7.0, use IssueIndexingService.reIndexIssueObjects(Collection) instead.
long	reIndexIssues(IssuesIterable issuesIterable, Context context) Deprecated. Call this as IssueIndexingService.reIndexIssues(IssuesIterable, Context) instead. Since v7.0.
long	reIndexIssues(IssuesIterable issuesIterable, Context context, boolean reIndexComments, boolean reIndexChangeHistory) Deprecated. Since v6.4, use reIndexIssues(IssuesIterable, Context, IssueIndexingParams). Since v7.0, use IssueIndexingService.reIndexIssues(IssuesIterable, Context, IssueIndexingParams).
long	reIndexIssues(IssuesIterable issuesIterable, Context context, IssueIndexingParams issueIndexingParams) Deprecated. Call this as IssueIndexingService.reIndexIssues(IssuesIterable, Context, IssueIndexingParams) instead. Since v7.0.
long	reIndexWorklogs(Collection<Worklog> worklogs) Deprecated. Call this as IssueIndexingService.reIndexWorklogs(Collection) instead. Since v7.0.
long	reIndexWorklogs(Collection<Worklog> worklogs, Context context) Deprecated. Call this as IssueIndexingService.reIndexWorklogs(Collection, Context) instead. Since v7.0.
long	reIndexWorklogs(Collection<Worklog> worklogs, Context context, boolean shouldReplicate) Deprecated. Call this as IssueIndexingService.reIndexWorklogs(Collection, Context, boolean) instead. Since v7.0.
long	release() Release indexing on this thread.
boolean	withReindexLock(Runnable runnable) Runs the given runnable under the 'stop the world' reindex lock.

Methods inherited from interface com.atlassian.jira.util.index.IndexLifecycleManager

activate, activate, deactivate, getAllIndexPaths, isIndexAvailable, isIndexConsistent, optimize, reIndexAll, reIndexAll, reIndexAllIssuesInBackground, reIndexIssuesInBackground, shutdown, size

Methods inherited from interface com.atlassian.jira.util.collect.Sized

isEmpty

Methods inherited from interface com.atlassian.jira.issue.index.IssueIndexingService

deIndex, deIndex, deIndex, deIndexComments, deIndexIssueObjects, deIndexIssueObjectsById, deIndexWorklogs, reIndexIssues

Method Detail

hold

void hold()

Temporarily suspend indexing on this thread. All index requests will be queued and processed when release is called.

Since:

v5.1

isHeld

boolean isHeld()

Return true if the index is held.

Since:

v5.1

release

long release()
      throws IndexException

Release indexing on this thread. All queued index requests will be processed.

Returns:

Reindex time in ms.

Throws:

IndexException - if an error occurs

Since:

v5.1

getPluginsRootPath

String getPluginsRootPath()

Get the root path of the index directory for plugins. Any plugin that keeps indexes should create its own sub-directory under this path and create its indexes in its own sub-directory

getExistingPluginsPaths

Collection<String> getExistingPluginsPaths()

Returns a collection of Strings, each one representing the absolute path to the actual existing directory where a plugin keeps its indexes. Each directory in the collection should be a sub-directory under the plugin's index root path. See getPluginsRootPath().

If a plugin index root path does not exist, or is empty (no sub-directopries exist) then an empty collection will be returned.

getIssueSearcher

ManagedIndexSearcher getIssueSearcher()

Get an IndexSearcher that can be used to search the issue index.

getCommentSearcher

ManagedIndexSearcher getCommentSearcher()

Get an IndexSearcher that can be used to search the comment index.

getChangeHistorySearcher

ManagedIndexSearcher getChangeHistorySearcher()

Get an IndexSearcher that can be used to search the change history index.

getWorklogSearcher

ManagedIndexSearcher getWorklogSearcher()

Get an IndexSearcher that can be used to search the worklog index.

getAnalyzerForSearching

org.apache.lucene.analysis.Analyzer getAnalyzerForSearching()

Returns an Analyzer for searching.

Returns:

an analyzer for searching

getAnalyzerForIndexing

org.apache.lucene.analysis.Analyzer getAnalyzerForIndexing()

Returns an Analyzer for indexing.

Returns:

an analyzer for indexing.

withReindexLock

boolean withReindexLock(Runnable runnable)

Runs the given runnable under the 'stop the world' reindex lock.

Parameters:

runnable - The runnable to be executed

Returns:

true if the lock could be acquired, false otherwise

Since:

v6.3

reIndexAll

@Deprecated
long reIndexAll()
                     throws IndexException

Deprecated. Call this as IssueIndexingService.reIndexAll() instead. Since v7.0.

Reindex all issues.

Specified by:

reIndexAll in interface IssueIndexingService

Returns:

Reindex time in ms.

Throws:

IndexException

reIndexAll

@Deprecated
long reIndexAll(Context context,
                            boolean useBackgroundReindexing,
                            boolean notifyCluster)
                     throws IndexException

Deprecated. Call this as IssueIndexingService.reIndexAll(Context, boolean, boolean) instead. Since v7.0.

Reindex all issues.

Specified by:

reIndexAll in interface IssueIndexingService

Parameters:

context - used to report progress back to the user or to the logs. Must not be null

useBackgroundReindexing - whether to index in the background or not. If the useBackgroundReindexing option is set to true, then all related fields will not be reindexed.

notifyCluster - whether or not to notify the cluster about reindexing all

Returns:

Reindex time in ms.

Throws:

IndexException

reIndexAll

@Deprecated
long reIndexAll(Context context,
                            boolean useBackgroundReindexing,
                            IssueIndexingParams issueIndexingParams,
                            boolean notifyCluster)
                     throws IndexException

Deprecated. Call this as IssueIndexingService.reIndexAll(Context, boolean, IssueIndexingParams, boolean) instead. Since v7.0.

Reindex all issues. If the useBackgroundReindexing option is set to true, then only the basic issue information will be reindexed, unless the indexing parameters are also set. This is considered the normal mode for background re-indexing and is sufficient to correct the index for changes in the system configuration, but not for changes to the indexing language. If useBackgroundReindexing is set to false, than everything is always reindexed.

Specified by:

reIndexAll in interface IssueIndexingService

Parameters:

context - used to report progress back to the user or to the logs. Must not be null

useBackgroundReindexing - whether to index in the background or not

issueIndexingParams - determines witch related objects should be indexed together with issues. Only relevant for background reindex operations.

notifyCluster - whether or not to notify the cluster about reindexing all

Returns:

Reindex time in ms.

Throws:

IndexException

Since:

v6.4

reIndexIssues

@Deprecated
long reIndexIssues(IssuesIterable issuesIterable,
                               Context context)
                        throws IndexException

Deprecated. Call this as IssueIndexingService.reIndexIssues(IssuesIterable, Context) instead. Since v7.0.

Reindex a list of issues, passing an optional event that will be set progress

Specified by:

reIndexIssues in interface IssueIndexingService

Parameters:

issuesIterable - IssuesIterable

context - used to report progress back to the user or to the logs. Must not be null.

Returns:

Reindex time in ms.

Throws:

IndexException

reIndexIssues

@Deprecated
long reIndexIssues(IssuesIterable issuesIterable,
                               Context context,
                               IssueIndexingParams issueIndexingParams)
                        throws IndexException

Deprecated. Call this as IssueIndexingService.reIndexIssues(IssuesIterable, Context, IssueIndexingParams) instead. Since v7.0.

Reindex a list of issues, passing an optional event that will be set progress. This method can optionally also index the comments and change history.

Specified by:

reIndexIssues in interface IssueIndexingService

Parameters:

issuesIterable - IssuesIterable

context - used to report progress back to the user or to the logs. Must not be null.

issueIndexingParams - determines witch related objects should be indexed together with issue.

Returns:

Reindex time in ms.

Throws:

IndexException

Since:

v6.4

reIndex

@Deprecated
void reIndex(Issue issue)
                  throws IndexException

Deprecated. Call this as IssueIndexingService.reIndex(Issue) instead. Since v7.0.

Reindex an issue (eg. after field updates).

Specified by:

reIndex in interface IssueIndexingService

Throws:

IndexException

reIndex

@Deprecated
void reIndex(Issue issue,
                         IssueIndexingParams issueIndexingParams)
                  throws IndexException

Deprecated. Call this as IssueIndexingService.reIndex(Issue, IssueIndexingParams) instead. Since v7.0.

Reindex an issue (eg. after field updates).

Specified by:

reIndex in interface IssueIndexingService

Throws:

IndexException

Since:

6.3

reIndexComments

@Deprecated
long reIndexComments(Collection<Comment> comments)
                          throws IndexException

Deprecated. Call this as IssueIndexingService.reIndexComments(Collection) instead. Since v7.0.

Reindexes a collection of comments.

Specified by:

reIndexComments in interface IssueIndexingService

Parameters:

comments - a collection of Comment

Throws:

IndexException

Since:

v5.2

reIndexComments

@Deprecated
long reIndexComments(Collection<Comment> comments,
                                 Context context)
                          throws IndexException

Deprecated. Call this as IssueIndexingService.reIndexComments(Collection, Context) instead. Since v7.0.

Reindexes a collection of comments.

Specified by:

reIndexComments in interface IssueIndexingService

Parameters:

comments - a collection of Comment

context - used to report progress back to the user or to the logs. Must not be null.

Throws:

IndexException

Since:

v5.2

reIndexComments

@Deprecated
long reIndexComments(Collection<Comment> comments,
                                 Context context,
                                 boolean shouldReplicate)
                          throws IndexException

Deprecated. Call this as IssueIndexingService.reIndexComments(Collection, Context, boolean) instead. Since v7.0.

Reindexes a collection of comments.

Specified by:

reIndexComments in interface IssueIndexingService

Parameters:

comments - a collection of Comment

context - used to report progress back to the user or to the logs. Must not be null.

shouldReplicate - whether or not the index changes should be replicated to the other nodes in the cluster.

Throws:

IndexException

Since:

v6.1

reIndexWorklogs

@Deprecated
long reIndexWorklogs(Collection<Worklog> worklogs)
                          throws IndexException

Deprecated. Call this as IssueIndexingService.reIndexWorklogs(Collection) instead. Since v7.0.

Reindexes a collection of worklogs.

Specified by:

reIndexWorklogs in interface IssueIndexingService

Parameters:

worklogs - a collection of Worklogs

Throws:

IndexException

Since:

v6.4

reIndexWorklogs

@Deprecated
long reIndexWorklogs(Collection<Worklog> worklogs,
                                 Context context)
                          throws IndexException

Deprecated. Call this as IssueIndexingService.reIndexWorklogs(Collection, Context) instead. Since v7.0.

Reindexes a collection of worklogs.

Specified by:

reIndexWorklogs in interface IssueIndexingService

Parameters:

worklogs - a collection of Worklogs

context - used to report progress back to the user or to the logs. Must not be null.

Throws:

IndexException

Since:

v6.4

reIndexWorklogs

@Deprecated
long reIndexWorklogs(Collection<Worklog> worklogs,
                                 Context context,
                                 boolean shouldReplicate)
                          throws IndexException

Deprecated. Call this as IssueIndexingService.reIndexWorklogs(Collection, Context, boolean) instead. Since v7.0.

Reindexes a collection of worklogs.

Specified by:

reIndexWorklogs in interface IssueIndexingService

Parameters:

worklogs - a collection of Worklogs

context - used to report progress back to the user or to the logs. Must not be null.

shouldReplicate - whether or not the index changes should be replicated to the other nodes in the cluster.

Throws:

IndexException

Since:

v6.4

reIndexIssueObjects

@Deprecated
long reIndexIssueObjects(Collection<? extends Issue> issueObjects)
                              throws IndexException

Deprecated. Call this as IssueIndexingService.reIndexIssueObjects(Collection) instead. Since v7.0.

Reindex a set of issues.

Specified by:

reIndexIssueObjects in interface IssueIndexingService

Parameters:

issueObjects - Set of Issues to reindex.

Returns:

Reindex time in ms.

Throws:

IndexException

Since:

v5.2

reIndexIssueObjects

@Deprecated
long reIndexIssueObjects(Collection<? extends Issue> issueObjects,
                                     IssueIndexingParams issueIndexingParams)
                              throws IndexException

Deprecated. Call this as IssueIndexingService.reIndexIssueObjects(Collection, IssueIndexingParams) instead. Since v7.0.

Reindex a set of issues.

Specified by:

reIndexIssueObjects in interface IssueIndexingService

Parameters:

issueObjects - Set of Issues to reindex.

issueIndexingParams - Determines witch related objects should be indexed together with issues.

Returns:

Reindex time in ms.

Throws:

IndexException

Since:

v6.4

reIndexIssueObjects

@Deprecated
long reIndexIssueObjects(Collection<? extends Issue> issueObjects,
                                     IssueIndexingParams issueIndexingParams,
                                     boolean shouldReplicate)
                              throws IndexException

Deprecated. Call this as IssueIndexingService.reIndexIssueObjects(Collection, IssueIndexingParams, boolean) instead. Since v7.0.

Reindex a set of issues.

Specified by:

reIndexIssueObjects in interface IssueIndexingService

Parameters:

issueObjects - Set of Issues to reindex.

issueIndexingParams - Determines witch related objects should be indexed together with issues.

shouldReplicate - whether or not the index changes should be replicated to the other nodes in the cluster.

Returns:

Reindex time in ms.

Throws:

IndexException

Since:

v6.4

reIndexAll

@Deprecated
long reIndexAll(Context context,
                            boolean useBackgroundReindexing,
                            boolean reIndexComments,
                            boolean reIndexChangeHistory,
                            boolean notifyCluster)
                     throws IndexException

Deprecated. since v6.4 use reIndexAll(Context, boolean, IssueIndexingParams, boolean) instead. Since v7.0 use IssueIndexingService.reIndexAll(Context, boolean, IssueIndexingParams, boolean) instead.

Reindex all issues. If the useBackgroundReindexing option is set to true, then only the basic issue information will be reindexed, unless the reIndexComments or reIndexChangeHistory parameters are also set. This is considered the normal mode for background re-indexing and is sufficient to correct the index for changes in the system configuration, but not for changes to the indexing language. If useBackgroundReindexing is set to false, than everything is always reindexed.

Parameters:

context - used to report progress back to the user or to the logs. Must not be null

useBackgroundReindexing - whether to index in the background or not

reIndexComments - Also reindex all the issue comments. Only relevant for background reindex operations.

reIndexChangeHistory - Also reindex the issue change history. Only relevant for background reindex operations.

notifyCluster - whether or not to notify the cluster about reindexing all

Returns:

Reindex time in ms.

Throws:

IndexException

Since:

6.2

reIndex

@Deprecated
void reIndex(org.ofbiz.core.entity.GenericValue issue)
                  throws IndexException

Deprecated. Since v5.0. Use reIndex(Issue) instead. Since v7.0, use IssueIndexingService.reIndex(Issue) instead.

Reindex an issue (eg. after field updates).

Throws:

IndexException

reIndexIssues

@Deprecated
long reIndexIssues(IssuesIterable issuesIterable,
                               Context context,
                               boolean reIndexComments,
                               boolean reIndexChangeHistory)
                        throws IndexException

Deprecated. Since v6.4, use reIndexIssues(IssuesIterable, Context, IssueIndexingParams). Since v7.0, use IssueIndexingService.reIndexIssues(IssuesIterable, Context, IssueIndexingParams).

Reindex a list of issues, passing an optional event that will be set progress. This method can optionally also index the comments and change history.

Parameters:

issuesIterable - IssuesIterable

context - used to report progress back to the user or to the logs. Must not be null.

reIndexComments - a boolean indicating whether to index issue comments

reIndexChangeHistory - a boolean indicating whether to index issue change history

Returns:

Reindex time in ms.

Throws:

IndexException

Since:

v5.2

reIndex

@Deprecated
void reIndex(Issue issue,
                         boolean reIndexComments,
                         boolean reIndexChangeHistory)
                  throws IndexException

Deprecated. Since v6.4, use reIndex(Issue, IssueIndexingParams). Since v7.0, use IssueIndexingService.reIndex(Issue, IssueIndexingParams).

Reindex an issue (eg. after field updates).

Throws:

IndexException

Since:

v5.2

deIndex

@Deprecated
void deIndex(org.ofbiz.core.entity.GenericValue issue)
                  throws IndexException

Deprecated. Since v5.0 use IssueIndexingService.deIndex(Issue) instead. Since v7.0 use IssueIndexingService.deIndex(Issue) instead.

Remove an issue from the search index.

Throws:

IndexException

reIndexIssues

@Deprecated
long reIndexIssues(Collection<org.ofbiz.core.entity.GenericValue> issues)
                        throws IndexException

Deprecated. Since v5.0, use reIndexIssueObjects(Collection) instead. Since v7.0, use IssueIndexingService.reIndexIssueObjects(Collection) instead.

Reindex a set of issues (GenericValues). Use reIndexIssueObjects(Collection) instead when possible.

Parameters:

issues - The Issue GenericValues to reindex.

Returns:

Reindex time in ms.

Throws:

IndexException

reIndexIssueObjects

@Deprecated
long reIndexIssueObjects(Collection<? extends Issue> issueObjects,
                                     boolean reIndexComments,
                                     boolean reIndexChangeHistory)
                              throws IndexException

Deprecated. Since v6.4, use reIndexIssueObjects(Collection, IssueIndexingParams). Since v7.0, use IssueIndexingService.reIndexIssueObjects(Collection, IssueIndexingParams).

Reindex a set of issues.

Parameters:

issueObjects - Set of Issues to reindex.

Returns:

Reindex time in ms.

Throws:

IndexException

reIndexIssueObjects

@Deprecated
long reIndexIssueObjects(Collection<? extends Issue> issueObjects,
                                     boolean reIndexComments,
                                     boolean reIndexChangeHistory,
                                     boolean shouldReplicate)
                              throws IndexException

Deprecated. Since v6.4, use reIndexIssueObjects(Collection, IssueIndexingParams, boolean). Since v7.0, use IssueIndexingService.reIndexIssueObjects(Collection, IssueIndexingParams, boolean).

Reindex a set of issues.

Parameters:

issueObjects - Set of Issues to reindex.

reIndexComments - whether to reindex the comments or not

reIndexChangeHistory - whether to reindex changeHistory or not

shouldReplicate - whether or not the index changes should be replicated to the other nodes in the cluster.

Returns:

Reindex time in ms.

Throws:

IndexException

getLatestIndexDate

@Nullable
java.time.Instant getLatestIndexDate()

Gets the latest index date based on the most recent issue updated date.

Returns:

latest index update date or null if no issues in index or no updated value in issues