com.atlassian.jira.config

Class IndexTaskContext

java.lang.Object

com.atlassian.jira.config.IndexTaskContext

All Implemented Interfaces:

IndexTask, TaskContext, Serializable

Direct Known Subclasses:

BackgroundIndexTaskContext, ForegroundIndexTaskContext

@Internal
public class IndexTaskContext
extends Object
implements IndexTask

Context for global index operations. Only one global index operation is allowed at one time. This should be instantiated only for task querying. For submitting task please instantiate its children.

Since:

v3.13

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IndexTaskContext()

Method Summary

Modifier and Type	Method and Description
String	buildProgressURL(Long taskId) This factory method is called to build a progress URL so the TaskDescriptor can allow some one to navigate to the task's "web page".
boolean	equals(Object o)
String	getTaskInProgressMessage(I18nHelper i18n)
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexTaskContext

public IndexTaskContext()

Method Detail

buildProgressURL

public String buildProgressURL(Long taskId)

Description copied from interface: TaskContext

This factory method is called to build a progress URL so the TaskDescriptor can allow some one to navigate to the task's "web page". The URL should start with "/" and be ready for the servlet context path to be prepended.

Specified by:

buildProgressURL in interface TaskContext

Parameters:

taskId - - the id of the task. Since this is not known until task submission, this call back is informed of it once created.

Returns:

returns a context specific progress URL that a user can go to to view the progress of a task.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTaskInProgressMessage

public String getTaskInProgressMessage(I18nHelper i18n)

Specified by:

getTaskInProgressMessage in interface IndexTask