Package com.atlassian.jira.functest.framework.backdoor

Class UserAnonymizeControl

java.lang.Object

com.atlassian.jira.testkit.client.RestApiClient<UserAnonymizeControl>

com.atlassian.jira.testkit.client.BackdoorControl<UserAnonymizeControl>

com.atlassian.jira.functest.framework.backdoor.BackdoorControl<UserAnonymizeControl>

com.atlassian.jira.functest.framework.backdoor.UserAnonymizeControl

public class UserAnonymizeControl
extends BackdoorControl<UserAnonymizeControl>

Use this class from func/selenium/page-object tests that need to perform user anonymization process.

Since:

v8.2

See Also:

• for the code this plugs into at the back-end for synchronous methods
• for the code this plugs into at the back-end for asynchronous methods

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserAnonymizeControl.AnonymizePerformResult
static class	UserAnonymizeControl.AnonymizePerformResultValidationError

Nested classes/interfaces inherited from class com.atlassian.jira.testkit.client.RestApiClient

com.atlassian.jira.testkit.client.RestApiClient.BackdoorLoggingFilter, com.atlassian.jira.testkit.client.RestApiClient.JsonMediaTypeFilter, com.atlassian.jira.testkit.client.RestApiClient.RestCall

Field Summary

Fields inherited from class com.atlassian.jira.testkit.client.BackdoorControl

API_REST_PATH, API_REST_VERSION, DEFAULT_REST_PATH, logger, rootPath

Fields inherited from class com.atlassian.jira.testkit.client.RestApiClient

REST_VERSION

Constructor Summary

Constructors

Constructor	Description
UserAnonymizeControl(JIRAEnvironmentData environmentData)

Method Summary

Modifier and Type	Method	Description
UserAnonymizeControl.AnonymizePerformResult	anonymize(String userKey)
UserAnonymizeControl.AnonymizePerformResult	anonymize(String userKey, boolean rerunPluginPoints, String oldUserKey, String oldUserName, String newOwnerKey)
UserAnonymizeControl.AnonymizePerformResultValidationError	anonymizeWithValidationError(String userKey, boolean rerunPluginPoints, String oldUserKey, String oldUserName, String newOwnerKey)
UserAnonymizationProgressBean	fetchFinishedProgressResult()
String	getExternalId(String userName)
UserAnonymizationProgressBean	getProgress()	Uses internal REST API to retrieve process of the last task scheduled using scheduleUserAnonymization(String, String) or scheduleUserAnonymizationRerun(String, String, String, String)
UserAnonymizationProgressBean	getProgress(long taskId)	Uses internal REST API to retrieve process of a task with the given id that was scheduled using or scheduleUserAnonymizationRerun(String, String, String, String)
void	scheduleUserAnonymization(String userKey, String newOwnerKey)	Uses internal REST API to schedule anonymization process whose progress can be retrieved using getProgress()
void	scheduleUserAnonymizationRerun(String userKey, String newOwnerKey, String oldUserKey, String oldUserName)	Uses internal REST API to schedule rerun of anonymization process whose progress can be retrieved using getProgress()
UserAnonymizationValidationBean	validateUserAnonymization(String userKey, String expand)	Uses internal REST API to validate user anonymization request
UserAnonymizationValidationBean	validateUserAnonymizationRerun(String userKey, String oldUserKey, String oldUserName, String expand)	Uses internal REST API to validate user anonymization request

Methods inherited from class com.atlassian.jira.functest.framework.backdoor.BackdoorControl

createResource

Methods inherited from class com.atlassian.jira.testkit.client.BackdoorControl

createResourceForPath, createResourceForPath, get, getRestModulePath

Methods inherited from class com.atlassian.jira.testkit.client.RestApiClient

anonymous, authenticate, authoriseWithOAuth2, authoriseWithOAuth2, cleanUp, client, createResource, createResourceGadget, createResourceInternal, errorResponse, expanded, getCredentialsProvider, getEnvironmentData, loginAs, loginAs, registerResponse, resourceRoot, resourceRoot, setOf, toResponse, toResponse, toResponse, withCredentialsProvider

Methods inherited from class java.lang.Object

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

Constructor Details

UserAnonymizeControl

public UserAnonymizeControl(JIRAEnvironmentData environmentData)

Method Details

anonymize

public UserAnonymizeControl.AnonymizePerformResult anonymize(String userKey)

anonymize

public UserAnonymizeControl.AnonymizePerformResult anonymize(String userKey,
 boolean rerunPluginPoints,
 String oldUserKey,
 String oldUserName,
 String newOwnerKey)

anonymizeWithValidationError

public UserAnonymizeControl.AnonymizePerformResultValidationError anonymizeWithValidationError(String userKey,
 boolean rerunPluginPoints,
 String oldUserKey,
 String oldUserName,
 String newOwnerKey)

validateUserAnonymization

public UserAnonymizationValidationBean validateUserAnonymization(String userKey,
 String expand)

Uses internal REST API to validate user anonymization request

validateUserAnonymizationRerun

public UserAnonymizationValidationBean validateUserAnonymizationRerun(String userKey,
 @Nullable
 String oldUserKey,
 @Nullable
 String oldUserName,
 String expand)

Uses internal REST API to validate user anonymization request

scheduleUserAnonymization

public void scheduleUserAnonymization(String userKey,
 String newOwnerKey)

Uses internal REST API to schedule anonymization process whose progress can be retrieved using getProgress()

scheduleUserAnonymizationRerun

public void scheduleUserAnonymizationRerun(String userKey,
 String newOwnerKey,
 String oldUserKey,
 String oldUserName)

Uses internal REST API to schedule rerun of anonymization process whose progress can be retrieved using getProgress()

getProgress

public UserAnonymizationProgressBean getProgress()

Uses internal REST API to retrieve process of the last task scheduled using scheduleUserAnonymization(String, String) or scheduleUserAnonymizationRerun(String, String, String, String)

getProgress

public UserAnonymizationProgressBean getProgress(long taskId)

Uses internal REST API to retrieve process of a task with the given id that was scheduled using or scheduleUserAnonymizationRerun(String, String, String, String)

fetchFinishedProgressResult

@Nonnull
public UserAnonymizationProgressBean fetchFinishedProgressResult()

getExternalId

public String getExternalId(String userName)