com.atlassian.jira.user.anonymize

Class AnonymizeUserTaskContext

java.lang.Object

com.atlassian.jira.user.anonymize.AnonymizeUserTaskContext

All Implemented Interfaces:

TaskContext, Serializable

public class AnonymizeUserTaskContext
extends Object
implements TaskContext

Context for user anonymization operations. Only one such operation is allowed to run at any given time.

Since:

v8.4

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static AnonymizeUserTaskContext	EMPTY Used to retrieve a running anonymization task - never to schedule a new one.

Constructor Summary

Constructors

Constructor and Description
AnonymizeUserTaskContext(String userKey, boolean rerun)
AnonymizeUserTaskContext(String userKey, String userName, boolean rerun)
AnonymizeUserTaskContext(String userKey, String userName, String fullName, boolean rerun)

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 obj)
String	getFullName()
String	getUserKey()
String	getUserName()
int	hashCode()
boolean	isRerun()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final AnonymizeUserTaskContext EMPTY

Used to retrieve a running anonymization task - never to schedule a new one.

Constructor Detail

AnonymizeUserTaskContext

public AnonymizeUserTaskContext(@Nonnull
                                String userKey,
                                boolean rerun)

AnonymizeUserTaskContext

public AnonymizeUserTaskContext(@Nonnull
                                String userKey,
                                String userName,
                                boolean rerun)

AnonymizeUserTaskContext

public AnonymizeUserTaskContext(@Nonnull
                                String userKey,
                                @Nullable
                                String userName,
                                @Nullable
                                String fullName,
                                boolean rerun)

Method Detail

getUserKey

@Nonnull
public String getUserKey()

getUserName

@Nullable
public String getUserName()

getFullName

@Nullable
public String getFullName()

isRerun

public boolean isRerun()

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.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object