com.atlassian.jira.user

Class UserProfileAnonymizationHandler

java.lang.Object

com.atlassian.jira.user.UserProfileAnonymizationHandler

All Implemented Interfaces:

AnonymizationHandler<UserAnonymizationParameter>, UserAnonymizationHandler

public class UserProfileAnonymizationHandler
extends Object
implements UserAnonymizationHandler

Constructor Summary

Constructors

Constructor and Description

UserProfileAnonymizationHandler(JiraAuthenticationContext jiraAuthenticationContext, UserManager userManager, UserKeyStore userKeyStore, com.atlassian.crowd.embedded.api.CrowdService crowdService, AvatarManager avatarManager, com.atlassian.seraph.spi.rememberme.RememberMeTokenDao rememberMeTokenDao, JiraPropertySetFactory propertySetFactory, JsonEntityPropertyManager jsonEntityPropertyManager, UserHistoryStore userHistoryStore, I18nHelper i18n, BaseUrl baseUrl)

Method Summary

Modifier and Type	Method and Description
Collection<AffectedEntity>	getAffectedEntities(UserAnonymizationParameter userAnonymizationParameter) Used to display in the UI a list of entities that are affected by anonymization process, without actually performing the operation yet.
ServiceResult	update(UserAnonymizationParameter parameter) Performs the update operations related to the affected entities.

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

Constructor Detail

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,
                                       JiraPropertySetFactory propertySetFactory,
                                       JsonEntityPropertyManager jsonEntityPropertyManager,
                                       UserHistoryStore userHistoryStore,
                                       I18nHelper i18n,
                                       BaseUrl baseUrl)

Method Detail

getAffectedEntities

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

Description copied from interface: AnonymizationHandler

Used to display in the UI a list of entities that are affected by anonymization process, without actually performing the operation yet. Its goal is to inform the end-user about the scope of the changes. This method should return results as fast as possible, as it is affecting the UI.

Specified by:

getAffectedEntities in interface AnonymizationHandler<UserAnonymizationParameter>

Parameters:

userAnonymizationParameter - Parameter

Returns:

a collection of affected entities

update

@Nonnull
public ServiceResult update(@Nonnull
                                     UserAnonymizationParameter parameter)

Description copied from interface: AnonymizationHandler

Performs the update operations related to the affected entities. This method is executed in a background task and thus its accuracy is more important than performance. This method should be idempotent - multiple invocations of this method should lead to the same result. In other words when method fails we can call it again and finish operation. During execution, the implementation class will update the progress by typically calling Context.start(object); on the context passed in parameter, and subsequently call Context.Task.complete(); on the the task object to indicate task has finished. Implementation 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 - Parameter

Returns:

a service outcome of the update operation, containing any errors