Package com.atlassian.jira.functest.framework.backdoor

Class IndexingControl

java.lang.Object

com.atlassian.jira.testkit.client.RestApiClient<IndexingControl>

com.atlassian.jira.testkit.client.BackdoorControl<IndexingControl>

com.atlassian.jira.functest.framework.backdoor.BackdoorControl<IndexingControl>

com.atlassian.jira.functest.framework.backdoor.IndexingControl

public class IndexingControl
extends BackdoorControl<IndexingControl>

Backdoor control for indexing.

Since:

v5.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	IndexingControl.IndexingProgress

Nested classes/interfaces inherited from class com.atlassian.jira.testkit.client.RestApiClient

com.atlassian.jira.testkit.client.RestApiClient.BackdoorLoggingFilter, com.atlassian.jira.testkit.client.RestApiClient.JsonMediaTypeFilter, com.atlassian.jira.testkit.client.RestApiClient.RestCall, com.atlassian.jira.testkit.client.RestApiClient.SessionlessConsistencyFilter

Field Summary

Fields inherited from class com.atlassian.jira.testkit.client.BackdoorControl

API_REST_PATH, API_REST_VERSION, DEFAULT_REST_PATH, logger, rootPath

Fields inherited from class com.atlassian.jira.testkit.client.RestApiClient

REST_VERSION

Constructor Summary

Constructors

Constructor	Description
IndexingControl(JIRAEnvironmentData environmentData)

Method Summary

Modifier and Type	Method	Description
void	callPeriodicStats()
Long	clearPendingReindexRequests()
void	deindex(String issueKey)
void	deleteIndex()
void	deleteIndexDirectory(boolean issues, boolean comments, boolean worklogs, boolean history)
IndexingControl.IndexingProgress	getInBackgroundProgress()
int	getIndexingTaskProgress(String taskId)
IndexingControl.IndexingProgress	getProjectIndexingProgress(Long projectId)
void	indexDummyIssue(long id, long projectId, String issueType, String issueKey, String summary, String desc)
boolean	isIndexConsistent()
boolean	isIndexUpdatedFieldConsistent()
Boolean	isReindexTaskSuccessful(String taskId)
Long	makeReindexRequest(ReindexRequestType type, String query, SharedEntityType... sharedEntityTypes)
void	pauseIndexRepairService()	Pause the index repair service running in background - Lucene specific
void	pauseOpenSearchReplayService()	Pause the index replay service running in background - OpenSearch specific
void	pauseScheduledReindex()	Pause the scheduled reindex
void	refresh()
void	reindexAll()
void	reindexProject(Long projectId)
void	replayIndex()
IndexingControl.IndexingProgress	startInBackground()
IndexingControl.IndexingProgress	startInBackground(IssueIndexingParams issueIndexingParams)
void	startIndexRepairService()	Start the index repair service running in background - Lucene specific
void	startOpenSearchReplayService()	Start the index replay service running in background - OpenSearch specific
void	startScheduledReindex()	Start the scheduled reindex
IndexingControl.IndexingProgress	startStopTheWorldReIndex()	Initiate a stop-the-world foreground re-index
void	temporaryIndex(String issueKey)

Methods inherited from class com.atlassian.jira.functest.framework.backdoor.BackdoorControl

createResource

Methods inherited from class com.atlassian.jira.testkit.client.BackdoorControl

createResourceForPath, createResourceForPath, get, getRestModulePath

Methods inherited from class com.atlassian.jira.testkit.client.RestApiClient

anonymous, authenticate, authoriseWithOAuth2, authoriseWithOAuth2, cleanUp, client, createResource, createResourceGadget, createResourceInternal, errorResponse, expanded, getCredentialsProvider, getEnvironmentData, loginAs, loginAs, registerResponse, resourceRoot, resourceRoot, setOf, toResponse, toResponse, toResponse, withCredentialsProvider

Methods inherited from class java.lang.Object

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

Constructor Details

IndexingControl

public IndexingControl(JIRAEnvironmentData environmentData)

Method Details

startInBackground

@Nonnull
public IndexingControl.IndexingProgress startInBackground()

startInBackground

@Nonnull
public IndexingControl.IndexingProgress startInBackground(IssueIndexingParams issueIndexingParams)

startStopTheWorldReIndex

@Nonnull
public IndexingControl.IndexingProgress startStopTheWorldReIndex()

Initiate a stop-the-world foreground re-index

Returns:

a progress monitor

isReindexTaskSuccessful

@Nullable
public Boolean isReindexTaskSuccessful(String taskId)

getIndexingTaskProgress

@Nullable
public int getIndexingTaskProgress(String taskId)

getInBackgroundProgress

@Nonnull
public IndexingControl.IndexingProgress getInBackgroundProgress()

getProjectIndexingProgress

@Nonnull
public IndexingControl.IndexingProgress getProjectIndexingProgress(Long projectId)

isIndexConsistent

public boolean isIndexConsistent()

isIndexUpdatedFieldConsistent

public boolean isIndexUpdatedFieldConsistent()

deleteIndex

public void deleteIndex()

deleteIndexDirectory

public void deleteIndexDirectory(boolean issues,
 boolean comments,
 boolean worklogs,
 boolean history)

deindex

public void deindex(String issueKey)

indexDummyIssue

public void indexDummyIssue(long id,
 long projectId,
 String issueType,
 String issueKey,
 String summary,
 String desc)

temporaryIndex

public void temporaryIndex(String issueKey)

reindexAll

public void reindexAll()

reindexProject

public void reindexProject(Long projectId)

makeReindexRequest

public Long makeReindexRequest(ReindexRequestType type,
 String query,
 SharedEntityType... sharedEntityTypes)

clearPendingReindexRequests

public Long clearPendingReindexRequests()

callPeriodicStats

public void callPeriodicStats()

startScheduledReindex

public void startScheduledReindex()

Start the scheduled reindex

pauseScheduledReindex

public void pauseScheduledReindex()

Pause the scheduled reindex

startIndexRepairService

public void startIndexRepairService()

Start the index repair service running in background - Lucene specific

pauseIndexRepairService

public void pauseIndexRepairService()

Pause the index repair service running in background - Lucene specific

startOpenSearchReplayService

public void startOpenSearchReplayService()

Start the index replay service running in background - OpenSearch specific

pauseOpenSearchReplayService

public void pauseOpenSearchReplayService()

Pause the index replay service running in background - OpenSearch specific

replayIndex

public void replayIndex()

refresh

public void refresh()