Package com.atlassian.jira.user.anonymize.operations

Interface AnonymizeOperationStep

All Known Implementing Classes:

AnonymizePluginPointsStep, TransferOwnershipPluginPointOperationStep, UserDisableOperationStep, UserExternalIdChangeOperationStep, UserKeyChangeOperationStep, UserKeyChangePluginPointsOperationStep, UserNameChangeOperationStep, UserNameChangePluginPointsOperationStep

public interface AnonymizeOperationStep

Common worker class used by DefaultAnonymizeUserService

Method Summary

Modifier and Type	Method	Description
ServiceOutcomeWithWarnings<Collection<AffectedEntity>>	getAffectedEntities(AnonymizeUserService.AnonymizeProcessData anonymizationData)	Gets affected entities for this action.
AnonymizeUserService.AnonymizeOperation	getAnonymizeOperation()	Type of operation this handler supports.
int	getNumberOfTasks(AnonymizeUserService.AnonymizeValidationResult validationResult)	Returns number of tasks/stages to be executed as part of this anonymization step.
Optional<AnonymizeUserService.SingleOperationReport<Void>>	performOperation(AnonymizeUserService.OperationsReport<Void> anonymizeReport, AnonymizeUserService.AnonymizeValidationResult validationResult, Context asyncTaskContext)	Performs operations only if all proper parameters are filled in passed parameters.
default boolean	shouldPerformOperation(AnonymizeUserService.AnonymizeProcessData validationResultData)
ServiceResult	validate(AnonymizeUserService.AnonymizeProcessData anonymizationProcessData, I18nHelper i18nHelper, boolean preValidate)	Validate should ensure that request and anonymizationProcessData contain all data needed to performOperation(OperationsReport, AnonymizeValidationResult, Context).

Method Details

performOperation

@Nonnull
Optional<AnonymizeUserService.SingleOperationReport<Void>> performOperation(@Nonnull
 AnonymizeUserService.OperationsReport<Void> anonymizeReport,
 @Nonnull
 AnonymizeUserService.AnonymizeValidationResult validationResult,
 @Nonnull
 Context asyncTaskContext)

Performs operations only if all proper parameters are filled in passed parameters. validate(AnonymizeProcessData, I18nHelper, boolean) should be called prior this method to ensure that all required parameters to perform operation are present.

Parameters:

anonymizeReport - Anonymization report, can be used to check if previous operations were executed/succeeded/failed.

validationResult - Validation result. See AnonymizeUserService.validateAnonymize(AnonymizationParameters)

asyncTaskContext - Task context to report the anonymization process progress to

Returns:

Result of operation. Empty optional if operation wasn't executed.

validate

@Nonnull
ServiceResult validate(@Nonnull
 AnonymizeUserService.AnonymizeProcessData anonymizationProcessData,
 I18nHelper i18nHelper,
 boolean preValidate)

Validate should ensure that request and anonymizationProcessData contain all data needed to performOperation(OperationsReport, AnonymizeValidationResult, Context). Also validates if system allows specific operation eg. in order for user to be renamed it has to be editable in system.

Parameters:

anonymizationProcessData - Data to validate.

i18nHelper - I18n helper

preValidate - True for pre-validation phase. See AnonymizeUserService.preValidateAnonymize(AnonymizationParameters)

Returns:

Validation result.

getAffectedEntities

@Nonnull
ServiceOutcomeWithWarnings<Collection<AffectedEntity>> getAffectedEntities(AnonymizeUserService.AnonymizeProcessData anonymizationData)

Gets affected entities for this action. This should run event without proper parameters provided (enter default values eg. anonymized user key/username)

Parameters:

anonymizationData - Anonymization data.

Returns:

Affected entities.

getAnonymizeOperation

@Nonnull
AnonymizeUserService.AnonymizeOperation getAnonymizeOperation()

Type of operation this handler supports.

Returns:

Operation this handler supports.

getNumberOfTasks

int getNumberOfTasks(@Nonnull
 AnonymizeUserService.AnonymizeValidationResult validationResult)

Returns number of tasks/stages to be executed as part of this anonymization step. The number returned here must be consistent with the number of updates performed as part of performOperation(OperationsReport, AnonymizeValidationResult, Context).

Parameters:

validationResult - Validation result

Returns:

Number of tasks/stages to be executed

shouldPerformOperation

default boolean shouldPerformOperation(AnonymizeUserService.AnonymizeProcessData validationResultData)