com.atlassian.jira.user.anonymize

Class UserPropertyChangeService<H extends AnonymizationHandler<P>,P extends TaskContextAware>

java.lang.Object

com.atlassian.jira.user.anonymize.UserPropertyChangeService<H,P>

Direct Known Subclasses:

OwnershipTransferChangeService, UserAnonymizationService, UserKeyChangeService, UserNameChangeService

public abstract class UserPropertyChangeService<H extends AnonymizationHandler<P>,P extends TaskContextAware>
extends Object

Contains common logic used across user property change services.

Since:

v8.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserPropertyChangeService.UserPropertyChangeRequest<P> Represents request to change user property.
static class	UserPropertyChangeService.UserPropertyChangeValidationResult<P> User property change validation result.

Constructor Summary

Constructors

Constructor and Description
UserPropertyChangeService()

Method Summary

Modifier and Type	Method and Description
ServiceOutcomeWithWarnings<Collection<AffectedEntity>>	getAffectedEntities(UserPropertyChangeService.UserPropertyChangeRequest<P> userPropertyChangeRequest) Calls validation validateUserPropertyChange(UserPropertyChangeRequest) Gets affected entities from AnonymizationHandler extension point
protected ServiceOutcomeWithWarnings<Collection<AffectedEntity>>	getAffectedEntitiesFromHandlers(UserPropertyChangeService.UserPropertyChangeRequest<P> userPropertyChangeRequest)
protected abstract String	getHandlerDescriptionKey()
protected I18nHelper	getI18nBean(ApplicationUser user)
protected abstract UserPropertyChangeManager<H,P>	getManager()
int	getNumberOfTasks(P userPropertyChangeParameter) Returns number of tasks/stages to be executed as part of this handler execution.
protected boolean	isAdministrator(ApplicationUser user)
protected boolean	isSysAdmin(ApplicationUser user)
ServiceResult	userPropertyChange(UserPropertyChangeService.UserPropertyChangeValidationResult<P> userPropertyChangeValidationResult) Performs validation (validateUserPropertyChange(UserPropertyChangeRequest)) Updates user property in Jira
ServiceResultWithWarnings	userPropertyChangeInOtherEntities(UserPropertyChangeService.UserPropertyChangeValidationResult<P> userPropertyChangeValidationResult) Changes user property using plugin points (handlers implementing AnonymizationHandler).
BusinessLogicValidationResult	validateBusinessLogic(AnonymizationParameters anonymizationParameters)
abstract UserPropertyChangeService.UserPropertyChangeValidationResult<P>	validateUserPropertyChange(UserPropertyChangeService.UserPropertyChangeRequest<P> userPropertyChangeRequest) Validates if user property change is possible.
abstract UserPropertyChangeService.UserPropertyChangeValidationResult<P>	validateUserPropertyChangeInOtherEntities(UserPropertyChangeService.UserPropertyChangeRequest<P> userPropertyChangeRequest) Validates if user property change is possible in external entities (using plugin system).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserPropertyChangeService

public UserPropertyChangeService()

Method Detail

getManager

@Nonnull
protected abstract UserPropertyChangeManager<H,P> getManager()

Returns:

A UserPropertyChangeManager appropriate for the user property handled by the implementation

getHandlerDescriptionKey

@Nonnull
protected abstract String getHandlerDescriptionKey()

Returns:

An i18n key of the description of the handler

getNumberOfTasks

public int getNumberOfTasks(@Nonnull
                            P userPropertyChangeParameter)

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 userPropertyChangeInOtherEntities(UserPropertyChangeValidationResult).

Returns:

Number of tasks/stages to be executed by all handlers

validateUserPropertyChange

@Nonnull
public abstract UserPropertyChangeService.UserPropertyChangeValidationResult<P> validateUserPropertyChange(@Nonnull
                                                                                                                    UserPropertyChangeService.UserPropertyChangeRequest<P> userPropertyChangeRequest)

Validates if user property change is possible.

Parameters:

userPropertyChangeRequest - Change user property request.

Returns:

Validation result.

validateUserPropertyChangeInOtherEntities

@Nonnull
public abstract UserPropertyChangeService.UserPropertyChangeValidationResult<P> validateUserPropertyChangeInOtherEntities(@Nonnull
                                                                                                                                   UserPropertyChangeService.UserPropertyChangeRequest<P> userPropertyChangeRequest)

Validates if user property change is possible in external entities (using plugin system).

Parameters:

userPropertyChangeRequest - Change user property request.

Returns:

Validation result.

userPropertyChange

@Nonnull
public ServiceResult userPropertyChange(@Nonnull
                                                 UserPropertyChangeService.UserPropertyChangeValidationResult<P> userPropertyChangeValidationResult)

• Performs validation (validateUserPropertyChange(UserPropertyChangeRequest))
• Updates user property in Jira

If the request is not valid or validateUserPropertyChange(UserPropertyChangeRequest) was not called prior to this method an IllegalArgumentException would get thrown.

Parameters:

userPropertyChangeValidationResult - The validated result.

Returns:

User property change result.

userPropertyChangeInOtherEntities

@Nonnull
public ServiceResultWithWarnings userPropertyChangeInOtherEntities(@Nonnull
                                                                            UserPropertyChangeService.UserPropertyChangeValidationResult<P> userPropertyChangeValidationResult)

Changes user property using plugin points (handlers implementing AnonymizationHandler). Errors from handlers are reported in warning map, they don't cause error result.

Parameters:

userPropertyChangeValidationResult - Validation result.

Returns:

User property change result.

getAffectedEntities

@Nonnull
public ServiceOutcomeWithWarnings<Collection<AffectedEntity>> getAffectedEntities(@Nonnull
                                                                                           UserPropertyChangeService.UserPropertyChangeRequest<P> userPropertyChangeRequest)

• Calls validation validateUserPropertyChange(UserPropertyChangeRequest)
• Gets affected entities from AnonymizationHandler extension point

Exceptions from AnonymizationHandler.getAffectedEntities(Object)} are treated as warnings and end up in ServiceOutcomeWithWarnings.getWarnings()

Parameters:

userPropertyChangeRequest - Change request.

Returns:

Result containing list of affected entities (AffectedEntity).

validateBusinessLogic

@Nonnull
public BusinessLogicValidationResult validateBusinessLogic(@Nonnull
                                                                    AnonymizationParameters anonymizationParameters)

getAffectedEntitiesFromHandlers

@Nonnull
protected ServiceOutcomeWithWarnings<Collection<AffectedEntity>> getAffectedEntitiesFromHandlers(@Nonnull
                                                                                                          UserPropertyChangeService.UserPropertyChangeRequest<P> userPropertyChangeRequest)

isAdministrator

protected boolean isAdministrator(@Nullable
                                  ApplicationUser user)

isSysAdmin

protected boolean isSysAdmin(@Nullable
                             ApplicationUser user)

getI18nBean

protected I18nHelper getI18nBean(ApplicationUser user)