com.atlassian.jira.user.anonymize

Interface UserNameChangeHandler

All Superinterfaces:

AnonymizationHandler<UserPropertyChangeParameter>

All Known Implementing Classes:

MentionUsernameChangeHandler, ReferenceUserNameChangeHandler, UpdateUsernameInWebhookDaoChangeHandler, UserNameChangeHandlerWithBLValidationErrors

public interface UserNameChangeHandler
extends AnonymizationHandler<UserPropertyChangeParameter>

Performs operations related to a change of a user name, e.g. in response to a user name change it should update mentions of the user in comments.

Those extension points are executed as the fourth step of the user anonymization process, after UserKeyChangeHandler. 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-name-change-handler module to the atlassian-plugin.xml, e.g.:

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

Since:

8.3

See Also:

AnonymizationHandler, OwnershipTransferHandler, UserAnonymizationHandler, UserKeyChangeHandler

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