com.atlassian.jira.user.anonymize

Class DefaultAnonymizeUserService

java.lang.Object

com.atlassian.jira.user.anonymize.DefaultAnonymizeUserService

All Implemented Interfaces:

AnonymizeUserService

public class DefaultAnonymizeUserService
extends Object
implements AnonymizeUserService

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.user.anonymize.AnonymizeUserService

AnonymizeUserService.AnonymizeOperation, AnonymizeUserService.AnonymizePerformResult, AnonymizeUserService.AnonymizeProcessData, AnonymizeUserService.AnonymizeValidationResult, AnonymizeUserService.OperationsReport<T>, AnonymizeUserService.SingleOperationReport<T>

Constructor Summary

Constructors

Constructor and Description
DefaultAnonymizeUserService(UserManager userManager, I18nHelper.BeanFactory i18nBeanFactory, GlobalPermissionManager globalPermissionManager, UserKeyStore userKeyStore, ExtendedUserDao extendedUserDao, AnonymizeOperationSteps anonymizeOperationSteps, com.atlassian.event.api.EventPublisher eventPublisher, ReindexMessageManager reindexMessageManager)

Method Summary

Modifier and Type	Method and Description
int	getStepCount(AnonymizeUserService.AnonymizeValidationResult anonymizeValidationResult) Gets amount of distinct operations performed in the process of anonymization.
AnonymizeUserService.AnonymizePerformResult	perform(AnonymizeUserService.AnonymizeValidationResult validationResult, Context asyncTaskContext) We have AnonymizeUserService.AnonymizeProcessData from validation phase which describes operations we would like to perform.
AnonymizeUserService.AnonymizeValidationResult	preValidateAnonymize(AnonymizationParameters request) Pre-validates anonymization - fills all data that can be obtained from initial user key passed in the request: if user name/key is anonymized, generates new anonymized user key/name if needed, gets list of affected entities etc.
AnonymizeUserService.AnonymizeValidationResult	validateAnonymize(AnonymizationParameters request) Validate the request and return a validation result.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAnonymizeUserService

public DefaultAnonymizeUserService(UserManager userManager,
                                   I18nHelper.BeanFactory i18nBeanFactory,
                                   GlobalPermissionManager globalPermissionManager,
                                   UserKeyStore userKeyStore,
                                   ExtendedUserDao extendedUserDao,
                                   AnonymizeOperationSteps anonymizeOperationSteps,
                                   com.atlassian.event.api.EventPublisher eventPublisher,
                                   ReindexMessageManager reindexMessageManager)

Method Detail

preValidateAnonymize

@Nonnull
public AnonymizeUserService.AnonymizeValidationResult preValidateAnonymize(@Nonnull
                                                                                    AnonymizationParameters request)

Description copied from interface: AnonymizeUserService

Pre-validates anonymization - fills all data that can be obtained from initial user key passed in the request: if user name/key is anonymized, generates new anonymized user key/name if needed, gets list of affected entities etc. Does not validate user input data eg. new owner (because no owner has been provided yet). In case of success returns filled-out AnonymizationParameters with AnonymizeUserService.AnonymizeProcessData that can be used on UI. Doesn't validate additional parameters required by handlers eg. new owner for entities.

Specified by:

preValidateAnonymize in interface AnonymizeUserService

Parameters:

request - Anonymize request

Returns:

Validation result

validateAnonymize

@Nonnull
public AnonymizeUserService.AnonymizeValidationResult validateAnonymize(@Nonnull
                                                                                 AnonymizationParameters request)

Description copied from interface: AnonymizeUserService

Validate the request and return a validation result. A request is created using AnonymizationParameters.builder(), like this:

 
 AnonymizationParameters.builder()
          .targetUser(activeUser.getKey())
          .newOwner(admin)
          .executor(admin)
          .build());
 

You must always verify the validation result before proceeding:

 
     AnonymizeValidationResult result = validateAnonymize(request);
     if (result.isValid()) {
         ...perform the operation...
     } else {
         ...handle the errors...
     }
 

Specified by:

validateAnonymize in interface AnonymizeUserService

perform

@Nonnull
public AnonymizeUserService.AnonymizePerformResult perform(@Nonnull
                                                                    AnonymizeUserService.AnonymizeValidationResult validationResult,
                                                                    @Nonnull
                                                                    Context asyncTaskContext)

We have AnonymizeUserService.AnonymizeProcessData from validation phase which describes operations we would like to perform. Validation is performed on each step so each step should have required data. Process "blocking" steps are executed, if error is detected whole process is aborted. Process "non blocking" steps are executed. All results from steps are collected in report.

Specified by:

perform in interface AnonymizeUserService

Parameters:

validationResult - Validation result

asyncTaskContext - Task context to report the anonymization process progress to

Returns:

Anonymization result

getStepCount

public int getStepCount(@Nonnull
                        AnonymizeUserService.AnonymizeValidationResult anonymizeValidationResult)

Description copied from interface: AnonymizeUserService

Gets amount of distinct operations performed in the process of anonymization. Each performed operation should be reported to the TaskContextAware.getContext() passed in AnonymizeUserService.perform(AnonymizeValidationResult, Context) and AnonymizationHandler.update(Object).

Specified by:

getStepCount in interface AnonymizeUserService

Returns:

amount of distinct operations performed in the process of anonymization.