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

Class IssueHistoryUserKeyChangeHandler

java.lang.Object

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

All Implemented Interfaces:

AnonymizationHandler<UserPropertyChangeParameter>, UserKeyChangeHandler

Direct Known Subclasses:

IssueHistoryCustomFieldMultiUserKeyChangeHandler, IssueHistoryCustomFieldUserKeyChangeHandler

public class IssueHistoryUserKeyChangeHandler
extends Object
implements UserKeyChangeHandler

Anonymization of user key changes in issue history table

Since:

v8.4

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ENTITY_NAME
protected JiraAuthenticationContext	jiraAuthenticationContext
protected QueryDslAccessor	queryDslAccessor

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

DEFAULT_NUMBER_OF_TASKS

Constructor Summary

Constructors

Constructor and Description
IssueHistoryUserKeyChangeHandler(JiraAuthenticationContext jiraAuthenticationContext, QueryDslAccessor queryDslAccessor, DatabaseAccessor databaseAccessor, int stepNumber, List<IssueHistoryInfo> infos)

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.
protected List<Long>	getAffectedEntitiesIds(String original, IssueHistoryInfo foreignKeyInfo)
protected com.querydsl.sql.SQLQuery<Long>	getBaseQuery(String original, IssueHistoryInfo foreignKeyInfo, DbConnection connection)
protected List<IssueHistoryInfo>	getInfos()
int	getNumberOfTasks(UserPropertyChangeParameter userPropertyChangeParameter) Returns the number of tasks/stages to be executed in AnonymizationHandler.update(Object).
ServiceResult	update(UserPropertyChangeParameter userPropertyChangeParameter) Performs the updates required by the user anonymization.
protected long	updateCustomField(IssueHistoryInfo info, String original, String target)

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

ENTITY_NAME

protected static final String ENTITY_NAME

See Also:

Constant Field Values

jiraAuthenticationContext

protected final JiraAuthenticationContext jiraAuthenticationContext

queryDslAccessor

protected final QueryDslAccessor queryDslAccessor

Constructor Detail

IssueHistoryUserKeyChangeHandler

public IssueHistoryUserKeyChangeHandler(JiraAuthenticationContext jiraAuthenticationContext,
                                        QueryDslAccessor queryDslAccessor,
                                        DatabaseAccessor databaseAccessor,
                                        int stepNumber,
                                        List<IssueHistoryInfo> infos)

Method Detail

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

getInfos

protected List<IssueHistoryInfo> getInfos()

getAffectedEntitiesIds

protected List<Long> getAffectedEntitiesIds(String original,
                                            IssueHistoryInfo foreignKeyInfo)

getBaseQuery

protected com.querydsl.sql.SQLQuery<Long> getBaseQuery(String original,
                                                       IssueHistoryInfo foreignKeyInfo,
                                                       DbConnection connection)

updateCustomField

protected long updateCustomField(IssueHistoryInfo info,
                                 String original,
                                 String target)