com.atlassian.jira.dev.reference.plugin.user

Class ReferenceUserKeyChangeHandler

java.lang.Object

com.atlassian.jira.dev.reference.plugin.user.ReferenceUserKeyChangeHandler

All Implemented Interfaces:

AnonymizationHandler<UserPropertyChangeParameter>, UserKeyChangeHandler

public class ReferenceUserKeyChangeHandler
extends Object
implements UserKeyChangeHandler

Reference handler that is used to process user key change request.

Constructor Summary

Constructors

Constructor and Description
ReferenceUserKeyChangeHandler(JiraAuthenticationContext jiraAuthenticationContext)

Method Summary

Modifier and Type	Method and Description
Collection<AffectedEntity>	getAffectedEntities(UserPropertyChangeParameter userPropertyChangeParameter) Used to display in the UI a list of entities that are affected by anonymization process, without actually performing the operation yet.
int	getNumberOfTasks(UserPropertyChangeParameter userPropertyChangeParameter) Returns number of tasks/stages to be executed as part of this handler execution.
ServiceResult	update(UserPropertyChangeParameter userPropertyChangeParameter) 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

Constructor Detail

ReferenceUserKeyChangeHandler

public ReferenceUserKeyChangeHandler(JiraAuthenticationContext jiraAuthenticationContext)

Method Detail

getAffectedEntities

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

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

Parameters:

userPropertyChangeParameter - Parameter

Returns:

a collection of affected entities

update

@Nonnull
public ServiceResult update(@Nonnull
                                     UserPropertyChangeParameter userPropertyChangeParameter)

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

Parameters:

userPropertyChangeParameter - Parameter

Returns:

a service outcome of the update operation, containing any errors

getNumberOfTasks

public int getNumberOfTasks(@Nonnull
                            UserPropertyChangeParameter userPropertyChangeParameter)

Description copied from interface: AnonymizationHandler

Returns number of tasks/stages to be executed as part of this handler execution. The number returned here must be consistent with the number of updates performed as part of AnonymizationHandler.update(Object).

It's used to calculate task progress. Eg. handler returning 1000 from this method is responsible to execute 1000 calls to Context.start(object); and Context.Task.complete(); in AnonymizationHandler.update(Object).

Default implementation returns 1000 tasks which means that each handle by default will have 1000 steps to complete, it's up to handler to decide how progress is reported eg. complete all 1000 steps at once or in some chunks.

When visualizing progress each handler has progress bar part that has length proportional to the number returned by this method. If you know that your handler will execute swiftly you can return lower number here eg. 100 (progress bar part for this handler will be 10 times shorter than those that return 1000).

Specified by:

getNumberOfTasks in interface AnonymizationHandler<UserPropertyChangeParameter>

Returns:

Number of tasks/stages to be executed