Package com.atlassian.jira.index.request

Class DefaultReindexRequestManager

java.lang.Object

com.atlassian.jira.index.request.DefaultReindexRequestManager

All Implemented Interfaces:

ReindexRequestManager

public class DefaultReindexRequestManager
extends Object
implements ReindexRequestManager

Since:

6.4

Constructor Summary

Constructors

Constructor	Description
DefaultReindexRequestManager(ReindexRequestDao reindexRequestDao, Clock clock, ReindexRequestCoalescer requestCoalescer, ClusterManager clusterManager, com.atlassian.beehive.ClusterLockService clusterLockService, TaskManager taskManager, IndexLifecycleManager indexLifecycleManager, I18nHelper.BeanFactory i18nFactory, I18nHelper i18nHelper, JohnsonProvider johnsonProvider)

Method Summary

Modifier and Type	Method	Description
void	clearAll()	Clear any pending requests.
List<ReindexRequest>	failRunningRequestsFromDeadNodes()	Finds any active or running requests from inactive nodes in the cluster and transitions them to failed.
List<ReindexRequest>	failRunningRequestsFromNode(String nodeId)	Finds any active or running requests from the specified node in the cluster and transitions them to failed.
Iterable<ReindexRequest>	getPendingReindexRequests(Set<ReindexRequestType> reindexRequestTypes)	Retrieves all pending reindex requests, in order from oldest to newest.
ReindexRequest	getReindexProgress(Long requestId)
Set<ReindexRequest>	getReindexProgress(Set<Long> requestIds)	Retrieves the progress of some requests.
boolean	isReindexInProgress()
boolean	isReindexRequested()	Checks if any ReindexRequests of any type are waiting to be processed.
boolean	isReindexRequested(Set<ReindexRequestType> reindexRequestTypes)	Checks if any ReindexRequests are waiting to be processed.
protected ReindexRequest	performReindex(ReindexRequest request, boolean waitForCompletion, boolean runInBackground)
Set<ReindexRequest>	processPendingRequests(boolean waitForCompletion, Set<ReindexRequestType> reindexRequestTypes, boolean runInBackground)	Process any outstanding reindex requests.
Iterable<ReindexRequest>	readPendingReindexRequests(Set<ReindexRequestType> reindexRequestTypes, boolean updateCoalescedRequests)
ReindexRequest	requestReindex(ReindexRequestType type, Set<AffectedIndex> affectedIndexes, Set<SharedEntityType> entityTypes)	Requests a reindex.
ReindexRequest	transitionStatus(ReindexRequest request, ReindexStatus newStatus)	Transitions the status of a reindex request.
List<ReindexRequest>	transitionStatus(Iterable<ReindexRequest> requests, ReindexStatus newStatus)	Transitions the status of reindex requests.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultReindexRequestManager

public DefaultReindexRequestManager(ReindexRequestDao reindexRequestDao,
 Clock clock,
 ReindexRequestCoalescer requestCoalescer,
 ClusterManager clusterManager,
 com.atlassian.beehive.ClusterLockService clusterLockService,
 TaskManager taskManager,
 IndexLifecycleManager indexLifecycleManager,
 I18nHelper.BeanFactory i18nFactory,
 I18nHelper i18nHelper,
 JohnsonProvider johnsonProvider)

Method Details

isReindexRequested

public boolean isReindexRequested()

Description copied from interface: ReindexRequestManager

Checks if any ReindexRequests of any type are waiting to be processed.

Specified by:

isReindexRequested in interface ReindexRequestManager

Returns:

true if unprocessed requests exist

isReindexRequested

public boolean isReindexRequested(Set<ReindexRequestType> reindexRequestTypes)

Description copied from interface: ReindexRequestManager

Checks if any ReindexRequests are waiting to be processed.

Specified by:

isReindexRequested in interface ReindexRequestManager

Parameters:

reindexRequestTypes - Types of requests to check for.

Returns:

true if unprocessed requests exist

getPendingReindexRequests

@Nonnull
public Iterable<ReindexRequest> getPendingReindexRequests(@Nonnull
 Set<ReindexRequestType> reindexRequestTypes)

Description copied from interface: ReindexRequestManager

Retrieves all pending reindex requests, in order from oldest to newest.

Specified by:

getPendingReindexRequests in interface ReindexRequestManager

Parameters:

reindexRequestTypes - Types of requests to check for.

Returns:

a list of reindex requests.

readPendingReindexRequests

@Nonnull
public Iterable<ReindexRequest> readPendingReindexRequests(@Nonnull
 Set<ReindexRequestType> reindexRequestTypes,
 boolean updateCoalescedRequests)

processPendingRequests

public Set<ReindexRequest> processPendingRequests(boolean waitForCompletion,
 Set<ReindexRequestType> reindexRequestTypes,
 boolean runInBackground)

Description copied from interface: ReindexRequestManager

Process any outstanding reindex requests.

Specified by:

processPendingRequests in interface ReindexRequestManager

Parameters:

waitForCompletion - If true this method will not return until the reindexing is complete, otherwise it will return when the reindex task is submitted,

reindexRequestTypes - Types of requests to process either ReindexRequestType

runInBackground - If true the reindex should be a background reindex otherwise a foreground stop the world reindex

Returns:

The updated processed requests.

performReindex

@Nonnull
protected ReindexRequest performReindex(@Nonnull
 ReindexRequest request,
 boolean waitForCompletion,
 boolean runInBackground)
                                 throws InterruptedException

Throws:

InterruptedException

failRunningRequestsFromDeadNodes

@Nonnull
public List<ReindexRequest> failRunningRequestsFromDeadNodes()

Description copied from interface: ReindexRequestManager

Finds any active or running requests from inactive nodes in the cluster and transitions them to failed. Use this to clean up any tasks from nodes that were running on nodes that were killed.

Specified by:

failRunningRequestsFromDeadNodes in interface ReindexRequestManager

Returns:

the list of requests that were transitioned.

failRunningRequestsFromNode

@Nonnull
public List<ReindexRequest> failRunningRequestsFromNode(@Nullable
 String nodeId)

Description copied from interface: ReindexRequestManager

Finds any active or running requests from the specified node in the cluster and transitions them to failed.

Specified by:

failRunningRequestsFromNode in interface ReindexRequestManager

Parameters:

nodeId - the ID of the cluster node, or null if not clustered.

Returns:

the list of requests that were transitioned.

isReindexInProgress

public boolean isReindexInProgress()

Specified by:

isReindexInProgress in interface ReindexRequestManager

Returns:

true if a reindex is in progress, false if not.

requestReindex

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

Description copied from interface: ReindexRequestManager

Requests a reindex.

Specified by:

requestReindex in interface ReindexRequestManager

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.

transitionStatus

@Nonnull
public List<ReindexRequest> transitionStatus(@Nonnull
 Iterable<ReindexRequest> requests,
 @Nonnull
 ReindexStatus newStatus)

Description copied from interface: ReindexRequestManager

Transitions the status of reindex requests.

Specified by:

transitionStatus in interface ReindexRequestManager

Parameters:

requests - the requests.

newStatus - the new status to transition to.

Returns:

the updated requests.

transitionStatus

@Nonnull
public ReindexRequest transitionStatus(@Nonnull
 ReindexRequest request,
 @Nonnull
 ReindexStatus newStatus)

Description copied from interface: ReindexRequestManager

Transitions the status of a reindex request.

Specified by:

transitionStatus in interface ReindexRequestManager

Parameters:

request - the request.

newStatus - the new status to transition to.

Returns:

the updated request.

getReindexProgress

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

Description copied from interface: ReindexRequestManager

Retrieves the progress of some requests.

Specified by:

getReindexProgress in interface ReindexRequestManager

Parameters:

requestIds - the set of reindex request IDs to look up.

Returns:

set of requests indicating progress. Any request IDs that were not found will not have a corresponding entry in this result set.

clearAll

public void clearAll()

Description copied from interface: ReindexRequestManager

Clear any pending requests.

Specified by:

clearAll in interface ReindexRequestManager

getReindexProgress

public ReindexRequest getReindexProgress(@Nonnull
 Long requestId)