Package com.atlassian.jira.dev.functest.user.anonymize

Class UserAnonymizationHandlerWithBLValidationErrors

java.lang.Object
com.atlassian.jira.dev.functest.user.anonymize.UserAnonymizationHandlerWithBLValidationErrors
All Implemented Interfaces:
AnonymizationHandler<UserAnonymizationParameter>, UserAnonymizationHandler
@ReturnValuesAreNonnullByDefault public class UserAnonymizationHandlerWithBLValidationErrors extends Object implements UserAnonymizationHandler

  • Constructor Details

    • UserAnonymizationHandlerWithBLValidationErrors

      public UserAnonymizationHandlerWithBLValidationErrors()

  • Method Details

    • getAffectedEntities

      public Collection<AffectedEntity> getAffectedEntities(UserAnonymizationParameter parameter)
      Description copied from interface: AnonymizationHandler
      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.

      Specified by:
      getAffectedEntities in interface AnonymizationHandler<UserAnonymizationParameter>
      Parameters:
      parameter - Data relevant to the handled anonymization step, e.g. previous and new (anonymized) username
      Returns:
      a collection of affected entities

    • update

      public ServiceResult update(UserAnonymizationParameter parameter)
      Description copied from interface: AnonymizationHandler
      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.

      Specified by:
      update in interface AnonymizationHandler<UserAnonymizationParameter>
      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

    • validateBusinessLogic

      @Nullable public SimpleErrorCollection validateBusinessLogic(AnonymizationParameters anonymizationParametes)
      Description copied from interface: AnonymizationHandler
      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.

      Specified by:
      validateBusinessLogic in interface AnonymizationHandler<UserAnonymizationParameter>
      Returns:
      an ErrorCollection, containing translated business logic validation errors if there were any, null otherwise