com.atlassian.jira.user.anonymize.handlers.ownership

Class ProjectLeadOwnershipTransferHandler

java.lang.Object

com.atlassian.jira.user.anonymize.handlers.ownership.ProjectLeadOwnershipTransferHandler

All Implemented Interfaces:

AnonymizationHandler<OwnershipTransferParameter>, OwnershipTransferHandler

public class ProjectLeadOwnershipTransferHandler
extends Object
implements OwnershipTransferHandler

Responsible for updating project lead when a user is being anonymized.

Since:

v8.4

Constructor Summary

Constructors

Constructor and Description
ProjectLeadOwnershipTransferHandler(QueryDslAccessor queryDslAccessor, ProjectManager projectManager, JiraAuthenticationContext jiraAuthenticationContext)

Method Summary

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

ProjectLeadOwnershipTransferHandler

public ProjectLeadOwnershipTransferHandler(QueryDslAccessor queryDslAccessor,
                                           ProjectManager projectManager,
                                           JiraAuthenticationContext jiraAuthenticationContext)

Method Detail

getAffectedEntities

@Nonnull
public Collection<AffectedEntity> getAffectedEntities(@Nonnull
                                                               OwnershipTransferParameter ownershipTransferParameter)

Description copied from interface: OwnershipTransferHandler

Used to display in the UI a list of entities that require an ownership transfer, without actually performing the operation yet. Its goal is to inform the end-user about the scope of the changes. Implementation should not use OwnershipTransferParameter.getTransferToUserKey() during computing affected entities.

This method should return results as fast as possible, as it is affecting the UI.

Specified by:

getAffectedEntities in interface AnonymizationHandler<OwnershipTransferParameter>

Specified by:

getAffectedEntities in interface OwnershipTransferHandler

Parameters:

ownershipTransferParameter - stores original and target user keys

Returns:

a collection of entities that will be affected by the ownership transfer

update

@Nonnull
public ServiceResult update(@Nonnull
                                     OwnershipTransferParameter ownershipTransferParameter)

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

Parameters:

ownershipTransferParameter - Parameter

Returns:

a service outcome of the update operation, containing any errors

getNumberOfTasks

public int getNumberOfTasks(@Nonnull
                            OwnershipTransferParameter ownershipTransferParameter)

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

Returns:

Number of tasks/stages to be executed