com.atlassian.greenhopper.service.index
Interface IndexCheckService

All Known Implementing Classes:

IndexCheckServiceImpl

public interface IndexCheckService

Manage and execute index checks that need to be performed from time to time.

Nested Class Summary

static class	IndexCheckService.CheckResult<T>
static class	IndexCheckService.CheckSpec
static class	IndexCheckService.CheckType

Method Summary

void	onReindexAllCancelled(com.atlassian.jira.issue.index.ReindexAllCancelledEvent event) Respond to reindex cancelled events.
void	onReindexAllCompleted(com.atlassian.jira.issue.index.ReindexAllCompletedEvent event) Respond to reindex completed events.
IndexCheckService.CheckResult<java.lang.Void>	performCheck(IndexCheckService.CheckSpec checkSpec) Perform the checks to find out what state the issue index is in.
void	setCheckNecessary(IndexCheckService.CheckType checkType, com.atlassian.fugue.Option<java.lang.String> flag) Set a flag in the system to indicate that the check is necessary.
IndexCheckService.CheckResult<java.lang.Boolean>	validateCheck(IndexCheckService.CheckSpec checkSpec) Find out if the specified checks are necessary.

Method Detail

validateCheck

@Nonnull
IndexCheckService.CheckResult<java.lang.Boolean> validateCheck(@Nonnull
                                                                       IndexCheckService.CheckSpec checkSpec)

Find out if the specified checks are necessary.

Parameters:

checkSpec - a specification for which checks/views to run

Returns:

the outcome; will contain error if check failed

performCheck

@Nonnull
IndexCheckService.CheckResult<java.lang.Void> performCheck(@Nonnull
                                                                   IndexCheckService.CheckSpec checkSpec)

Perform the checks to find out what state the issue index is in.

Parameters:

checkSpec - a specification for which checks/views to run

Returns:

the outcome; will contain error if check failed

setCheckNecessary

void setCheckNecessary(@Nonnull
                       IndexCheckService.CheckType checkType,
                       @Nonnull
                       com.atlassian.fugue.Option<java.lang.String> flag)

Set a flag in the system to indicate that the check is necessary.

Parameters:

checkType - the type of check to store the flag for

flag - the flag to set; defaults to "true"

onReindexAllCompleted

@EventListener
void onReindexAllCompleted(com.atlassian.jira.issue.index.ReindexAllCompletedEvent event)

Respond to reindex completed events.

Parameters:

event - the event

onReindexAllCancelled

@EventListener
void onReindexAllCancelled(com.atlassian.jira.issue.index.ReindexAllCancelledEvent event)

Respond to reindex cancelled events.

Parameters:

event - the event