com.atlassian.jira.user.anonymize

Interface UserKeyChangeHandler

All Superinterfaces:

AnonymizationHandler<UserPropertyChangeParameter>

All Known Implementing Classes:

AbstractUserKeyInWorkflowChangeHandler, CustomFieldDefaultValueUserKeyChangeHandler, CustomFieldValueUserKeyChangeHandler, DelegatingChangeHandler, ForeignKeyChangeHandler, GenericUserKeyChangeHandler, IssueHistoryCustomFieldMultiUserKeyChangeHandler, IssueHistoryCustomFieldUserKeyChangeHandler, IssueHistoryUserKeyChangeHandler, ReferenceUserKeyChangeHandler, UserKeyChangeHandlerWithBLValidationErrors, UserKeyInDraftWorkflowChangeHandler, UserKeyInWorkflowChangeHandler

public interface UserKeyChangeHandler
extends AnonymizationHandler<UserPropertyChangeParameter>

Performs operations related to a change of a user key, e.g. it should update foreign keys referencing this user key in the database.

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

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

Since:

8.3

See Also:

AnonymizationHandler, OwnershipTransferHandler, UserAnonymizationHandler, 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