com.atlassian.jira.user.anonymize

Interface AnonymizationHandler<T>

All Known Subinterfaces:

OwnershipTransferHandler, UserAnonymizationHandler, UserKeyChangeHandler, UserNameChangeHandler

All Known Implementing Classes:

AbstractUserKeyInWorkflowChangeHandler, ComponentLeadOwnershipTransferHandler, CustomFieldDefaultValueUserKeyChangeHandler, CustomFieldValueUserKeyChangeHandler, DelegatingChangeHandler, DisplayNameInIssueHistoryHandler, DisplayNameInMultiUserFieldHistory, DisplayNameInSingleUserFieldHistory, FilterSubscriptionAnonymizationHandler, FilterSubscriptionOwnershipTransferHandler, ForeignKeyChangeHandler, GenericUserKeyChangeHandler, IssueHistoryCustomFieldMultiUserKeyChangeHandler, IssueHistoryCustomFieldUserKeyChangeHandler, IssueHistoryUserKeyChangeHandler, MentionUsernameChangeHandler, NotificationSchemeAnonymizationHandler, OwnershipTransferHandlerWithBLValidationErrors, PermissionAnonymizationHandler, ProjectLeadOwnershipTransferHandler, ProjectRoleAnonymizationHandler, ReferenceOwnershipTransferHandler, ReferenceUserAnonymizationHandler, ReferenceUserKeyChangeHandler, ReferenceUserNameChangeHandler, UpdateUsernameInWebhookDaoChangeHandler, UserAnonymizationHandlerWithBLValidationErrors, UserKeyChangeHandlerWithBLValidationErrors, UserKeyInDraftWorkflowChangeHandler, UserKeyInWorkflowChangeHandler, UserNameChangeHandlerWithBLValidationErrors, UserProfileAnonymizationHandler

@ParametersAreNonnullByDefault
 @ReturnValuesAreNonnullByDefault
public interface AnonymizationHandler<T>

Performs operations related to the anonymization process, e.g. updating user key entries to the anonymized ones to fix the foreign key relations in the database.

Since:

8.3

See Also:

OwnershipTransferHandler, UserAnonymizationHandler, UserKeyChangeHandler, UserNameChangeHandler

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_NUMBER_OF_TASKS

Method Summary

Modifier and Type	Method and Description
Collection<AffectedEntity>	getAffectedEntities(T parameter) Used to collect a list of entities that will be affected by the anonymization process.
default int	getNumberOfTasks(T userPropertyChangeParameter) Returns the number of tasks/stages to be executed in update(Object).
ServiceResult	update(T parameter) Performs the updates required by the user anonymization.
default ErrorCollection	validateBusinessLogic(AnonymizationParameters anonymizationParameters) Allows handlers to prevent the anonymization if it would break business logic constraints.

Field Detail

DEFAULT_NUMBER_OF_TASKS

static final int DEFAULT_NUMBER_OF_TASKS

See Also:

Constant Field Values

Method Detail

getAffectedEntities

Collection<AffectedEntity> getAffectedEntities(T parameter)

Used to collect a list of entities that will be affected by the anonymization process.

Its goal is to inform the end-user about the expected changes before they trigger the process.

Parameters:

parameter - Data relevant to the handled anonymization step, e.g. previous and new (anonymized) username

Returns:

a collection of affected entities

update

ServiceResult update(T parameter)

Performs the updates required by the user anonymization.

Implementations must be idempotent - multiple invocations of this method should lead to the same result. In particular, when the method fails we can call it again to finish the operation.

During the execution, implementations can update their the progress by calling Context.start(object); on the context passed in parameter, and subsequently call Context.Task.complete(); on the task object to indicate task has finished.

Implementations can also call Context.setName("Name of current step") to describe the task that is currently processed.

Parameters:

parameter - Data relevant to the handled anonymization step, e.g. previous and new (anonymized) username

Returns:

a service outcome of the update operation, containing any errors

getNumberOfTasks

default int getNumberOfTasks(T userPropertyChangeParameter)

Returns the number of tasks/stages to be executed in update(Object). Used for diving the progress bar between all of the handlers in proportions based on the returned numbers.

Implementations are responsible to execute the corresponding number of calls to Context.start(object); and Context.Task.complete(); in update(Object).

Returns:

Number of tasks/stages to be executed

See Also:

DEFAULT_NUMBER_OF_TASKS

validateBusinessLogic

@ExperimentalSpi
default ErrorCollection validateBusinessLogic(AnonymizationParameters anonymizationParameters)

Allows handlers to prevent the anonymization if it would break business logic constraints.

As an example, ownership transfer handler can ensure that an entity can only be transferred to a user with a particular role, e.g. only to another admin.

The calculations done here should be as quick as possible not to degrade the user experience! Only business logic constraints should be checked here. You can assume that the passed in parameters are otherwise valid, e.g. the user to transfer the entity to exists and is not disabled.

Returns:

an ErrorCollection, containing translated business logic validation errors if there were any, null otherwise

Since:

v8.10