com.atlassian.jira.issue.index

Class DefaultIssueIndexer

java.lang.Object

com.atlassian.jira.issue.index.DefaultIssueIndexer

All Implemented Interfaces:

BackupContributor, IssueIndexer, UnmanagedIndexSearcherProvider

public class DefaultIssueIndexer
extends Object
implements IssueIndexer

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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 and 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, IndexPathManager indexPathManager, IndexBackupContributionStrategy backupPreparationStrategy, IndexBackupContributorsManager indexBackupContributorsManager, DBRSender dbrSender, EntityVersioningManager entityVersioningManager, ReplicatedIndexManager replicatedIndexManager, IndexingFeatures indexingFeatures)

Method Summary

Modifier and Type	Method and Description
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)
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)
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 & 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 & 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()
Index.Result	indexIssues(EnclosedIterable<Issue> issues, Context context) Add documents for the supplied issues.
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	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.
Index.Result	reindexWorklogs(Collection<Worklog> worklogs, Context context, boolean shouldReplicate)
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

deindexIssues

Constructor Detail

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
                           IndexPathManager indexPathManager,
                           @Nonnull
                           IndexBackupContributionStrategy backupPreparationStrategy,
                           @Nullable
                           IndexBackupContributorsManager indexBackupContributorsManager,
                           @Nonnull
                           DBRSender dbrSender,
                           @Nonnull
                           EntityVersioningManager entityVersioningManager,
                           @Nonnull
                           ReplicatedIndexManager replicatedIndexManager,
                           @Nonnull
                           IndexingFeatures indexingFeatures)

Method Detail

getNumberOfIndexingThreads

public int getNumberOfIndexingThreads()

deindexIssues

@GuardedBy(value="external index read lock")
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 & 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

@GuardedBy(value="external index read lock")
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 & 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 or not 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

indexIssues

@GuardedBy(value="external index read lock")
public Index.Result indexIssues(@Nonnull
                                                                             EnclosedIterable<Issue> issues,
                                                                             @Nonnull
                                                                             Context context)

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.

indexIssues

@GuardedBy(value="external index read lock")
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

@GuardedBy(value="external index write lock")
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

reindexIssues

@GuardedBy(value="external index read lock")
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

@GuardedBy(value="external index read lock")
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.

reindexWorklogs

@GuardedBy(value="external index read lock")
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

@GuardedBy(value="external index read lock")
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

@GuardedBy(value="external index read lock")
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

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 DefaultIndexManager.indexLock. See DefaultIndexManager.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