public interface ProjectImportPersister
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.
|
Issue createIssue(ExternalIssue externalIssue, Date importDate, ApplicationUser importAuthor)
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.
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 issuesLong createEntity(EntityRepresentation entityRepresentation)
null
id.entityRepresentation
- the data that will be persisted.null
if the Entity could not be created.String createChangeItemForIssueLinkIfNeeded(String issueId, String issueLinkTypeId, String linkedIssueKey, boolean isSource, ApplicationUser importAuthor)
Please note: this method will add the change item but it does not re-index the issue, this should be handled elsewhere.
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.void reIndexProject(ProjectImportMapper projectImportMapper, TaskProgressInterval taskProgressInterval, I18nHelper i18n) throws IndexException
ProjectImportIdMapper.getAllMappedIds()
.projectImportMapper
- ProjectImportMapper which is used to get the new Issue IDtaskProgressInterval
- Used to provide progress feedback, can be null.i18n
- used to i18n the task progress messages.IndexException
- If an error occurs in the IndexManager.Project createProject(ExternalProject project) throws ExternalException
project
- holds the details the project will be created with.ExternalException
- if there is an error creating the project.boolean createAssociation(ExternalNodeAssociation nodeAssociation)
nodeAssociation
- the externalObject that contains the correct values to be persisted to the datastore.boolean createWatcher(ExternalWatcher watcher)
watcher
- contains the issue and user informationboolean createVoter(ExternalVoter voter)
voter
- contains the issue and user informationMap<String,Version> createVersions(BackupProject backupProject)
BackupProject.getProjectVersions()
for the named backup project.backupProject
- specifies the name of the project to create the versions for and the versions to createVersion
's that represent the newly created
versions keyed by the old version id they were created from.Map<String,ProjectComponent> createComponents(BackupProject backupProject, ProjectImportMapper projectImportMapper)
BackupProject.getProjectComponents()
for the named backup project.backupProject
- specifies the name of the project to create the components for and the components to createprojectImportMapper
- ProjectImportMapper used to map the component leads user keyProjectComponent
's that represent the newly created
components keyed by the old component id they were created from.void updateProjectIssueCounter(BackupProject backupProject, long counter)
backupProject
- contains the ExternalProject
that holds the detailscounter
- this is a long that the value will be set to in the stored project.Attachment createAttachment(ExternalAttachment externalAttachment)
ExternalAttachment.getAttachedFile()
to the JIRA attachment directory.externalAttachment
- specifies the issue id and attachment details for the attachment to create.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.boolean createUser(UserMapper userMapper, ExternalUser externalUser)
userMapper
- contains mapping between old and new user keysexternalUser
- ExternalUser containing the data to use to create the new User.Project updateProjectDetails(ExternalProject project)
project
- ExternalProject containing the data to use to update.Copyright © 2002-2022 Atlassian. All Rights Reserved.