com.atlassian.jira.user.anonymize

Interface AnonymizationHandler<T>

All Known Subinterfaces:

OwnershipTransferHandler, UserAnonymizationHandler, UserKeyChangeHandler, UserNameChangeHandler

All Known Implementing Classes:

AbstractUserKeyInWorkflowChangeHandler, CommentsReindexUserKeyChangeHandler, CustomFieldDefaultValueUserKeyChangeHandler, CustomFieldValueUserKeyChangeHandler, DelegatingChangeHandler, ForeignKeyChangeHandler, GenericUserKeyChangeHandler, GenericUserKeyWithReindexChangeHandler, IssuesReindexUserKeyChangeHandler, ReferenceOwnershipTransferHandler, ReferenceUserKeyChangeHandler, UserKeyInDraftWorkflowChangeHandler, UserKeyInWorkflowChangeHandler, UserProfileAnonymizationHandler, WorklogsReindexUserKeyChangeHandler

@ExperimentalApi
public interface AnonymizationHandler<T>

Performs operations related to anonymization process, e.g. anonymize user data in profile, anonymize user key and referencing foreign keys so they don't contain personal data etc.

Since:

8.3

See Also:

UserAnonymizationHandler, OwnershipTransferHandler, UserKeyChangeHandler, UserNameChangeHandler

Method Summary

Modifier and Type	Method and Description
Collection<AffectedEntity>	getAffectedEntities(T parameter) Used to display in the UI a list of entities that are affected by anonymization process, without actually performing the operation yet.
default int	getNumberOfTasks(T userPropertyChangeParameter) Returns number of tasks/stages to be executed as part of this handler execution.
ServiceResult	update(T parameter) Performs the update operations related to the affected entities.

Method Detail

getAffectedEntities

@Nonnull
Collection<AffectedEntity> getAffectedEntities(@Nonnull
                                                        T parameter)

Used to display in the UI a list of entities that are affected by anonymization process, without actually performing the operation yet. Its goal is to inform the end-user about the scope of the changes. This method should return results as fast as possible, as it is affecting the UI.

Parameters:

parameter - Parameter

Returns:

a collection of affected entities

update

@Nonnull
ServiceResult update(@Nonnull
                              T parameter)

Performs the update operations related to the affected entities. This method is executed in a background task and thus its accuracy is more important than performance. This method should be idempotent - multiple invocations of this method should lead to the same result. In other words when method fails we can call it again and finish operation. During execution, the implementation class will update the progress by typically calling Context.start(object); on the context passed in parameter, and subsequently call Context.Task.complete(); on the the task object to indicate task has finished. Implementation can also call Context.setName("Name of current step") to describe the task that is currently processed.

Parameters:

parameter - Parameter

Returns:

a service outcome of the update operation, containing any errors

getNumberOfTasks

default int getNumberOfTasks(@Nonnull
                             T userPropertyChangeParameter)

Returns number of tasks/stages to be executed as part of this handler execution. The number returned here must be consistent with the number of updates performed as part of update(Object). It's used to calculate task progress. Eg. handler returning 1000 from this method is responsible to execute 1000 calls to Context.start(object); and Context.Task.complete(); in update(Object). Default implementation returns 1000 tasks which means that each handle by default will have 1000 steps to complete, it's up to handler to decide how progress is reported eg. complete all 1000 steps at once or in some chunks. When visualizing progress each handler has progress bar part that has length proportional to the number returned by this method. If you know that your handler will execute swiftly you can return lower number here eg. 100 (progress bar part for this handler will be 10 times shorter than those that return 1000).

Returns:

Number of tasks/stages to be executed