com.atlassian.jira.user.anonymize

Interface UserAnonymizationHandler

All Superinterfaces:

AnonymizationHandler<UserAnonymizationParameter>

All Known Implementing Classes:

DisplayNameInIssueHistoryHandler, DisplayNameInMultiUserFieldHistory, DisplayNameInSingleUserFieldHistory, FilterSubscriptionAnonymizationHandler, NotificationSchemeAnonymizationHandler, PermissionAnonymizationHandler, ProjectRoleAnonymizationHandler, ReferenceUserAnonymizationHandler, UserAnonymizationHandlerWithBLValidationErrors, UserProfileAnonymizationHandler

public interface UserAnonymizationHandler
extends AnonymizationHandler<UserAnonymizationParameter>

Deletes or anonymizes user's personal data and data only accessible by the single user. For example, removes private dashboards or filters, and anonymizes user's profile information, like full name or email address.

This extension point is executed as the second step of the user anonymization process, after OwnershipTransferHandler. Any errors returned by the implementations will not stop the process.

To register an instance of this handler to be executed by Jira, implement this interface and add an user-anonymization-handler module to the atlassian-plugin.xml, e.g.:

 <user-anonymization-handler
     key="my-user-anonymization-handler"
     class="com.example.UserAnonymizationHandlerImpl"
     i18n-name-key="anonymization.handler.name">
         <restrict application="jira" version="[8.3.0,)" />
  </user-anonymization-handler>
  

Since:

8.3

See Also:

AnonymizationHandler, OwnershipTransferHandler, UserKeyChangeHandler, UserNameChangeHandler

Field Summary

Fields inherited from interface com.atlassian.jira.user.anonymize.AnonymizationHandler

DEFAULT_NUMBER_OF_TASKS

Method Summary

Methods inherited from interface com.atlassian.jira.user.anonymize.AnonymizationHandler

getAffectedEntities, getNumberOfTasks, update, validateBusinessLogic