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

Class AbstractUserKeyInWorkflowChangeHandler

java.lang.Object

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

All Implemented Interfaces:

AnonymizationHandler<UserPropertyChangeParameter>, UserKeyChangeHandler

Direct Known Subclasses:

UserKeyInDraftWorkflowChangeHandler, UserKeyInWorkflowChangeHandler

public abstract class AbstractUserKeyInWorkflowChangeHandler
extends Object
implements UserKeyChangeHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected WorkflowManager	workflowManager

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

DEFAULT_NUMBER_OF_TASKS

Constructor Summary

Constructors

Constructor and Description
AbstractUserKeyInWorkflowChangeHandler(WorkflowManager workflowManager, JiraAuthenticationContext jiraAuthenticationContext)

Method Summary

Modifier and Type	Method and Description
Collection<AffectedEntity>	getAffectedEntities(UserPropertyChangeParameter userPropertyChangeParameter) Used to collect a list of entities that will be affected by the anonymization process.
protected abstract String	getDescriptionKey()
protected abstract String	getTaskDescriptionKey() Description key of the currently executed task.
protected abstract Collection<JiraWorkflow>	getWorkflows()
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

getNumberOfTasks, validateBusinessLogic

Field Detail

workflowManager

protected final WorkflowManager workflowManager

Constructor Detail

AbstractUserKeyInWorkflowChangeHandler

public AbstractUserKeyInWorkflowChangeHandler(WorkflowManager workflowManager,
                                              JiraAuthenticationContext jiraAuthenticationContext)

Method Detail

getAffectedEntities

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

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

Parameters:

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

Returns:

a collection of affected entities

getDescriptionKey

protected abstract String getDescriptionKey()

getWorkflows

protected abstract Collection<JiraWorkflow> getWorkflows()

getTaskDescriptionKey

protected abstract String getTaskDescriptionKey()

Description key of the currently executed task. Used to report progress to the end user.

Returns:

Task description key

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