ProjectImportPersister (Atlassian Jira

All Known Implementing Classes:

DefaultProjectImportPersister
```
public interface ProjectImportPersister
```
Stores entities related to project import.

Since:

v3.13

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`createAssociation(ExternalNodeAssociation nodeAssociation)` Creates a NodeAssocation which is used to link the issue to external values such as versions and components.
`Attachment`	`createAttachment(ExternalAttachment externalAttachment)` Creates an attachment specified by the ExternalAttachment.
`String`	`createChangeItemForIssueLinkIfNeeded(String issueId, String issueLinkTypeId, String linkedIssueKey, boolean isSource, ApplicationUser importAuthor)` This will look at the issue specified by issueId and add a changeItem for the issue link if it needs to.
`Map<String,ProjectComponent>`	`createComponents(BackupProject backupProject, ProjectImportMapper projectImportMapper)` Creates the components, specified by `BackupProject.getProjectComponents()` for the named backup project.
`Long`	`createEntity(EntityRepresentation entityRepresentation)` This will store the provided entity in the database.
`Issue`	`createIssue(ExternalIssue externalIssue, Date importDate, ApplicationUser importAuthor)` Creates an issue based off of the provided ExternalIssue.
`Project`	`createProject(ExternalProject project)` Creates a project, with details based off of the ExternalProject.
`boolean`	`createUser(UserMapper userMapper, ExternalUser externalUser)` Creates a User in JIRA from the given ExternalUser object.
`Map<String,Version>`	`createVersions(BackupProject backupProject)` Creates the versions, specified by `BackupProject.getProjectVersions()` for the named backup project.
`boolean`	`createVoter(ExternalVoter voter)` Creates a UserAssociation which is used to link the user to the issue as a voter.
`boolean`	`createWatcher(ExternalWatcher watcher)` Creates a UserAssociation which is used to link the user to the issue as a watcher.
`void`	`reIndexProject(ProjectImportMapper projectImportMapper, TaskProgressInterval taskProgressInterval, I18nHelper i18n)` Re-indexes all the new Issues that have just been created in this Project Import.
`Project`	`updateProjectDetails(ExternalProject project)` Updates the details of an existing Project in JIRA from the given ExternalProject object.
`void`	`updateProjectIssueCounter(BackupProject backupProject, long counter)` Updates a projects issue counter, which is used to determine the numeric portion of the issue key.

- Method Detail
  - createIssue
```
Issue createIssue(ExternalIssue externalIssue,
                  Date importDate,
                  ApplicationUser importAuthor)
```
    Creates an issue based off of the provided ExternalIssue. This method will store the issue and make sure that it is in the correct workflow state. This will preserve the key provided in the issue.
    NOTE: If you are using this method you will, at a later time, need to fix the projects pcounter to be correct in relation to the manually stored issue keys.
    
    Parameters:
    
    externalIssue - contains the issue details that will be persisted and the project id that the issue will be persisted against.
    
    importDate - a date that will be used as the value of the marker change item that is added to the issue to indicate that the issue was created via a project import.
    
    importAuthor - the user who is performing the project import, this is used as the author of the change item marker for created issues
    
    Returns:
    
    an Issue representation of the newly stored issue, null if there is a problem creating the issue.
  - createEntity
```
Long createEntity(EntityRepresentation entityRepresentation)
```
    This will store the provided entity in the database. No validation will be performed so it is up to the caller to make certain that the data has integrity. If a DataAccessException occurs during this operation, then we return a null id.
    
    Parameters:
    
    entityRepresentation - the data that will be persisted.
    
    Returns:
    
    the id of the newly created entity, or null if the Entity could not be created.
  - createChangeItemForIssueLinkIfNeeded
```
String createChangeItemForIssueLinkIfNeeded(String issueId,
                                            String issueLinkTypeId,
                                            String linkedIssueKey,
                                            boolean isSource,
                                            ApplicationUser importAuthor)
```
    This will look at the issue specified by issueId and add a changeItem for the issue link if it needs to. If a change item is added then the issues updated date will also be updated. If the issue already has a change item then one will not be added. If the issue has one but also has a change item that says the link was deleted this method will add a new one. If the issue has no change item for this link then one will be added.
    Please note: this method will add the change item but it does not re-index the issue, this should be handled elsewhere.
    
    Parameters:
    
    issueId - the id of the issue that should exist in JIRA. This is the issue that will have the change item added to it if it does not already have one.
    
    issueLinkTypeId - the id of the issue link type in JIRA, this must exist.
    
    linkedIssueKey - the issue key that is part of the created link.
    
    isSource - true if the issue specified by issueId is the source of the issue link, false if it is the destination.
    
    importAuthor - the user who is performing the project import, this is used as the author of the change item marker for created issues.
    
    Returns:
    
    the issue id that was changed if a change item was created, null otherwise.
  - reIndexProject
```
void reIndexProject(ProjectImportMapper projectImportMapper,
                    TaskProgressInterval taskProgressInterval,
                    I18nHelper i18n)
             throws IndexException
```
    Re-indexes all the new Issues that have just been created in this Project Import. The list of Issues to be indexed is taken from the ProjectImportIdMapper.getAllMappedIds().
    
    Parameters:
    
    projectImportMapper - ProjectImportMapper which is used to get the new Issue ID
    
    taskProgressInterval - Used to provide progress feedback, can be null.
    
    i18n - used to i18n the task progress messages.
    
    Throws:
    
    IndexException - If an error occurs in the IndexManager.
  - createProject
```
Project createProject(ExternalProject project)
               throws ExternalException
```
    Creates a project, with details based off of the ExternalProject. The project will be associated with the default schemes.
    
    Parameters:
    
    project - holds the details the project will be created with.
    
    Returns:
    
    a Project object representing the project we just created
    
    Throws:
    
    ExternalException - if there is an error creating the project.
  - createAssociation
```
boolean createAssociation(ExternalNodeAssociation nodeAssociation)
```
    Creates a NodeAssocation which is used to link the issue to external values such as versions and components.
    
    Parameters:
    
    nodeAssociation - the externalObject that contains the correct values to be persisted to the datastore.
    
    Returns:
    
    true if the association was created false otherwise
  - createWatcher
```
boolean createWatcher(ExternalWatcher watcher)
```
    Creates a UserAssociation which is used to link the user to the issue as a watcher.
    
    Parameters:
    
    watcher - contains the issue and user information
    
    Returns:
    
    true if created, false otherwise.
  - createVoter
```
boolean createVoter(ExternalVoter voter)
```
    Creates a UserAssociation which is used to link the user to the issue as a voter.
    
    Parameters:
    
    voter - contains the issue and user information
    
    Returns:
    
    true if created, false otherwise.
  - createVersions
```
Map<String,Version> createVersions(BackupProject backupProject)
```
    Creates the versions, specified by BackupProject.getProjectVersions() for the named backup project.
    
    Parameters:
    
    backupProject - specifies the name of the project to create the versions for and the versions to create
    
    Returns:
    
    a map of Version's that represent the newly created versions keyed by the old version id they were created from.
  - createComponents
```
Map<String,ProjectComponent> createComponents(BackupProject backupProject,
                                              ProjectImportMapper projectImportMapper)
```
    Creates the components, specified by BackupProject.getProjectComponents() for the named backup project.
    
    Parameters:
    
    backupProject - specifies the name of the project to create the components for and the components to create
    
    projectImportMapper - ProjectImportMapper used to map the component leads user key
    
    Returns:
    
    a map of ProjectComponent's that represent the newly created components keyed by the old component id they were created from.
  - updateProjectIssueCounter
```
void updateProjectIssueCounter(BackupProject backupProject,
                               long counter)
```
    Updates a projects issue counter, which is used to determine the numeric portion of the issue key.
    
    Parameters:
    
    backupProject - contains the ExternalProject that holds the details
    
    counter - this is a long that the value will be set to in the stored project.
  - createAttachment
```
Attachment createAttachment(ExternalAttachment externalAttachment)
```
    Creates an attachment specified by the ExternalAttachment. This will create a database entry for the attachment and will copy the file from its current path, specified by ExternalAttachment.getAttachedFile() to the JIRA attachment directory.
    
    Parameters:
    
    externalAttachment - specifies the issue id and attachment details for the attachment to create.
    
    Returns:
    
    the created Attachment, null if the attachment was not created.
    
    Throws:
    
    IllegalArgumentException - if the provided externalAttachment does not contain the needed and valid details to create the attachment. This is the issue id, the file name, and the actual File.
  - createUser
```
boolean createUser(UserMapper userMapper,
                   ExternalUser externalUser)
```
    Creates a User in JIRA from the given ExternalUser object. This includes the custom properties as well as the standard ones.
    
    Parameters:
    
    userMapper - contains mapping between old and new user keys
    
    externalUser - ExternalUser containing the data to use to create the new User.
    
    Returns:
    
    True If the user was created else false.
  - updateProjectDetails
```
Project updateProjectDetails(ExternalProject project)
```
    Updates the details of an existing Project in JIRA from the given ExternalProject object. This includes the following:
    - name
    - description
    - URL
    - lead
    - assignee type
    - email sender
    Parameters:
    
    project - ExternalProject containing the data to use to update.
    
    Returns:
    
    a Project object representing the project we just updated

Interface ProjectImportPersister

Method Summary

Method Detail

createIssue

createEntity

createChangeItemForIssueLinkIfNeeded

reIndexProject

createProject

createAssociation

createWatcher

createVoter

createVersions

createComponents

updateProjectIssueCounter

createAttachment

createUser

updateProjectDetails