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

Class DisplayNameInSingleUserFieldHistory

java.lang.Object

com.atlassian.jira.user.anonymize.handlers.anonymize.DisplayNameInSingleUserFieldHistory

All Implemented Interfaces:

AnonymizationHandler<UserAnonymizationParameter>, UserAnonymizationHandler

@ParametersAreNonnullByDefault
@ReturnValuesAreNonnullByDefault
public class DisplayNameInSingleUserFieldHistory
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
DisplayNameInSingleUserFieldHistory(QueryDslAccessor queryDslAccessor, DatabaseAccessor databaseAccessor, UserManager userManager, UserKeyStore userKeyStore)

Method Summary

Modifier and Type	Method	Description
Collection<AffectedEntity>	getAffectedEntities(UserAnonymizationParameter parameter)	Used to collect a list of entities that will be affected by the anonymization process.
int	getNumberOfTasks(UserAnonymizationParameter userPropertyChangeParameter)	Returns the number of tasks/stages to be executed in AnonymizationHandler.update(Object).
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

validateBusinessLogic

Constructor Details

DisplayNameInSingleUserFieldHistory

public DisplayNameInSingleUserFieldHistory(QueryDslAccessor queryDslAccessor,
 DatabaseAccessor databaseAccessor,
 UserManager userManager,
 UserKeyStore userKeyStore)

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

getNumberOfTasks

public int getNumberOfTasks(UserAnonymizationParameter userPropertyChangeParameter)

Description copied from interface: AnonymizationHandler

Returns the number of tasks/stages to be executed in AnonymizationHandler.update(Object). Used for diving the progress bar between all of the handlers in proportions based on the returned numbers.

Implementations are responsible to execute the corresponding number of calls to Context.start(object); and Context.Task.complete(); in AnonymizationHandler.update(Object).

Specified by:

getNumberOfTasks in interface AnonymizationHandler<UserAnonymizationParameter>

Returns:

Number of tasks/stages to be executed

See Also:

• AnonymizationHandler.DEFAULT_NUMBER_OF_TASKS