public class

ReferenceOfBizPreImport

extends Object
implements PluggableImportOfBizEntityHandler
java.lang.Object
   ↳ com.atlassian.jira.dev.reference.plugin.imports.project.ReferenceOfBizPreImport

Class Overview

Reference plugin to observe AO data during the initial stages of a project import.

Summary

Public Constructors
ReferenceOfBizPreImport()
Public Methods
void endDocument()
Provides the implementation an opportunity to perform some action when the document is finished being read.
BackupProject getBackupProject()
BackupSystemInformation getBackupSystemInformation()
ProjectImportMapper getProjectImportMapper()
@Nullable ProjectImportResults getProjectImportResults()
void handleEntity(String entityName, Map<String, String> attributes)
This is the main method to implement when using this ImportEntityHandler.
boolean handlesEntity(String entityName)
Return true if this handler should process the entity.
boolean isDocEnded()
boolean isDocStarted()
void setBackupProject(BackupProject backupProject)
Set the backup project.
void setBackupSystemInformation(BackupSystemInformation backupSystemInformation)
Set the backup system information.
void setProjectImportMapper(ProjectImportMapper projectImportMapper)
Set the project import mapper.
void setProjectImportResults(ProjectImportResults projectImportResults)
Set the project import results.
void startDocument()
Provides the implementation an opportunity to perform some action when the document is starting to be read.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.imports.project.handler.ImportOfBizEntityHandler
From interface com.atlassian.jira.imports.project.handler.PluggableImportHandler
From interface com.atlassian.jira.imports.project.handler.PluggableImportOfBizEntityHandler

Public Constructors

public ReferenceOfBizPreImport ()

Public Methods

public void endDocument ()

Provides the implementation an opportunity to perform some action when the document is finished being read.

public BackupProject getBackupProject ()

public BackupSystemInformation getBackupSystemInformation ()

public ProjectImportMapper getProjectImportMapper ()

@Nullable public ProjectImportResults getProjectImportResults ()

public void handleEntity (String entityName, Map<String, String> attributes)

This is the main method to implement when using this ImportEntityHandler. This method will provide the entity name and a complete map of attribute key/value pairs. This includes any nested element tags that will have CDATA bodies.

Parameters
entityName identifies the entity (i.e. Issue)
attributes complete list of the attributes listed in the XML element including the nested elements.
Throws
ParseException
AbortImportException

public boolean handlesEntity (String entityName)

Return true if this handler should process the entity.

Parameters
entityName Entities to process.

public boolean isDocEnded ()

public boolean isDocStarted ()

public void setBackupProject (BackupProject backupProject)

Set the backup project. This will be injected after the handler is constructed, before any entities are processed.

Parameters
backupProject The backup project

public void setBackupSystemInformation (BackupSystemInformation backupSystemInformation)

Set the backup system information. This will be injected after the handler is constructed, before any entities are processed.

Parameters
backupSystemInformation The backup system information

public void setProjectImportMapper (ProjectImportMapper projectImportMapper)

Set the project import mapper. This will be injected after the handler is constructed, before any entities are processed.

Parameters
projectImportMapper The project import mapper

public void setProjectImportResults (ProjectImportResults projectImportResults)

Set the project import results. This will be injected after the handler is constructed, before any entities are processed. For pre-import handlers this will be null.

Parameters
projectImportResults The project import results

public void startDocument ()

Provides the implementation an opportunity to perform some action when the document is starting to be read.