Package com.atlassian.jira.user.anonymize.handlers.anonymize

Class UserProfileAnonymizationHandler

java.lang.Object

com.atlassian.jira.user.anonymize.handlers.anonymize.UserProfileAnonymizationHandler

All Implemented Interfaces:

AnonymizationHandler<UserAnonymizationParameter>, UserAnonymizationHandler

public class UserProfileAnonymizationHandler
extends Object
implements UserAnonymizationHandler

Field Summary

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

DEFAULT_NUMBER_OF_TASKS

Constructor Summary

Constructors

Constructor

Description

UserProfileAnonymizationHandler(JiraAuthenticationContext jiraAuthenticationContext, UserManager userManager, UserKeyStore userKeyStore, com.atlassian.crowd.embedded.api.CrowdService crowdService, AvatarManager avatarManager, com.atlassian.seraph.spi.rememberme.RememberMeTokenDao rememberMeTokenDao, UserPropertyManager userPropertyManager, JsonEntityPropertyManager jsonEntityPropertyManager, UserHistoryStore userHistoryStore, I18nHelper i18n, BaseUrl baseUrl, ExtendedUserDao extendedUserDao, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method	Description
Collection<AffectedEntity>	getAffectedEntities(UserAnonymizationParameter userAnonymizationParameter)	Used to collect a list of entities that will be affected by the anonymization process.
ServiceResult	update(UserAnonymizationParameter parameter)	Performs the updates required by the user anonymization.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getNumberOfTasks, validateBusinessLogic

Constructor Details

UserProfileAnonymizationHandler

public UserProfileAnonymizationHandler(JiraAuthenticationContext jiraAuthenticationContext,
 UserManager userManager,
 UserKeyStore userKeyStore,
 com.atlassian.crowd.embedded.api.CrowdService crowdService,
 AvatarManager avatarManager,
 com.atlassian.seraph.spi.rememberme.RememberMeTokenDao rememberMeTokenDao,
 UserPropertyManager userPropertyManager,
 JsonEntityPropertyManager jsonEntityPropertyManager,
 UserHistoryStore userHistoryStore,
 I18nHelper i18n,
 BaseUrl baseUrl,
 ExtendedUserDao extendedUserDao,
 com.atlassian.event.api.EventPublisher eventPublisher)

Method Details

getAffectedEntities

@Nonnull
public Collection<AffectedEntity> getAffectedEntities(@Nonnull
 UserAnonymizationParameter userAnonymizationParameter)

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:

userAnonymizationParameter - Data relevant to the handled anonymization step, e.g. previous and new (anonymized) username

Returns:

a collection of affected entities

update

@Nonnull
public ServiceResult update(@Nonnull
 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