com.atlassian.jira.dev.reference.plugin.imports.project

Class ReferenceOfBizPreImport

java.lang.Object

com.atlassian.jira.dev.reference.plugin.imports.project.ReferenceOfBizPreImport

All Implemented Interfaces:

ImportOfBizEntityHandler, PluggableImportHandler, PluggableImportOfBizEntityHandler

public class ReferenceOfBizPreImport
extends Object
implements PluggableImportOfBizEntityHandler

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

Since:

v7.0

Constructor Summary

Constructors

Constructor and Description
ReferenceOfBizPreImport()

Method Summary

Modifier and Type	Method and Description
void	endDocument() Provides the implementation an opportunity to perform some action when the document is finished being read.
BackupProject	getBackupProject()
BackupSystemInformation	getBackupSystemInformation()
ProjectImportMapper	getProjectImportMapper()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReferenceOfBizPreImport

public ReferenceOfBizPreImport()

Method Detail

handleEntity

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

Description copied from interface: ImportOfBizEntityHandler

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.

Specified by:

handleEntity in interface ImportOfBizEntityHandler

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 - if the entity is invalid a ParseException will be thrown.

AbortImportException - to indicate to project import that it should abort its SAX parsing.

handlesEntity

public boolean handlesEntity(String entityName)

Description copied from interface: PluggableImportOfBizEntityHandler

Return true if this handler should process the entity.

Specified by:

handlesEntity in interface PluggableImportOfBizEntityHandler

Parameters:

entityName - Entities to process.

startDocument

public void startDocument()

Description copied from interface: PluggableImportOfBizEntityHandler

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

Specified by:

startDocument in interface ImportOfBizEntityHandler

Specified by:

startDocument in interface PluggableImportOfBizEntityHandler

endDocument

public void endDocument()

Description copied from interface: PluggableImportOfBizEntityHandler

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

Specified by:

endDocument in interface ImportOfBizEntityHandler

Specified by:

endDocument in interface PluggableImportOfBizEntityHandler

setBackupProject

public void setBackupProject(BackupProject backupProject)

Description copied from interface: PluggableImportHandler

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

Specified by:

setBackupProject in interface PluggableImportHandler

Parameters:

backupProject - The backup project

setBackupSystemInformation

public void setBackupSystemInformation(BackupSystemInformation backupSystemInformation)

Description copied from interface: PluggableImportHandler

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

Specified by:

setBackupSystemInformation in interface PluggableImportHandler

Parameters:

backupSystemInformation - The backup system information

setProjectImportMapper

public void setProjectImportMapper(ProjectImportMapper projectImportMapper)

Description copied from interface: PluggableImportHandler

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

Specified by:

setProjectImportMapper in interface PluggableImportHandler

Parameters:

projectImportMapper - The project import mapper

setProjectImportResults

public void setProjectImportResults(@Nullable
                                    ProjectImportResults projectImportResults)

Description copied from interface: PluggableImportHandler

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.

Specified by:

setProjectImportResults in interface PluggableImportHandler

Parameters:

projectImportResults - The project import results

isDocStarted

public boolean isDocStarted()

isDocEnded

public boolean isDocEnded()

getBackupProject

public BackupProject getBackupProject()

getBackupSystemInformation

public BackupSystemInformation getBackupSystemInformation()

getProjectImportMapper

public ProjectImportMapper getProjectImportMapper()

getProjectImportResults

@Nullable
public ProjectImportResults getProjectImportResults()