java.lang.Object | |
↳ | com.atlassian.jira.bc.imports.project.DefaultProjectImportService |
Default implementation of the project import service.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Imports the passed in project using the provided, populated and validated, project import mapper.
| |||||||||||
Will use the initial data in the ProjectImportData to perform automappings based on the current state of JIRA
and then will validate those mappings.
| |||||||||||
Returns a BackupOverview object containing the overview of information from the backup file if the backup files
build number and edition match those of the running instance of JIRA.
| |||||||||||
Makes a pass through the provided JIRA ZIP backup data and creates a ProjectImportMapper and partitions the XML
data for the project.
| |||||||||||
Makes a pass through the provided AO XML backup data and partitions the XML allowing plugins to process listen to
each element as it passes,
| |||||||||||
Returns a MessageSet which reports if the provided BackupProject meets the JIRA system requirements
to be imported.
| |||||||||||
Validates if the user has permission to create a project import mapper and partition the input data and if the
provided path's and backup project exist.
| |||||||||||
Validates if the user has permission to start a project import and if the provided path's exist.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
com.atlassian.jira.bc.imports.project.ProjectImportService
|
Imports the passed in project using the provided, populated and validated, project import mapper.
This method will create/update the project, versions, components, role membership, as needed and will then import the issues and all their related values. This will also cause the project that is being imported to be reIndexed.
NOTE: this method does NO validation of the project import mapper. This method must only be called with a project
import mapper that has been returned from
doMapping(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.imports.project.core.ProjectImportOptions, com.atlassian.jira.imports.project.core.ProjectImportData, com.atlassian.jira.imports.project.core.BackupProject, com.atlassian.jira.imports.project.core.BackupSystemInformation, com.atlassian.jira.imports.project.taskprogress.TaskProgressInterval)
without any errors being generated.
jiraServiceContext | containing the user who the permission checks will be run against (can be null, indicating an anonymous user) and the errorCollection that will contain any errors in calling the method |
---|---|
projectImportOptions | User options for the project import, including the pathToBackupZIP, attachmentPath, and "overwriteProjectDetails" flag. |
backupProject | the backup project we want to create a ProjectImportMapper for and partition the JIRA XML data. |
backupSystemInformation | system-wide info form the backup file. |
projectImportData | contains the projectImportMapper, that has been through the automatic mapping and validation process, and the path, on disk, to the partitioned xml files. |
taskProgressInterval | Used to provide progress feedback, can be null. |
Will use the initial data in the ProjectImportData to perform automappings based on the current state of JIRA and then will validate those mappings. Any warnings or errors that may have been generated will be communicated through the mapping result.
NOTE: The import should not be allowed to proceed if canImport()
is false.
jiraServiceContext | containing the user who the permission checks will be run against (can be null, indicating an anonymous user) and the errorCollection that will contain any errors in calling the method |
---|---|
projectImportOptions | User options for the project import, including the pathToBackupZIP, attachmentPath, and "overwriteProjectDetails" flag. |
projectImportData | which holds the initial projectImportMapper and the partitioned XML file paths for the project XML data that was partitioned from the main XML backup. |
backupProject | the backup project we want to create a ProjectImportMapper for and partition the JIRA XML data. |
backupSystemInformation | system-wide info form the backup file. |
taskProgressInterval | Used to provide progress feedback, can be null. |
Returns a BackupOverview object containing the overview of information from the backup file if the backup files build number and edition match those of the running instance of JIRA.
If the optional parameter taskProgressSink is provided, then it is used to send information about the progress of this operation. This is used for the "Long Running Task" progress bar.
jiraServiceContext | containing the user who the permission checks will be run against (can be null, indicating an anonymous user) and the errorCollection that will contain any errors in calling the method |
---|---|
projectImportOptions | user inputed options that contains the pathToBackupZIP, the fully qualified path, on the server, to the JIRA ZIP backup file that will be used to provide the data for a project import, this must not be null and must resolve to a valid JIRA ZIP backup file. This also contains the pathToAttachmentBackup which is the fully qualified path, on the server, to the backed-up JIRA attachments directory that will be used to import project data. This is an optional parameter, if a backup attachment path is not provided this should be null. If non-null then this must resolve to a valid directory that |
taskProgressSink | Used to provide progress feedback, can be null. |
Makes a pass through the provided JIRA ZIP backup data and creates a ProjectImportMapper and partitions the XML data for the project.
jiraServiceContext | containing the user who the permission checks will be run against (can be null, indicating an anonymous user) and the errorCollection that will contain any errors in calling the method |
---|---|
projectImportOptions | User options for the project import, including the pathToBackupZIP, attachmentPath, and "overwriteProjectDetails" flag. |
backupProject | the backup project we want to create a ProjectImportMapper for and partition the JIRA XML data. |
backupSystemInformation | system-wide info form the backup file. |
taskProgressInterval | Used to provide progress feedback, can be null. |
Makes a pass through the provided AO XML backup data and partitions the XML allowing plugins to process listen to each element as it passes,
jiraServiceContext | containing the user who the permission checks will be run against (can be null, indicating an anonymous user) and the errorCollection that will contain any errors in calling the method |
---|---|
projectImportOptions | User options for the project import, including the pathToBackupZIP, attachmentPath, and "overwriteProjectDetails" flag. |
backupProject | the backup project we want to create a ProjectImportMapper for and partition the JIRA XML data. |
backupSystemInformation | system-wide info form the backup file. |
taskProgressInterval | Used to provide progress feedback, can be null. |
Returns a MessageSet which reports if the provided BackupProject meets the JIRA system requirements to be imported.
This method will return errors if:
jiraServiceContext | containing the user who the permission checks will be run against (can be null, indicating an anonymous user). The error collection will contain the same information as the error messages in the returned MessageSet. |
---|---|
backupProject | the BackupProject we want validate |
backupSystemInformation | system-wide info form the backup file. |
Validates if the user has permission to create a project import mapper and partition the input data and if the provided path's and backup project exist.
jiraServiceContext | containing the user who the permission checks will be run against (can be null, indicating an anonymous user) and the errorCollection that will contain any errors in calling the method |
---|---|
projectImportOptions | User options for the project import, including the pathToBackupZIP, attachmentPath, and "overwriteProjectDetails" flag. |
backupProject | the backup project we want to create a ProjectImportMapper for and partition the |
backupSystemInformation | system-wide info form the backup file. |
Validates if the user has permission to start a project import and if the provided path's exist.
jiraServiceContext | containing the user who the permission checks will be run against (can be null, indicating an anonymous user) and the errorCollection that will contain any errors in calling the method |
---|---|
projectImportOptions | user inputted options that contains the pathToBackupZIP, the fully qualified path, on the server, to the JIRA ZIP backup file that will be used to provide the data for a project import, this must not be null and must resolve to a valid JIRA ZIP backup file. This also contains the pathToAttachmentBackup which is the fully qualified path, on the server, to the backed-up JIRA attachments directory that will be used to import project data. This is an optional parameter, if a backup attachment path is not provided this should be null. If non-null then this must resolve to a valid directory that |