com.atlassian.jira.index.request

Class DefaultReindexRequestService

java.lang.Object

com.atlassian.jira.index.request.DefaultReindexRequestService

All Implemented Interfaces:

ReindexRequestService

public class DefaultReindexRequestService
extends Object
implements ReindexRequestService

Since:

6.4

Constructor Summary

Constructors

Constructor and Description
DefaultReindexRequestService(ReindexRequestManager reindexRequestManager, PermissionManager permissionManager, JiraAuthenticationContext jiraAuthenticationContext)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultReindexRequestService

public DefaultReindexRequestService(ReindexRequestManager reindexRequestManager,
                                    PermissionManager permissionManager,
                                    JiraAuthenticationContext jiraAuthenticationContext)

Method Detail

processRequests

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

Description copied from interface: ReindexRequestService

Processes any outstanding reindex requests asynchronously.

Specified by:

processRequests in interface ReindexRequestService

Parameters:

reindexRequestTypes - The request types to process.

Returns:

the reindex requests that are being processed.

Throws:

PermissionException

processRequestsAndWait

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

Description copied from interface: ReindexRequestService

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

Specified by:

processRequestsAndWait in interface ReindexRequestService

Parameters:

reindexRequestTypes - The request types to process.

Returns:

the reindex requests that were processed.

Throws:

PermissionException

requestReindex

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

Description copied from interface: ReindexRequestService

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

Specified by:

requestReindex in interface ReindexRequestService

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
public ReindexRequest getReindexProgress(long requestId)

Description copied from interface: ReindexRequestService

Reads progress of a reindex request.

Specified by:

getReindexProgress in interface ReindexRequestService

Parameters:

requestId - the ID of the reindex request.

Returns:

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

getReindexProgress

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

Description copied from interface: ReindexRequestService

Reads progress of multiple reindex requests.

Specified by:

getReindexProgress in interface ReindexRequestService

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

public boolean isReindexRequested()

Specified by:

isReindexRequested in interface ReindexRequestService