Summary: Methods | [Expand All]
@PublicApi public interface

ProjectImportMapper

com.atlassian.jira.imports.project.mapper.ProjectImportMapper
Known Indirect Subclasses

@PublicApi

This interface 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

The parent mapper that holds all sub-mappers that are used for a project import.

Summary

Public Methods
void clearMappedValues()
This will clear any mapped data that may have been entered into the mappers.
SimpleProjectImportIdMapper getChangeGroupMapper()
Gets a ProjectImportIdMapper that maps the change group id's from the old backup project data to the id's generated when adding the change group data to the new JIRA instance.
SimpleProjectImportIdMapper getCommentMapper()
Gets a ProjectImportIdMapper that maps the Comment id's from the old backup project data to the id's in the current system.
SimpleProjectImportIdMapper getComponentMapper()
Gets a ProjectImportIdMapper which, when fully populated, indicates all the project components "in-use" (required) by the backup projects data.
CustomFieldMapper getCustomFieldMapper()
Gets a CustomFieldMapper which, when fully populated, indicates all the custom fields "in-use" (required) by the backup projects data.
CustomFieldOptionMapper getCustomFieldOptionMapper()
Gets a CustomFieldOptionMapper which, when fully populated, indicates how to map the IDs of the Custom Field Options in the Import file, to the equivalent Option in the current JIRA.
GroupMapper getGroupMapper()
Gets a ProjectImportIdMapper which, when fully populated, indicates all the groups "in-use" (required) by the backup projects data.
IssueLinkTypeMapper getIssueLinkTypeMapper()
Gets a ProjectImportIdMapper that maps the IssueLinkType id's from the old backup project data to the id's in the current system.
SimpleProjectImportIdMapper getIssueMapper()
Gets a ProjectImportIdMapper that maps the issue id's from the old backup project data to the id's generated when adding the issue data to the new JIRA instance.
SimpleProjectImportIdMapper getIssueSecurityLevelMapper()
Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue security levels "in-use" (required) by the backup projects data.
IssueTypeMapper getIssueTypeMapper()
Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue issue types "in-use" (required) by the backup projects data.
SimpleProjectImportIdMapper getPriorityMapper()
Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue priorities "in-use" (required) by the backup projects data.
SimpleProjectImportIdMapper getProjectMapper()
Gets a ProjectImportIdMapper which, when fully populated, indicates all the projects from the backup file and the mapped projects in the current JIRA instance.
ProjectRoleActorMapper getProjectRoleActorMapper()
Gets a ProjectRoleActorMapper which, when fully populated, indicates all the ProjectRoleActors "in-use" (optional) by the backup projects data's issues.
SimpleProjectImportIdMapper getProjectRoleMapper()
Gets a ProjectImportIdMapper which, when fully populated, indicates all the project roles "in-use" (required) by the backup projects data.
SimpleProjectImportIdMapper getResolutionMapper()
Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue resolutions "in-use" (required) by the backup projects data.
StatusMapper getStatusMapper()
Gets a StatusMapper which, when fully populated, indicates all the issue statuses "in-use" (required) by the backup projects data.
UserMapper getUserMapper()
Gets a UserMapper which, when fully populated, indicates all the users "in-use" (required) by the backup projects data's issues.
SimpleProjectImportIdMapper getVersionMapper()
Gets a ProjectImportIdMapper which, when fully populated, indicates all the project versions "in-use" (required) by the backup projects data.

Public Methods

public void clearMappedValues ()

This will clear any mapped data that may have been entered into the mappers. All registered values and values that have been flagged as required will not be changed. This method only affects the mapped data. It is used to re-map and re-validate the data after the user has made changes to the current configuration.

public SimpleProjectImportIdMapper getChangeGroupMapper ()

Gets a ProjectImportIdMapper that maps the change group id's from the old backup project data to the id's generated when adding the change group data to the new JIRA instance. NOTE: This is only populated once the change groups have been persisted into the new system.

Returns
  • a ProjectImportIdMapper that maps JIRA change group id's from old to new.

public SimpleProjectImportIdMapper getCommentMapper ()

Gets a ProjectImportIdMapper that maps the Comment id's from the old backup project data to the id's in the current system.

Returns
  • a ProjectImportIdMapper that maps JIRA comment id's from old to new.

public SimpleProjectImportIdMapper getComponentMapper ()

Gets a ProjectImportIdMapper which, when fully populated, indicates all the project components "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "Comp 1", "Comp 2", etc.) for all components and will indicate which are in-use by the backup data's issues.

Returns
  • ProjectImportIdMapper containing project components information.

public CustomFieldMapper getCustomFieldMapper ()

Gets a CustomFieldMapper which, when fully populated, indicates all the custom fields "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "My Text CF", "Extra Reporter CF", etc.) for custom fields that are valid for the backup project as defined by the custom fields configuration. The mapper will indicate which are in-use by the backup data's issues. The mapper will also indicate which issue types are in use for a given custom field.

Returns
  • CustomFieldMapper containing custom field information.

public CustomFieldOptionMapper getCustomFieldOptionMapper ()

Gets a CustomFieldOptionMapper which, when fully populated, indicates how to map the IDs of the Custom Field Options in the Import file, to the equivalent Option in the current JIRA.

Returns
  • CustomFieldOptionMapper containing custom field option mapping information.

public GroupMapper getGroupMapper ()

Gets a ProjectImportIdMapper which, when fully populated, indicates all the groups "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "jira-developers", "jira-administrators", etc.) for groups and will indicate which are in-use by the backup data's issues.

Returns
  • ProjectImportIdMapper containing user id's that are required.

public IssueLinkTypeMapper getIssueLinkTypeMapper ()

Gets a ProjectImportIdMapper that maps the IssueLinkType id's from the old backup project data to the id's in the current system.

Returns
  • a ProjectImportIdMapper that maps IssueLinkType id's from old to new.

public SimpleProjectImportIdMapper getIssueMapper ()

Gets a ProjectImportIdMapper that maps the issue id's from the old backup project data to the id's generated when adding the issue data to the new JIRA instance. NOTE: This is only populated once the issues have been persisted into the new system.

Returns
  • a ProjectImportIdMapper that maps JIRA issue id's from old to new.

public SimpleProjectImportIdMapper getIssueSecurityLevelMapper ()

Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue security levels "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "Level 1", "Level 2", etc.) for all issue security levels that are valid for the backup project as defined by the backup projects issue security scheme. The mapper will indicate which are in-use by the backup data's issues.

Returns
  • ProjectImportIdMapper containing issue security level information.

public IssueTypeMapper getIssueTypeMapper ()

Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue issue types "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "Bug", "Task", etc.) for all issue types and will indicate which are in-use by the backup data's issues.

Returns
  • ProjectImportIdMapper containing issue issue type information.

public SimpleProjectImportIdMapper getPriorityMapper ()

Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue priorities "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "Blocker", "Critical", etc.) for all priorities and will indicate which are in-use by the backup data's issues.

Returns
  • ProjectImportIdMapper containing issue priority information.

public SimpleProjectImportIdMapper getProjectMapper ()

Gets a ProjectImportIdMapper which, when fully populated, indicates all the projects from the backup file and the mapped projects in the current JIRA instance. The projects are mapped by project key.

Returns
  • ProjectImportIdMapper containing project id mappings.

public ProjectRoleActorMapper getProjectRoleActorMapper ()

Gets a ProjectRoleActorMapper which, when fully populated, indicates all the ProjectRoleActors "in-use" (optional) by the backup projects data's issues.

Returns
  • ProjectRoleActorMapper containing ExternalProjectRoleActors that are in use.

public SimpleProjectImportIdMapper getProjectRoleMapper ()

Gets a ProjectImportIdMapper which, when fully populated, indicates all the project roles "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "Developer", "Administrator", etc.) for all project roles and will indicate which are in-use by the backup data's comments and worklogs.

Returns
  • ProjectImportIdMapper containing project role information.

public SimpleProjectImportIdMapper getResolutionMapper ()

Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue resolutions "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "Fixed", "Won't Fix", etc.) for all resolutions and will indicate which are in-use by the backup data's issues.

Returns
  • ProjectImportIdMapper containing issue resolution information.

public StatusMapper getStatusMapper ()

Gets a StatusMapper which, when fully populated, indicates all the issue statuses "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "In Progress", "Open", etc.) for all statuses and will indicate which are in-use by the backup data's issues.

Returns
  • StatusMapper containing issue status information.

public UserMapper getUserMapper ()

Gets a UserMapper which, when fully populated, indicates all the users "in-use" (required) by the backup projects data's issues.

Returns
  • UserMapper containing user id's that are required.

public SimpleProjectImportIdMapper getVersionMapper ()

Gets a ProjectImportIdMapper which, when fully populated, indicates all the project versions "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "Version 3.1.2", "Version 3.2.1", etc.) for all affects and fix versions and will indicate which are in-use by the backup data's issues.

Returns
  • ProjectImportIdMapper containing issue fix and affects version information.