com.atlassian.jira.user.anonymize.handlers.key

Class CustomFieldValueUserKeyChangeHandler

java.lang.Object

com.atlassian.jira.user.anonymize.handlers.key.CustomFieldValueUserKeyChangeHandler

All Implemented Interfaces:

AnonymizationHandler<UserPropertyChangeParameter>, UserKeyChangeHandler

public class CustomFieldValueUserKeyChangeHandler
extends Object
implements UserKeyChangeHandler

Handles changing 'userkey' in custom fields values.

Since:

v8.4

Field Summary

Fields

Modifier and Type	Field and Description
static String	MULTIUSERPICKER_CF_TYPE
static String	USERPICKER_CF_TYPE

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

DEFAULT_NUMBER_OF_TASKS

Method Summary

Modifier and Type	Method and Description
Collection<AffectedEntity>	getAffectedEntities(UserPropertyChangeParameter userPropertyChangeParameter) This class is only called by DelegatingChangeHandler and this method is not used, to not clutter the UI.
int	getNumberOfTasks(UserPropertyChangeParameter userPropertyChangeParameter) Returns the number of tasks/stages to be executed in AnonymizationHandler.update(Object).
static CustomFieldValueUserKeyChangeHandler	multiUserPicker(QueryDslAccessor queryDslAccessor, int numberOfTasks) Builds CustomFieldValueKeyChangeHandler handling fields with type of "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker".
static CustomFieldValueUserKeyChangeHandler	singleUserPicker(QueryDslAccessor queryDslAccessor, int numberOfTasks) Builds CustomFieldValueKeyChangeHandler handling fields with type of "com.atlassian.jira.plugin.system.customfieldtypes:userpicker".
ServiceResult	update(UserPropertyChangeParameter userPropertyChangeParameter) 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

Field Detail

USERPICKER_CF_TYPE

public static final String USERPICKER_CF_TYPE

See Also:

Constant Field Values

MULTIUSERPICKER_CF_TYPE

public static final String MULTIUSERPICKER_CF_TYPE

See Also:

Constant Field Values

Method Detail

singleUserPicker

public static CustomFieldValueUserKeyChangeHandler singleUserPicker(QueryDslAccessor queryDslAccessor,
                                                                    int numberOfTasks)

Builds CustomFieldValueKeyChangeHandler handling fields with type of "com.atlassian.jira.plugin.system.customfieldtypes:userpicker".

multiUserPicker

public static CustomFieldValueUserKeyChangeHandler multiUserPicker(QueryDslAccessor queryDslAccessor,
                                                                   int numberOfTasks)

Builds CustomFieldValueKeyChangeHandler handling fields with type of "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker".

getAffectedEntities

@Nonnull
public Collection<AffectedEntity> getAffectedEntities(@Nonnull
                                                               UserPropertyChangeParameter userPropertyChangeParameter)

This class is only called by DelegatingChangeHandler and this method is not used, to not clutter the UI.

Specified by:

getAffectedEntities in interface AnonymizationHandler<UserPropertyChangeParameter>

Parameters:

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

Returns:

a collection of affected entities

See Also:

DelegatingChangeHandler.getAffectedEntities(UserPropertyChangeParameter)

update

@Nonnull
public ServiceResult update(@Nonnull
                                     UserPropertyChangeParameter userPropertyChangeParameter)

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<UserPropertyChangeParameter>

Parameters:

userPropertyChangeParameter - 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(@Nonnull
                            UserPropertyChangeParameter 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<UserPropertyChangeParameter>

Returns:

Number of tasks/stages to be executed

See Also:

AnonymizationHandler.DEFAULT_NUMBER_OF_TASKS