Package com.atlassian.jira.bc.project.index

Class OpenSearchProjectReindexServiceImpl

java.lang.Object

com.atlassian.jira.bc.project.index.OpenSearchProjectReindexServiceImpl

All Implemented Interfaces:

ProjectReindexService

public class OpenSearchProjectReindexServiceImpl
extends Object

OpenSearch-specific implementation of ProjectReindexService.

This service performs project reindexing without replication and ensures that only one reindexing task runs for a given project across the cluster.

Since:

11.1

Field Summary

Fields

Modifier and Type	Field	Description
protected final JiraAuthenticationContext	authenticationContext
protected final TaskManager	taskManager

Constructor Summary

Constructors

Constructor

Description

OpenSearchProjectReindexServiceImpl(JiraAuthenticationContext authenticationContext, TaskManager taskManager, IssueIndexer issueIndexer, OfBizDelegator ofBizDelegator, IssueBatcherFactory issueBatcherFactory, IssueManager issueManager, com.atlassian.event.api.EventPublisher eventPublisher, I18nHelper.BeanFactory i18nBeanFactory, ProjectEventHandler projectEventHandler, IssueDocumentSearchService issueDocumentSearchService)

Method Summary

Modifier and Type	Method	Description
protected I18nHelper	getI18nHelper()	Gets the I18nHelper instance.
TaskDescriptor<IndexCommandResult>	getRunningTask(Project project)
ProjectIndexTaskContext	getTaskContext(Project project)	Gets the task context for the given project.
protected String	getText(String key, String parameter)	Gets the localized text for the given key and parameter.
boolean	isReindexPossible(Project project)
String	reindex(Project project)	Reindexes the specified project without replication.
String	reindex(Project project, boolean shouldReplicate)	User should never call this method in OpenSearch environments.

Methods inherited from class java.lang.Object

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

Field Details

authenticationContext

protected final JiraAuthenticationContext authenticationContext

taskManager

protected final TaskManager taskManager

Constructor Details

OpenSearchProjectReindexServiceImpl

public OpenSearchProjectReindexServiceImpl(JiraAuthenticationContext authenticationContext,
 TaskManager taskManager,
 IssueIndexer issueIndexer,
 OfBizDelegator ofBizDelegator,
 IssueBatcherFactory issueBatcherFactory,
 IssueManager issueManager,
 com.atlassian.event.api.EventPublisher eventPublisher,
 I18nHelper.BeanFactory i18nBeanFactory,
 ProjectEventHandler projectEventHandler,
 IssueDocumentSearchService issueDocumentSearchService)

Method Details

reindex

public String reindex(Project project)

Reindexes the specified project without replication.

Parameters:

project - the project to reindex

Returns:

the progress URL for tracking the reindex operation

reindex

public String reindex(Project project,
 boolean shouldReplicate)

User should never call this method in OpenSearch environments.

Parameters:

project - the project needs to be re-indexed

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

Returns:

the project reindex progress url

getTaskContext

public ProjectIndexTaskContext getTaskContext(Project project)

Gets the task context for the given project.

This method must be implemented by subclasses to provide the appropriate task context based on their specific requirements (e.g., with or without node ID).

Parameters:

project - the project to get the task context for

Returns:

the task context

isReindexPossible

public boolean isReindexPossible(Project project)

Specified by:

isReindexPossible in interface ProjectReindexService

getRunningTask

@Nullable
public TaskDescriptor<IndexCommandResult> getRunningTask(Project project)

Specified by:

getRunningTask in interface ProjectReindexService

getText

protected String getText(String key,
 String parameter)

Gets the localized text for the given key and parameter.

Parameters:

key - the text key

parameter - the parameter to substitute

Returns:

the localized text

getI18nHelper

protected I18nHelper getI18nHelper()

Gets the I18nHelper instance.

Returns:

the I18nHelper instance