Package com.atlassian.jira.dev.backdoor

Class IndexingBackdoor

java.lang.Object

com.atlassian.jira.dev.backdoor.IndexingBackdoor

@Consumes("application/json")
@Produces("application/json")
@Path("/indexing")
public class IndexingBackdoor
extends Object

Backdoor for starting/stopping/querying indexing.

Since:

v5.2

Constructor Summary

Constructors

Constructor

Description

IndexingBackdoor(IssueIndexer issueIndexer, TaskManager taskManager, I18nHelper.BeanFactory i18nFactory, JiraAuthenticationContext jiraAuthenticationContext, IssueIndexManager issueIndexManager, ProjectManager projectManager, SearchService searchService, IssueManager issueManager, IndexPathManager indexPathManager, UserManager userManager, ReindexRequestManager reindexRequestManager, ClusterManager clusterManager, ProjectReindexService projectReindexService)

Method Summary

Modifier and Type	Method	Description
long	clearPendingReindexRequests()
boolean	deindex(String key)
void	deleteIndex()
void	deleteIndexDirectory(boolean issues, boolean comments, boolean worklogs, boolean history)
long	getIndexingProgress(Long projectId)
boolean	indexDummyIssue(String id, String issueType, String projectId, String key, String summary, String description)
boolean	isIndexConsistent()
boolean	isIndexingProject(Long projectId)
boolean	isIndexingProjectStarted(Long projectId)
boolean	isIndexingRunning()
boolean	isIndexingStarted()
boolean	isIndexUpdatedFieldConsistent()
javax.ws.rs.core.Response	makeReindexRequest(ReindexRequestType type, List<String> sharedEntityTypes)
javax.ws.rs.core.Response	pauseIndexRepairService()	Pause the index repair service running in background
javax.ws.rs.core.Response	pauseScheduledReindex()	Pause the scheduled reindex service
void	periodicStats()
javax.ws.rs.core.Response	reindexAll()
javax.ws.rs.core.Response	reindexProject(String projectId)
javax.ws.rs.core.Response	startIndexRepairService()	Start the index repair service running in background
javax.ws.rs.core.Response	startScheduledReindex()	Start the scheduled reindex service
Long	triggerBackgroundIndexing(boolean reindexComments, boolean reindexChangeHistory, boolean reindexWorklog, boolean reindexIssues)
void	triggerStopTheWorldIndexing()

Methods inherited from class java.lang.Object

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

Constructor Details

IndexingBackdoor

@Inject
public IndexingBackdoor(IssueIndexer issueIndexer,
 TaskManager taskManager,
 I18nHelper.BeanFactory i18nFactory,
 JiraAuthenticationContext jiraAuthenticationContext,
 IssueIndexManager issueIndexManager,
 ProjectManager projectManager,
 SearchService searchService,
 IssueManager issueManager,
 IndexPathManager indexPathManager,
 UserManager userManager,
 ReindexRequestManager reindexRequestManager,
 ClusterManager clusterManager,
 ProjectReindexService projectReindexService)

Method Details

triggerBackgroundIndexing

@POST
@Path("background")
public Long triggerBackgroundIndexing(@QueryParam("comments")
 boolean reindexComments,
 @QueryParam("changeHistory")
 boolean reindexChangeHistory,
 @QueryParam("worklogs")
 boolean reindexWorklog,
 @QueryParam("issues") @DefaultValue("true")
 boolean reindexIssues)

triggerStopTheWorldIndexing

@POST
@Path("stoptheworld")
public void triggerStopTheWorldIndexing()

deleteIndex

@POST
@Path("deleteIndex")
public void deleteIndex()

deleteIndexDirectory

@POST
@Path("deleteIndexDirectory")
public void deleteIndexDirectory(@QueryParam("issues")
 boolean issues,
 @QueryParam("comments")
 boolean comments,
 @QueryParam("worklogs")
 boolean worklogs,
 @QueryParam("history")
 boolean history)

deindex

@GET
@Path("deindex")
public boolean deindex(@QueryParam("key")
 String key)

indexDummyIssue

@GET
@Path("indexDummyIssue")
public boolean indexDummyIssue(@QueryParam("id")
 String id,
 @QueryParam("issueType")
 String issueType,
 @QueryParam("projectId")
 String projectId,
 @QueryParam("key")
 String key,
 @QueryParam("summary")
 String summary,
 @QueryParam("description")
 String description)

reindexAll

@POST
@Path("reindexAll")
public javax.ws.rs.core.Response reindexAll()

reindexProject

@POST
@Path("reindexProject/{projectId}")
public javax.ws.rs.core.Response reindexProject(@PathParam("projectId")
 String projectId)

pauseScheduledReindex

@POST
@Path("scheduledReindex/pause")
public javax.ws.rs.core.Response pauseScheduledReindex()

Pause the scheduled reindex service

startScheduledReindex

@POST
@Path("scheduledReindex/start")
public javax.ws.rs.core.Response startScheduledReindex()

Start the scheduled reindex service

pauseIndexRepairService

@POST
@Path("repairService/pause")
public javax.ws.rs.core.Response pauseIndexRepairService()

Pause the index repair service running in background

startIndexRepairService

@POST
@Path("repairService/start")
public javax.ws.rs.core.Response startIndexRepairService()

Start the index repair service running in background

makeReindexRequest

@GET
@Path("makeReindexRequest")
public javax.ws.rs.core.Response makeReindexRequest(@QueryParam("type")
 ReindexRequestType type,
 @QueryParam("sharedEntityType")
 List<String> sharedEntityTypes)

isIndexingRunning

@GET
public boolean isIndexingRunning()

isIndexingStarted

@GET
@Path("started")
public boolean isIndexingStarted()

isIndexingProject

@GET
@Path("project")
public boolean isIndexingProject(@QueryParam("projectId")
 Long projectId)

getIndexingProgress

@GET
@Path("project/progress")
public long getIndexingProgress(@QueryParam("projectId")
 Long projectId)

isIndexingProjectStarted

@GET
@Path("project/started")
public boolean isIndexingProjectStarted(@QueryParam("projectId")
 Long projectId)

isIndexConsistent

@GET
@Path("consistent")
public boolean isIndexConsistent()

isIndexUpdatedFieldConsistent

@GET
@Path("consistent/updated")
public boolean isIndexUpdatedFieldConsistent()
                                      throws SearchException

Throws:

SearchException

clearPendingReindexRequests

@GET
@Path("clearPendingReindexRequests")
public long clearPendingReindexRequests()

periodicStats

@POST
@Path("periodicStats")
public void periodicStats()