@PublicApi public class

UserMapper

extends AbstractMapper
java.lang.Object
   ↳ com.atlassian.jira.imports.project.mapper.AbstractMapper
     ↳ com.atlassian.jira.imports.project.mapper.UserMapper

@PublicApi

This class is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Allows you to map Users. We keep the whole ExternalUser information so we can create Users that don't exist.

Summary

Public Constructors
UserMapper(UserUtil userUtil)
Public Methods
void flagUserAsInUse(String oldUserKey)
void flagUserAsMandatory(String oldUserKey)
ExternalUser getExternalUser(String userKey)
String getMappedId(String oldId)
Retrieves a String that corresponds to the id in the target JIRA system, null if none has been mapped.
String getMappedUserKey(String oldUserKey)
Collection<String> getOptionalOldIds()
Collection<ExternalUser> getUnmappedMandatoryUsers()
List<ExternalUser> getUnmappedMandatoryUsersWithNoRegisteredOldValue()
Collection<ExternalUser> getUnmappedUsersInUse()
List<ExternalUser> getUnmappedUsersInUseWithNoRegisteredOldValue()
Collection<ExternalUser> getUsersToAutoCreate()
Returns a List of users that can be automatically created by the import.
void registerOldValue(ExternalUser externalUser)
boolean userExists(String userKey)
[Expand]
Inherited Methods
From class com.atlassian.jira.imports.project.mapper.AbstractMapper
From class java.lang.Object
From interface com.atlassian.jira.imports.project.mapper.ProjectImportIdMapper

Public Constructors

public UserMapper (UserUtil userUtil)

Public Methods

public void flagUserAsInUse (String oldUserKey)

public void flagUserAsMandatory (String oldUserKey)

public ExternalUser getExternalUser (String userKey)

public String getMappedId (String oldId)

Retrieves a String that corresponds to the id in the target JIRA system, null if none has been mapped.

Parameters
oldId identifies the mapping we are looking for.
Returns
  • String that corresponds to the id in the target JIRA system, null if none has been mapped.

public String getMappedUserKey (String oldUserKey)

public Collection<String> getOptionalOldIds ()

public Collection<ExternalUser> getUnmappedMandatoryUsers ()

public List<ExternalUser> getUnmappedMandatoryUsersWithNoRegisteredOldValue ()

public Collection<ExternalUser> getUnmappedUsersInUse ()

public List<ExternalUser> getUnmappedUsersInUseWithNoRegisteredOldValue ()

public Collection<ExternalUser> getUsersToAutoCreate ()

Returns a List of users that can be automatically created by the import.

This includes all optional and mandatory users that aren't in the current system, and the import file has the user details for.

Note that this method only makes sense if External User Management is off.

Returns
  • a List of users that can be automatically created by the import.

public void registerOldValue (ExternalUser externalUser)

public boolean userExists (String userKey)