com.atlassian.jira.index.request

Interface ReindexRequestService

All Known Implementing Classes:

DefaultReindexRequestService

@PublicApi
public interface ReindexRequestService

Since:

6.4

Method Summary

Modifier and Type	Method and Description
ReindexRequest	getReindexProgress(long requestId) Reads progress of a reindex request.
Set<ReindexRequest>	getReindexProgress(Set<Long> requestIds) Reads progress of multiple reindex requests.
boolean	isReindexRequested()
Set<ReindexRequest>	processRequests(Set<ReindexRequestType> reindexRequestTypes, boolean runInBackground) Processes any outstanding reindex requests asynchronously.
Set<ReindexRequest>	processRequestsAndWait(Set<ReindexRequestType> reindexRequestTypes, boolean runInBackground) Processes any outstanding reindex requests and waits for them to finish.
ReindexRequest	requestReindex(ReindexRequestType type, Set<AffectedIndex> affectedIndexes, Set<SharedEntityType> entityTypes) Requests a reindex, adding a reindex request to the queue.

Method Detail

processRequests

@Nonnull
Set<ReindexRequest> processRequests(Set<ReindexRequestType> reindexRequestTypes,
                                             boolean runInBackground)
                                      throws PermissionException

Processes any outstanding reindex requests asynchronously.

Parameters:

reindexRequestTypes - The request types to process.

runInBackground -

Returns:

the reindex requests that are being processed.

Throws:

PermissionException

processRequestsAndWait

@Nonnull
Set<ReindexRequest> processRequestsAndWait(Set<ReindexRequestType> reindexRequestTypes,
                                                    boolean runInBackground)
                                             throws PermissionException

Processes any outstanding reindex requests and waits for them to finish.

Parameters:

reindexRequestTypes - The request types to process.

runInBackground -

Returns:

the reindex requests that were processed.

Throws:

PermissionException

requestReindex

@Nonnull
ReindexRequest requestReindex(@Nonnull
                                       ReindexRequestType type,
                                       @Nonnull
                                       Set<AffectedIndex> affectedIndexes,
                                       @Nonnull
                                       Set<SharedEntityType> entityTypes)

Requests a reindex, adding a reindex request to the queue. There is no guarantee that this request will be performed immediately.

Parameters:

type - whether reindex is immediate or delayed.

affectedIndexes - the indexes to regenerate.

entityTypes - the entity types whose indexes are to be regenerated.

Returns:

the request that was created.

getReindexProgress

@Nullable
ReindexRequest getReindexProgress(long requestId)

Reads progress of a reindex request.

Parameters:

requestId - the ID of the reindex request.

Returns:

reindex progress, or null if no request with the specified ID exists.

getReindexProgress

@Nonnull
Set<ReindexRequest> getReindexProgress(@Nonnull
                                                Set<Long> requestIds)

Reads progress of multiple reindex requests.

Parameters:

requestIds - a set of reindex request IDs.

Returns:

the reindex request progress. Any reindex request specified in requestIds that was not found will not have a corresponding element in the return set.

isReindexRequested

boolean isReindexRequested()