Package com.atlassian.jira.issue.index

Class DefaultIssueIndexer

java.lang.Object

com.atlassian.jira.issue.index.DefaultIssueIndexer

All Implemented Interfaces:

BackupContributor, IssueIndexer, UnmanagedIndexSearcherProvider

@Internal
public class DefaultIssueIndexer
extends Object
implements IssueIndexer

A legacy implementation of IssueIndexer for Lucene

Platform-specific class intended for the Lucene search platform only.

Jira Search exposes a common API backed by multiple search engines. This class bypasses that abstraction and couples callers to Lucene internals.

Using this class when the runtime search platform is not Lucene (e.g. OpenSearch) may produce incorrect results or failures.

For platform-agnostic usage, use OpenSearchIssueIndexer which works across all supported search platforms.

Internal use only.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DefaultIssueIndexer.ChangeHistoryRetriever
static interface	DefaultIssueIndexer.CommentRetriever
class	DefaultIssueIndexer.Documents
static interface	DefaultIssueIndexer.EntityRetriever<T extends WithId>
static interface	DefaultIssueIndexer.WorklogRetriever

Nested classes/interfaces inherited from interface com.atlassian.jira.issue.index.IssueIndexer

IssueIndexer.Analyzers

Constructor Summary

Constructors

Constructor

Description

DefaultIssueIndexer(IndexDirectoryFactory indexDirectoryFactory, DefaultIssueIndexer.CommentRetriever commentRetriever, DefaultIssueIndexer.ChangeHistoryRetriever changeHistoryRetriever, DefaultIssueIndexer.WorklogRetriever worklogRetriever, ApplicationProperties applicationProperties, IssueDocumentFactory issueDocumentFactory, CommentDocumentFactory commentDocumentFactory, ChangeHistoryDocumentFactory changeHistoryDocumentFactory, WorklogDocumentFactory worklogDocumentFactory, IssueManager issueManager, IndexBackupContributionStrategy backupPreparationStrategy, IndexBackupContributorsManager indexBackupContributorsManager, DBRSender dbrSender, EntityVersioningManager entityVersioningManager, ReplicatedIndexManager replicatedIndexManager, IndexingFeatures indexingFeatures, IndexingLimitsStats indexingLimitsStats, com.atlassian.event.api.EventPublisher eventPublisher, DocumentMapper documentMapper)

Method Summary

Modifier and Type	Method	Description
Index.Result	conditionalUpdateWithVersion(IndexDirectoryFactory.Name indexName, org.apache.lucene.document.Document document)	Index a Document conditionally based on the entity id and the version which are resolved by IndexDirectoryFactory.Name.getEntityIdFromDocument(Document) and IndexDirectoryFactory.Name.getEntityVersionFromDocument(Document)
Index.Result	conditionalUpdateWithVersion(org.apache.lucene.document.Document issueDocument, Collection<org.apache.lucene.document.Document> commentDocuments, Collection<org.apache.lucene.document.Document> changeHistoryDocuments, Collection<org.apache.lucene.document.Document> worklogDocuments)	Index an issue document with its related documents conditionally based on the entity ids and the versions which are resolved by IndexDirectoryFactory.Name.getEntityIdFromDocument(Document) and IndexDirectoryFactory.Name.getEntityVersionFromDocument(Document)
void	contributeToBackup(BackupBuilder backupBuilder)	Contribute a set of files to the given backupBuilder to include them in the backup being created when this method was called.
Index.Result	deindexComments(Collection<? extends WithId> comments, Context context, boolean shouldReplicate)
Index.Result	deindexIssues(Collection<? extends WithId> issues, Context context)	Delete any existing documents (in the issue index invalid input: '&' all related entity indexes) for the Issues represented by the supplied WithIds
Index.Result	deindexIssues(Collection<? extends WithId> issues, Context context, boolean shouldReplicate)	Delete any existing documents (in the issue index invalid input: '&' all related entity indexes) for the Issues represented by the supplied WithIds
Index.Result	deIndexProject(Project project, boolean shouldReplicate)	Remove all documents connected with given project
Index.Result	deindexWorklogs(Collection<? extends WithId> worklogs, Context context, boolean shouldReplicate)
void	deleteIndexes()	Delete all indexes.
void	deleteIndexes(IssueIndexingParams issueIndexingParams)	Delete selected indexes.
List<String>	getIndexPaths()
String	getIndexRootPath()
int	getNumberOfIndexingThreads()	Gets number of indexing threads.
Index.Result	indexDocument(IndexRequest indexRequest)	Index a document using the provided IndexRequest.
Index.Result	indexIssues(EnclosedIterable<Issue> issues, Context context, IssueIndexingParams issueIndexingParams)	Add documents for the supplied issues.
AccumulatingResultBuilder	indexIssuesBatchMode(IssuesBatcher batcher, Context context, IssueIndexingParams issueIndexingParams)	No other index operations should be called while this method is being called
UnmanagedIndexSearcher	openEntitySearcher(IndexDirectoryFactory.Name index)	Issue searcher has to be closed after doing stuff.
Index.Result	optimize()
Index.Result	reindexComments(Collection<Comment> comments, Context context, boolean shouldReplicate)	Reindex a collection of issue comments.
Index.Result	reindexCommentsInParallel(Collection<Comment> comments, Context context)	Reindex a collection of issue comments on multiple threads.
Index.Result	reindexIssues(EnclosedIterable<Issue> issues, Context context, IssueIndexingParams issueIndexingParams, boolean conditionalUpdate, boolean shouldReplicate)	Re-index the given issues, delete any existing documents and add new ones.
AccumulatingResultBuilder	reindexIssuesBatchMode(IssuesBatcher batcher, Context context, IssueIndexingParams issueIndexingParams)	No other index operations should be called while this method is being called
Index.Result	reindexWorklogs(Collection<Worklog> worklogs, Context context, boolean shouldReplicate)
Index.Result	reindexWorklogsInParallel(Collection<Worklog> worklogs, Context context)	Reindex a collection of issue worklogs on multiple threads.
void	shutdown()

Methods inherited from class java.lang.Object

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

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

deindexComments, deindexWorklogs, reindexComments, reindexWorklogs

Constructor Details

DefaultIssueIndexer

public DefaultIssueIndexer(@Nonnull
 IndexDirectoryFactory indexDirectoryFactory,
 @Nonnull
 DefaultIssueIndexer.CommentRetriever commentRetriever,
 @Nonnull
 DefaultIssueIndexer.ChangeHistoryRetriever changeHistoryRetriever,
 @Nonnull
 DefaultIssueIndexer.WorklogRetriever worklogRetriever,
 @Nonnull
 ApplicationProperties applicationProperties,
 @Nonnull
 IssueDocumentFactory issueDocumentFactory,
 @Nonnull
 CommentDocumentFactory commentDocumentFactory,
 @Nonnull
 ChangeHistoryDocumentFactory changeHistoryDocumentFactory,
 @Nonnull
 WorklogDocumentFactory worklogDocumentFactory,
 @Nonnull
 IssueManager issueManager,
 @Nonnull
 IndexBackupContributionStrategy backupPreparationStrategy,
 @Nullable
 IndexBackupContributorsManager indexBackupContributorsManager,
 @Nonnull
 DBRSender dbrSender,
 @Nonnull
 EntityVersioningManager entityVersioningManager,
 @Nonnull
 ReplicatedIndexManager replicatedIndexManager,
 @Nonnull
 IndexingFeatures indexingFeatures,
 @Nonnull
 IndexingLimitsStats indexingLimitsStats,
 @Nonnull
 com.atlassian.event.api.EventPublisher eventPublisher,
 @Nonnull
 DocumentMapper documentMapper)

Method Details

getNumberOfIndexingThreads

public int getNumberOfIndexingThreads()

Description copied from interface: IssueIndexer

Gets number of indexing threads.

Configured by 'jira.index.issue.threads'.

Specified by:

getNumberOfIndexingThreads in interface IssueIndexer

Returns:

the number of indexing threads.

deindexIssues

public Index.Result deindexIssues(@Nonnull
 Collection<? extends WithId> issues,
 @Nonnull
 Context context)

Description copied from interface: IssueIndexer

Delete any existing documents (in the issue index invalid input: '&' all related entity indexes) for the Issues represented by the supplied WithIds

Specified by:

deindexIssues in interface IssueIndexer

Parameters:

issues - An iterable of WithIds for the Issues to de-index.

context - for showing the user the current status.

deindexIssues

public Index.Result deindexIssues(@Nonnull
 Collection<? extends WithId> issues,
 @Nonnull
 Context context,
 boolean shouldReplicate)

Description copied from interface: IssueIndexer

Delete any existing documents (in the issue index invalid input: '&' all related entity indexes) for the Issues represented by the supplied WithIds

Specified by:

deindexIssues in interface IssueIndexer

Parameters:

issues - An iterable of WithIds for the Issues to de-index.

context - for showing the user the current status.

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

deIndexProject

public Index.Result deIndexProject(Project project,
 boolean shouldReplicate)

Description copied from interface: IssueIndexer

Remove all documents connected with given project

Specified by:

deIndexProject in interface IssueIndexer

Parameters:

project - project object

shouldReplicate -

indexIssues

public Index.Result indexIssues(@Nonnull
 EnclosedIterable<Issue> issues,
 @Nonnull
 Context context,
 @Nonnull
 IssueIndexingParams issueIndexingParams)

Description copied from interface: IssueIndexer

Add documents for the supplied issues.

Specified by:

indexIssues in interface IssueIndexer

Parameters:

issues - An iterable of issues to index.

context - for showing the user the current status.

issueIndexingParams - parameters describing what should be reindexed

indexIssuesBatchMode

public AccumulatingResultBuilder indexIssuesBatchMode(@Nonnull
 IssuesBatcher batcher,
 @Nonnull
 Context context,
 @Nonnull
 IssueIndexingParams issueIndexingParams)

No other index operations should be called while this method is being called

Specified by:

indexIssuesBatchMode in interface IssueIndexer

Parameters:

batcher - An iterable over issue batches.

context - for showing the user the current status.

issueIndexingParams - parameters describing what should be reindexed

reindexIssuesBatchMode

public AccumulatingResultBuilder reindexIssuesBatchMode(@Nonnull
 IssuesBatcher batcher,
 @Nonnull
 Context context,
 @Nonnull
 IssueIndexingParams issueIndexingParams)

No other index operations should be called while this method is being called

Specified by:

reindexIssuesBatchMode in interface IssueIndexer

Parameters:

batcher - an iterable over issue batches.

context - for showing the user the current status.

issueIndexingParams - parameters describing what should be reindexed

reindexIssues

public Index.Result reindexIssues(@Nonnull
 EnclosedIterable<Issue> issues,
 @Nonnull
 Context context,
 @Nonnull
 IssueIndexingParams issueIndexingParams,
 boolean conditionalUpdate,
 boolean shouldReplicate)

Description copied from interface: IssueIndexer

Re-index the given issues, delete any existing documents and add new ones.

Specified by:

reindexIssues in interface IssueIndexer

Parameters:

issues - An iterable of issues to index.

context - for showing the user the current status.

issueIndexingParams - parameters describing what should be reindexed

conditionalUpdate - set to true to use conditional updates when writing to the index

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

reindexComments

public Index.Result reindexComments(@Nonnull
 Collection<Comment> comments,
 @Nonnull
 Context context,
 boolean shouldReplicate)

Description copied from interface: IssueIndexer

Reindex a collection of issue comments.

Specified by:

reindexComments in interface IssueIndexer

Parameters:

comments - Comments to be reindexed.

context - for showing the user the current status.

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

reindexCommentsInParallel

public Index.Result reindexCommentsInParallel(@Nonnull
 Collection<Comment> comments,
 @Nonnull
 Context context)

Description copied from interface: IssueIndexer

Reindex a collection of issue comments on multiple threads. This will not replicate the comments to the other nodes in cluster. As this method does not use conditional updates, it must be executed under index write lock.

Specified by:

reindexCommentsInParallel in interface IssueIndexer

Parameters:

comments - Comments to be reindexed.

context - for showing the user the current status.

reindexWorklogsInParallel

public Index.Result reindexWorklogsInParallel(@Nonnull
 Collection<Worklog> worklogs,
 @Nonnull
 Context context)

Description copied from interface: IssueIndexer

Reindex a collection of issue worklogs on multiple threads. This will not replicate the worklogs to the other nodes in cluster. As this method does not use conditional updates, it must be executed under index write lock.

Specified by:

reindexWorklogsInParallel in interface IssueIndexer

Parameters:

worklogs - Worklogs to be reindexed.

context - for showing the user the current status.

reindexWorklogs

public Index.Result reindexWorklogs(@Nonnull
 Collection<Worklog> worklogs,
 @Nonnull
 Context context,
 boolean shouldReplicate)

Specified by:

reindexWorklogs in interface IssueIndexer

deindexComments

public Index.Result deindexComments(@Nonnull
 Collection<? extends WithId> comments,
 @Nonnull
 Context context,
 boolean shouldReplicate)

Specified by:

deindexComments in interface IssueIndexer

deindexWorklogs

public Index.Result deindexWorklogs(@Nonnull
 Collection<? extends WithId> worklogs,
 @Nonnull
 Context context,
 boolean shouldReplicate)

Specified by:

deindexWorklogs in interface IssueIndexer

conditionalUpdateWithVersion

public Index.Result conditionalUpdateWithVersion(IndexDirectoryFactory.Name indexName,
 org.apache.lucene.document.Document document)

Description copied from interface: IssueIndexer

Index a Document conditionally based on the entity id and the version which are resolved by IndexDirectoryFactory.Name.getEntityIdFromDocument(Document) and IndexDirectoryFactory.Name.getEntityVersionFromDocument(Document)

Specified by:

conditionalUpdateWithVersion in interface IssueIndexer

Parameters:

indexName - define the target index

document - the document needs to be indexed

conditionalUpdateWithVersion

public Index.Result conditionalUpdateWithVersion(org.apache.lucene.document.Document issueDocument,
 Collection<org.apache.lucene.document.Document> commentDocuments,
 Collection<org.apache.lucene.document.Document> changeHistoryDocuments,
 Collection<org.apache.lucene.document.Document> worklogDocuments)

Description copied from interface: IssueIndexer

Index an issue document with its related documents conditionally based on the entity ids and the versions which are resolved by IndexDirectoryFactory.Name.getEntityIdFromDocument(Document) and IndexDirectoryFactory.Name.getEntityVersionFromDocument(Document)

Specified by:

conditionalUpdateWithVersion in interface IssueIndexer

Parameters:

issueDocument - issue document needs to be indexed

commentDocuments - issue's comment documents

changeHistoryDocuments - issue's history change documents

worklogDocuments - issue's worklog documents

indexDocument

public Index.Result indexDocument(IndexRequest indexRequest)

Description copied from interface: IssueIndexer

Index a document using the provided IndexRequest.

WARNING: This method bypasses the standard JIRA versioning flow and should be used with extreme caution. It does not automatically manage entity versions through the EntityVersioningManager, which can lead to version conflicts and inconsistent index state if the same entity is updated through normal JIRA operations.

Recommended Usage: This method should only be used in controlled scenarios where:

• The caller explicitly manages document versioning
• Testing or development scenarios where version conflicts are acceptable

Specified by:

indexDocument in interface IssueIndexer

Parameters:

indexRequest - the request containing the document ID, optional version, document type, and field values to be indexed. Must not be null.

Returns:

the result of the indexing operation

deleteIndexes

public void deleteIndexes()

Description copied from interface: IssueIndexer

Delete all indexes.

Specified by:

deleteIndexes in interface IssueIndexer

deleteIndexes

public void deleteIndexes(@Nonnull
 IssueIndexingParams issueIndexingParams)

Description copied from interface: IssueIndexer

Delete selected indexes.

Specified by:

deleteIndexes in interface IssueIndexer

Parameters:

issueIndexingParams - parameters describing which indexes should be deleted.

openEntitySearcher

public UnmanagedIndexSearcher openEntitySearcher(IndexDirectoryFactory.Name index)

Description copied from interface: UnmanagedIndexSearcherProvider

Issue searcher has to be closed after doing stuff. Note: when doing this you need to have the index read lock, as this may trigger creating index when not there; See IndexManagerBase.indexLock. See IndexManagerBase.getEntitySearcher(IndexDirectoryFactory.Name) ()}.

Specified by:

openEntitySearcher in interface UnmanagedIndexSearcherProvider

optimize

public Index.Result optimize()

Specified by:

optimize in interface IssueIndexer

shutdown

public void shutdown()

Specified by:

shutdown in interface IssueIndexer

getIndexPaths

public List<String> getIndexPaths()

Specified by:

getIndexPaths in interface IssueIndexer

getIndexRootPath

public String getIndexRootPath()

Specified by:

getIndexRootPath in interface IssueIndexer

contributeToBackup

public void contributeToBackup(BackupBuilder backupBuilder)

Description copied from interface: BackupContributor

Contribute a set of files to the given backupBuilder to include them in the backup being created when this method was called.

Specified by:

contributeToBackup in interface BackupContributor

Parameters:

backupBuilder - builder of the backup being created at the time of call. All existing and nonempty files passed to its accept method will be included. The builder may not be reusable and the reference should not be stored outside the scope of this method