com.atlassian.jira.issue.index

Interface IssueIndexingService

All Known Subinterfaces:

IssueIndexManager

All Known Implementing Classes:

BulkOnlyIndexManager, DefaultIndexManager

@InjectableComponent
 @PublicApi
public interface IssueIndexingService

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

Since:

v7.0

Method Summary

Modifier and Type	Method and Description
void	deIndex(Issue issue) Remove an issue from the search index.
void	deIndex(Project project, boolean updateReplicatedIndexStore) Deindexing issues from a given project
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, boolean updateReplicatedIndexStore) Reindex all issues.
long	reIndexAll(Context context, boolean useBackgroundReindexing, IssueIndexingParams issueIndexingParams, boolean updateReplicatedIndexStore) Reindex all issues.
long	reIndexComments(Collection<Comment> comments) Reindexes a collection of comments.
long	reIndexComments(Collection<Comment> comments, Context context) Reindexes a collection of comments.
long	reIndexComments(Collection<Comment> comments, Context context, boolean updateReplicatedIndexStore) Reindexes a collection of comments.
long	reIndexIssueObjects(Collection<? extends Issue> issueObjects) Reindex a set of issues.
long	reIndexIssueObjects(Collection<? extends Issue> issueObjects, IssueIndexingParams issueIndexingParams) Reindex a set of issues.
long	reIndexIssueObjects(Collection<? extends Issue> issueObjects, IssueIndexingParams issueIndexingParams, boolean updateReplicatedIndexStore) Reindex a set of issues.
long	reIndexIssues(IssuesIterable issuesIterable, Context context) Reindex a list of issues, passing an optional event that will be set progress
long	reIndexIssues(IssuesIterable issuesIterable, Context context, IssueIndexingParams issueIndexingParams) 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) Reindexes a collection of worklogs.
long	reIndexWorklogs(Collection<Worklog> worklogs, Context context, boolean updateReplicatedIndexStore) Reindexes a collection of worklogs.

Method Detail

reIndexAll

long reIndexAll()
         throws IndexException

Reindex all issues.

Returns:

Reindex time in ms.

Throws:

IndexException

reIndexAll

long reIndexAll(Context context,
                boolean useBackgroundReindexing,
                boolean updateReplicatedIndexStore)
         throws IndexException

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

reIndexAll

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

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

reIndexIssues

long reIndexIssues(IssuesIterable issuesIterable,
                   Context context)
            throws IndexException

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

reIndexIssues

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

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

reIndex

void reIndex(Issue issue)
      throws IndexException

Reindex an issue (eg. after field updates).

Throws:

IndexException

reIndex

void reIndex(Issue issue,
             IssueIndexingParams issueIndexingParams)
      throws IndexException

Reindex an issue (eg. after field updates).

Throws:

IndexException

reIndexComments

long reIndexComments(Collection<Comment> comments)
              throws IndexException

Reindexes a collection of comments.

Parameters:

comments - a collection of Comment

Throws:

IndexException

reIndexComments

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

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

reIndexComments

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

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

reIndexWorklogs

long reIndexWorklogs(Collection<Worklog> worklogs)
              throws IndexException

Reindexes a collection of worklogs.

Parameters:

worklogs - a collection of Worklogs

Throws:

IndexException

reIndexWorklogs

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

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

reIndexWorklogs

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

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

deIndex

void deIndex(Issue issue)
      throws IndexException

Remove an issue from the search index.

Throws:

IndexException

deIndexIssueObjects

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

Remove a set of issues from the search index.

Throws:

IndexException

reIndexIssueObjects

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

Reindex a set of issues.

Parameters:

issueObjects - Set of Issues to reindex.

Returns:

Reindex time in ms.

Throws:

IndexException

reIndexIssueObjects

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

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

reIndexIssueObjects

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

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

deIndex

void deIndex(Project project,
             boolean updateReplicatedIndexStore)

Deindexing issues from a given project

Parameters:

project - project object

updateReplicatedIndexStore - whether to store index operations in the replicated index store