Summary: Methods | [Expand All]
@InjectableComponent @PublicApi public interface

IssueIndexingService

com.atlassian.jira.issue.index.IssueIndexingService
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Provides services related to the indexing of issue data. This service largely replaces the IssueIndexManager that previously provided those services.

Summary

Public Methods
void deIndex(Issue issue)
Remove an issue from the search index.
void deIndexIssueObjects(Set<Issue> issuesToDelete, boolean updateReplicatedIndexStore)
Remove a set of issues from the search index.
void reIndex(Issue issue)
Reindex an issue (eg.
void reIndex(Issue issue, IssueIndexingParams issueIndexingParams)
Reindex an issue (eg.
long reIndexAll()
Reindex all issues.
long reIndexAll(Context context, boolean useBackgroundReindexing, IssueIndexingParams issueIndexingParams, boolean updateReplicatedIndexStore)
Reindex all issues.
long reIndexAll(Context context, boolean useBackgroundReindexing, boolean updateReplicatedIndexStore)
Reindex all issues.
long reIndexComments(Collection<Comment> comments, Context context, boolean updateReplicatedIndexStore)
Reindexes a collection of comments.
long reIndexComments(Collection<Comment> comments)
Reindexes a collection of comments.
long reIndexComments(Collection<Comment> comments, Context context)
Reindexes a collection of comments.
long reIndexIssueObjects(Collection<? extends Issue> issueObjects, IssueIndexingParams issueIndexingParams, boolean updateReplicatedIndexStore)
Reindex a set of issues.
long reIndexIssueObjects(Collection<? extends Issue> issueObjects, IssueIndexingParams issueIndexingParams)
Reindex a set of issues.
long reIndexIssueObjects(Collection<? extends Issue> issueObjects)
Reindex a set of issues.
long reIndexIssues(IssuesIterable issuesIterable, Context context, IssueIndexingParams issueIndexingParams)
Reindex a list of issues, passing an optional event that will be set progress.
long reIndexIssues(IssuesIterable issuesIterable, Context context)
Reindex a list of issues, passing an optional event that will be set progress
long reIndexWorklogs(Collection<Worklog> worklogs)
Reindexes a collection of worklogs.
long reIndexWorklogs(Collection<Worklog> worklogs, Context context, boolean updateReplicatedIndexStore)
Reindexes a collection of worklogs.
long reIndexWorklogs(Collection<Worklog> worklogs, Context context)
Reindexes a collection of worklogs.

Public Methods

public void deIndex (Issue issue)

Remove an issue from the search index.

Throws
IndexException

public void deIndexIssueObjects (Set<Issue> issuesToDelete, boolean updateReplicatedIndexStore)

Remove a set of issues from the search index.

Throws
IndexException

public void reIndex (Issue issue)

Reindex an issue (eg. after field updates).

Throws
IndexException

public void reIndex (Issue issue, IssueIndexingParams issueIndexingParams)

Reindex an issue (eg. after field updates).

Throws
IndexException

public long reIndexAll ()

Reindex all issues.

Returns
  • Reindex time in ms.
Throws
IndexException

public long reIndexAll (Context context, boolean useBackgroundReindexing, IssueIndexingParams issueIndexingParams, boolean updateReplicatedIndexStore)

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.

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.
updateReplicatedIndexStore whether to update the replicated index or not
Returns
  • Reindex time in ms.
Throws
IndexException

public long reIndexAll (Context context, boolean useBackgroundReindexing, boolean updateReplicatedIndexStore)

Reindex all issues.

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.
updateReplicatedIndexStore whether to update the replicated index or not
Returns
  • Reindex time in ms.
Throws
IndexException

public long reIndexComments (Collection<Comment> comments, Context context, boolean updateReplicatedIndexStore)

Reindexes a collection of comments.

Parameters
comments a collection of Comment
context used to report progress back to the user or to the logs. Must not be null.
updateReplicatedIndexStore whether to update the replicated index or not
Throws
IndexException

public long reIndexComments (Collection<Comment> comments)

Reindexes a collection of comments.

Parameters
comments a collection of Comment
Throws
IndexException

public long reIndexComments (Collection<Comment> comments, Context context)

Reindexes a collection of comments.

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

public long reIndexIssueObjects (Collection<? extends Issue> issueObjects, IssueIndexingParams issueIndexingParams, boolean updateReplicatedIndexStore)

Reindex a set of issues.

Parameters
issueObjects Set of Issues to reindex.
issueIndexingParams Determines witch related objects should be indexed together with issues.
updateReplicatedIndexStore whether to store index operations in the replicated index store
Returns
  • Reindex time in ms.
Throws
IndexException

public long reIndexIssueObjects (Collection<? extends Issue> issueObjects, IssueIndexingParams issueIndexingParams)

Reindex a set of issues.

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

public long reIndexIssueObjects (Collection<? extends Issue> issueObjects)

Reindex a set of issues.

Parameters
issueObjects Set of Issues to reindex.
Returns
  • Reindex time in ms.
Throws
IndexException

public long reIndexIssues (IssuesIterable issuesIterable, Context context, IssueIndexingParams 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.
issueIndexingParams determines witch related objects should be indexed together with issue.
Returns
  • Reindex time in ms.
Throws
IndexException

public long reIndexIssues (IssuesIterable issuesIterable, Context context)

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

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

public long reIndexWorklogs (Collection<Worklog> worklogs)

Reindexes a collection of worklogs.

Parameters
worklogs a collection of Worklogs
Throws
IndexException

public long reIndexWorklogs (Collection<Worklog> worklogs, Context context, boolean updateReplicatedIndexStore)

Reindexes a collection of worklogs.

Parameters
worklogs a collection of Worklogs
context used to report progress back to the user or to the logs. Must not be null.
updateReplicatedIndexStore whether to update the replicated index or not
Throws
IndexException

public long reIndexWorklogs (Collection<Worklog> worklogs, Context context)

Reindexes a collection of worklogs.

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