Package com.atlassian.jira.issue.index
Interface IssueIndexManager
- All Superinterfaces:
IndexLifecycleManager,IssueIndexingService,Shutdown,Sized
- All Known Subinterfaces:
JiraIndexManager
- All Known Implementing Classes:
BulkOnlyIndexManager,DefaultIndexManager,IndexManagerBase,OpenSearchJiraIndexManager
@Internal
@Deprecated(since="10.4",
forRemoval=true)
public interface IssueIndexManager
extends IndexLifecycleManager, IssueIndexingService
Deprecated, for removal: This API element is subject to removal in a future version.
Manages Lucene search indexes.
-
Method Summary
Modifier and TypeMethodDescriptionvoiddeIndex(org.ofbiz.core.entity.GenericValue issue) Deprecated.Since v5.0 useIssueIndexingService.deIndex(Issue)instead.org.apache.lucene.analysis.AnalyzerDeprecated, for removal: This API element is subject to removal in a future version.Returns anAnalyzerfor indexing.org.apache.lucene.analysis.AnalyzerDeprecated, for removal: This API element is subject to removal in a future version.Returns anAnalyzerfor searching.Deprecated, for removal: This API element is subject to removal in a future version.Get anIndexSearcherthat can be used to search the change history index.Deprecated, for removal: This API element is subject to removal in a future version.Get anIndexSearcherthat can be used to search the comment index.Deprecated, for removal: This API element is subject to removal in a future version.Returns a collection of Strings, each one representing the absolute path to the actual existing directory where a plugin keeps its indexes.Deprecated, for removal: This API element is subject to removal in a future version.Get anIndexSearcherthat can be used to search the issue index.Deprecated.since v11.1.Deprecated, for removal: This API element is subject to removal in a future version.Get the root path of the index directory for plugins.Deprecated, for removal: This API element is subject to removal in a future version.Get anIndexSearcherthat can be used to search the worklog index.voidhold()Deprecated, for removal: This API element is subject to removal in a future version.since v10.5.booleanisHeld()Deprecated, for removal: This API element is subject to removal in a future version.since v10.5.voidDeprecated.Call this asIssueIndexingService.reIndex(Issue)instead.voidDeprecated.Since v6.4, usereIndex(Issue, IssueIndexingParams).voidreIndex(Issue issue, IssueIndexingParams issueIndexingParams) Deprecated.Call this asIssueIndexingService.reIndex(Issue, IssueIndexingParams)instead.voidreIndex(org.ofbiz.core.entity.GenericValue issue) Deprecated.Since v5.0.longDeprecated.Call this asIndexLifecycleManager.reIndexAll(Context, IssueIndexingParams)()} instead.longreIndexAll(Context context, boolean useBackgroundReindexing, boolean notifyCluster) Deprecated.Call this asIndexLifecycleManager.reIndexAll(Context, IssueIndexingParams)()} instead.longreIndexAll(Context context, boolean useBackgroundReindexing, boolean reIndexComments, boolean reIndexChangeHistory, boolean notifyCluster) Deprecated.since v6.4 usereIndexAll(Context, boolean, IssueIndexingParams, boolean)instead.longreIndexAll(Context context, boolean useBackgroundReindexing, IssueIndexingParams issueIndexingParams, boolean notifyCluster) Deprecated.Call this asIndexLifecycleManager.reIndexAll(Context, IssueIndexingParams)()} instead.longreIndexComments(Collection<Comment> comments) Deprecated.Call this asIssueIndexingService.reIndexComments(Collection)instead.longreIndexComments(Collection<Comment> comments, Context context) Deprecated.Call this asIssueIndexingService.reIndexComments(Collection, Context)instead.longreIndexComments(Collection<Comment> comments, Context context, boolean shouldReplicate) Deprecated.Call this asIssueIndexingService.reIndexComments(Collection, Context, boolean)instead.longreIndexIssueObjects(Collection<? extends Issue> issueObjects) Deprecated.Call this asIssueIndexingService.reIndexIssueObjects(Collection)instead.longreIndexIssueObjects(Collection<? extends Issue> issueObjects, boolean reIndexComments, boolean reIndexChangeHistory) Deprecated.Since v6.4, usereIndexIssueObjects(Collection, IssueIndexingParams).longreIndexIssueObjects(Collection<? extends Issue> issueObjects, boolean reIndexComments, boolean reIndexChangeHistory, boolean shouldReplicate) Deprecated.Since v6.4, usereIndexIssueObjects(Collection, IssueIndexingParams, boolean).longreIndexIssueObjects(Collection<? extends Issue> issueObjects, IssueIndexingParams issueIndexingParams) Deprecated.Call this asIssueIndexingService.reIndexIssueObjects(Collection, IssueIndexingParams)instead.longreIndexIssueObjects(Collection<? extends Issue> issueObjects, IssueIndexingParams issueIndexingParams, boolean shouldReplicate) Deprecated.Call this asIssueIndexingService.reIndexIssueObjects(Collection, IssueIndexingParams, boolean)instead.longreIndexIssues(IssuesIterable issuesIterable, Context context) Deprecated.Call this asIssueIndexingService.reIndexIssues(IssuesIterable, Context)instead.longreIndexIssues(IssuesIterable issuesIterable, Context context, boolean reIndexComments, boolean reIndexChangeHistory) Deprecated.Since v6.4, usereIndexIssues(IssuesIterable, Context, IssueIndexingParams).longreIndexIssues(IssuesIterable issuesIterable, Context context, IssueIndexingParams issueIndexingParams) Deprecated.Call this asIssueIndexingService.reIndexIssues(IssuesIterable, Context, IssueIndexingParams)instead.longreIndexIssues(Collection<org.ofbiz.core.entity.GenericValue> issues) Deprecated.Since v5.0, usereIndexIssueObjects(Collection)instead.longreIndexWorklogs(Collection<Worklog> worklogs) Deprecated.Call this asIssueIndexingService.reIndexWorklogs(Collection)instead.longreIndexWorklogs(Collection<Worklog> worklogs, Context context) Deprecated.Call this asIssueIndexingService.reIndexWorklogs(Collection, Context)instead.longreIndexWorklogs(Collection<Worklog> worklogs, Context context, boolean shouldReplicate) Deprecated.Call this asIssueIndexingService.reIndexWorklogs(Collection, Context, boolean)instead.longrelease()Deprecated, for removal: This API element is subject to removal in a future version.since v10.5.booleanwithReindexLock(Runnable runnable) Deprecated, for removal: This API element is subject to removal in a future version.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, sizeMethods inherited from interface com.atlassian.jira.issue.index.IssueIndexingService
deIndex, deIndex, deIndex, deIndexComments, deIndexIssueObjects, deIndexIssueObjectsById, deIndexWorklogs, reIndexIssues
-
Method Details
-
getPluginsRootPath
String getPluginsRootPath()Deprecated, for removal: This API element is subject to removal in a future version.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()Deprecated, for removal: This API element is subject to removal in a future version.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. SeegetPluginsRootPath().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()Deprecated, for removal: This API element is subject to removal in a future version.Get anIndexSearcherthat can be used to search the issue index. This is specific to Lucene search platform, useIndexAccessorRegistryto get a platform-agnosticIndexSearcherinstead. -
getCommentSearcher
ManagedIndexSearcher getCommentSearcher()Deprecated, for removal: This API element is subject to removal in a future version.Get anIndexSearcherthat can be used to search the comment index. This is specific to Lucene search platform, useIndexAccessorRegistryto get a platform-agnosticIndexSearcherinstead. -
getChangeHistorySearcher
ManagedIndexSearcher getChangeHistorySearcher()Deprecated, for removal: This API element is subject to removal in a future version.Get anIndexSearcherthat can be used to search the change history index. This is specific to Lucene search platform, useIndexAccessorRegistryto get a platform-agnosticIndexSearcherinstead. -
getWorklogSearcher
ManagedIndexSearcher getWorklogSearcher()Deprecated, for removal: This API element is subject to removal in a future version.Get anIndexSearcherthat can be used to search the worklog index. This is specific to Lucene search platform, useIndexAccessorRegistryto get a platform-agnosticIndexSearcherinstead. -
getAnalyzerForSearching
org.apache.lucene.analysis.Analyzer getAnalyzerForSearching()Deprecated, for removal: This API element is subject to removal in a future version.Returns anAnalyzerfor searching.- Returns:
- an analyzer for searching
-
getAnalyzerForIndexing
org.apache.lucene.analysis.Analyzer getAnalyzerForIndexing()Deprecated, for removal: This API element is subject to removal in a future version.Returns anAnalyzerfor indexing.- Returns:
- an analyzer for indexing.
-
withReindexLock
Deprecated, for removal: This API element is subject to removal in a future version.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.Call this asIndexLifecycleManager.reIndexAll(Context, IssueIndexingParams)()} instead. Since v11.0.Reindex all issues.- Specified by:
reIndexAllin interfaceIssueIndexingService- Returns:
- Reindex time in ms.
- Throws:
IndexException
-
reIndexAll
@Deprecated long reIndexAll(Context context, boolean useBackgroundReindexing, boolean notifyCluster) throws IndexException Deprecated.Call this asIndexLifecycleManager.reIndexAll(Context, IssueIndexingParams)()} instead. Since v11.0.Reindex all issues.- Specified by:
reIndexAllin interfaceIssueIndexingService- Parameters:
context- used to report progress back to the user or to the logs. Must not be nulluseBackgroundReindexing- 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 asIndexLifecycleManager.reIndexAll(Context, IssueIndexingParams)()} instead. Since v11.0. 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:
reIndexAllin interfaceIssueIndexingService- Parameters:
context- used to report progress back to the user or to the logs. Must not be nulluseBackgroundReindexing- whether to index in the background or notissueIndexingParams- 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 asIssueIndexingService.reIndexIssues(IssuesIterable, Context)instead. Since v7.0.Reindex a list of issues, passing an optional event that will be set progress- Specified by:
reIndexIssuesin interfaceIssueIndexingService- Parameters:
issuesIterable- IssuesIterablecontext- 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 asIssueIndexingService.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:
reIndexIssuesin interfaceIssueIndexingService- Parameters:
issuesIterable- IssuesIterablecontext- 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.Call this asIssueIndexingService.reIndex(Issue)instead. Since v7.0.Reindex an issue (eg. after field updates).- Specified by:
reIndexin interfaceIssueIndexingService- Throws:
IndexException
-
reIndex
@Deprecated void reIndex(Issue issue, IssueIndexingParams issueIndexingParams) throws IndexException Deprecated.Call this asIssueIndexingService.reIndex(Issue, IssueIndexingParams)instead. Since v7.0.Reindex an issue (eg. after field updates).- Specified by:
reIndexin interfaceIssueIndexingService- Throws:
IndexException- Since:
- 6.3
-
reIndexComments
Deprecated.Call this asIssueIndexingService.reIndexComments(Collection)instead. Since v7.0.Reindexes a collection of comments.- Specified by:
reIndexCommentsin interfaceIssueIndexingService- 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 asIssueIndexingService.reIndexComments(Collection, Context)instead. Since v7.0.Reindexes a collection of comments.- Specified by:
reIndexCommentsin interfaceIssueIndexingService- Parameters:
comments- a collection of Commentcontext- 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 asIssueIndexingService.reIndexComments(Collection, Context, boolean)instead. Since v7.0.Reindexes a collection of comments.- Specified by:
reIndexCommentsin interfaceIssueIndexingService- Parameters:
comments- a collection of Commentcontext- 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.Call this asIssueIndexingService.reIndexWorklogs(Collection)instead. Since v7.0.Reindexes a collection of worklogs.- Specified by:
reIndexWorklogsin interfaceIssueIndexingService- 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 asIssueIndexingService.reIndexWorklogs(Collection, Context)instead. Since v7.0.Reindexes a collection of worklogs.- Specified by:
reIndexWorklogsin interfaceIssueIndexingService- Parameters:
worklogs- a collection of Worklogscontext- 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 asIssueIndexingService.reIndexWorklogs(Collection, Context, boolean)instead. Since v7.0.Reindexes a collection of worklogs.- Specified by:
reIndexWorklogsin interfaceIssueIndexingService- Parameters:
worklogs- a collection of Worklogscontext- 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 asIssueIndexingService.reIndexIssueObjects(Collection)instead. Since v7.0.Reindex a set of issues.- Specified by:
reIndexIssueObjectsin interfaceIssueIndexingService- Parameters:
issueObjects- Set ofIssues 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 asIssueIndexingService.reIndexIssueObjects(Collection, IssueIndexingParams)instead. Since v7.0.Reindex a set of issues.- Specified by:
reIndexIssueObjectsin interfaceIssueIndexingService- Parameters:
issueObjects- Set ofIssues 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 asIssueIndexingService.reIndexIssueObjects(Collection, IssueIndexingParams, boolean)instead. Since v7.0.Reindex a set of issues.- Specified by:
reIndexIssueObjectsin interfaceIssueIndexingService- Parameters:
issueObjects- Set ofIssues 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
-
getLatestIndexDate
Deprecated.since v11.1. UseIssueIndexingService.getLatestIndexDate()instead.Gets the latest index date based on the most recent issue updated date.- Specified by:
getLatestIndexDatein interfaceIssueIndexingService- Returns:
- latest index update date or null if no issues in index or no updated value in issues
-
reIndexAll
@Deprecated long reIndexAll(Context context, boolean useBackgroundReindexing, boolean reIndexComments, boolean reIndexChangeHistory, boolean notifyCluster) throws IndexException Deprecated.since v6.4 usereIndexAll(Context, boolean, IssueIndexingParams, boolean)instead. Since v7.0 useIssueIndexingService.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 nulluseBackgroundReindexing- whether to index in the background or notreIndexComments- 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.Since v5.0. UsereIndex(Issue)instead. Since v7.0, useIssueIndexingService.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, usereIndexIssues(IssuesIterable, Context, IssueIndexingParams). Since v7.0, useIssueIndexingService.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- IssuesIterablecontext- used to report progress back to the user or to the logs. Must not be null.reIndexComments- a boolean indicating whether to index issue commentsreIndexChangeHistory- 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, usereIndex(Issue, IssueIndexingParams). Since v7.0, useIssueIndexingService.reIndex(Issue, IssueIndexingParams).Reindex an issue (eg. after field updates).- Throws:
IndexException- Since:
- v5.2
-
deIndex
Deprecated.Since v5.0 useIssueIndexingService.deIndex(Issue)instead. Since v7.0 useIssueIndexingService.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, usereIndexIssueObjects(Collection)instead. Since v7.0, useIssueIndexingService.reIndexIssueObjects(Collection)instead.Reindex a set of issues (GenericValues). UsereIndexIssueObjects(Collection)instead when possible.- Parameters:
issues- The IssueGenericValues 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, usereIndexIssueObjects(Collection, IssueIndexingParams). Since v7.0, useIssueIndexingService.reIndexIssueObjects(Collection, IssueIndexingParams).Reindex a set of issues.- Parameters:
issueObjects- Set ofIssues 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.Reindex a set of issues.- Parameters:
issueObjects- Set ofIssues to reindex.reIndexComments- whether to reindex the comments or notreIndexChangeHistory- whether to reindex changeHistory or notshouldReplicate- whether or not the index changes should be replicated to the other nodes in the cluster.- Returns:
- Reindex time in ms.
- Throws:
IndexException
-
hold
Deprecated, for removal: This API element is subject to removal in a future version.since v10.5. UseIssueIndexingService.hold()instead.Temporarily suspend indexing on this thread. All index requests will be queued and processed when release is called.- Specified by:
holdin interfaceIssueIndexingService- Since:
- v5.1
-
isHeld
Deprecated, for removal: This API element is subject to removal in a future version.since v10.5. UseIssueIndexingService.isHeld()instead.Return true if the index is held on this thread.- Specified by:
isHeldin interfaceIssueIndexingService- Since:
- v5.1
-
release
Deprecated, for removal: This API element is subject to removal in a future version.since v10.5. UseIssueIndexingService.release()instead.Release indexing on this thread. All queued index requests will be processed.- Specified by:
releasein interfaceIssueIndexingService- Returns:
- Reindex time in ms.
- Throws:
IndexException- if an error occurs- Since:
- v5.1
-
IssueIndexingService,IndexLifecycleManagerorIndexAccessor. For internal usage,IssueIndexeris also available. It will remain in Jira 11 for internal usage by Jira while Lucene is a supported search platform. This interface only has a Lucene implementation, so should only be used by components that are active only when the search platform is Lucene Not intended for use by 3rd party plugins.