com.atlassian.jira.user.anonymize.operations

Class AnonymizePluginPointsStep

java.lang.Object

com.atlassian.jira.user.anonymize.operations.AnonymizePluginPointsStep

All Implemented Interfaces:

AnonymizeOperationStep, StepWithPluginPointInvocations

public class AnonymizePluginPointsStep
extends Object
implements AnonymizeOperationStep, StepWithPluginPointInvocations

Constructor Summary

Constructors

Constructor and Description
AnonymizePluginPointsStep(UserAnonymizationService userAnonymizationService)

Method Summary

Modifier and Type	Method and 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.
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).
BusinessLogicValidationResult	validateBusinessLogic(AnonymizationParameters anonymizationParameters)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.user.anonymize.operations.AnonymizeOperationStep

shouldPerformOperation

Constructor Detail

AnonymizePluginPointsStep

public AnonymizePluginPointsStep(UserAnonymizationService userAnonymizationService)

Method Detail

performOperation

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

Description copied from interface: AnonymizeOperationStep

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.

Specified by:

performOperation in interface AnonymizeOperationStep

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
public ServiceResult validate(@Nonnull
                                       AnonymizeUserService.AnonymizeProcessData anonymizationProcessData,
                                       I18nHelper i18nHelper,
                                       boolean preValidate)

Description copied from interface: AnonymizeOperationStep

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.

Specified by:

validate in interface AnonymizeOperationStep

Parameters:

anonymizationProcessData - Data to validate.

i18nHelper - I18n helper

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

Returns:

Validation result.

getAffectedEntities

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

Description copied from interface: AnonymizeOperationStep

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

Specified by:

getAffectedEntities in interface AnonymizeOperationStep

Parameters:

anonymizationData - Anonymization data.

Returns:

Affected entities.

getAnonymizeOperation

@Nonnull
public AnonymizeUserService.AnonymizeOperation getAnonymizeOperation()

Description copied from interface: AnonymizeOperationStep

Type of operation this handler supports.

Specified by:

getAnonymizeOperation in interface AnonymizeOperationStep

Returns:

Operation this handler supports.

getNumberOfTasks

public int getNumberOfTasks(@Nonnull
                            AnonymizeUserService.AnonymizeValidationResult validationResult)

Description copied from interface: AnonymizeOperationStep

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).

Specified by:

getNumberOfTasks in interface AnonymizeOperationStep

Parameters:

validationResult - Validation result

Returns:

Number of tasks/stages to be executed

validateBusinessLogic

@Nonnull
public BusinessLogicValidationResult validateBusinessLogic(@Nonnull
                                                                    AnonymizationParameters anonymizationParameters)

Specified by:

validateBusinessLogic in interface StepWithPluginPointInvocations