com.atlassian.jira.imports.project.handler

Class AttachmentFileValidatorHandler

java.lang.Object

com.atlassian.jira.imports.project.handler.AttachmentFileValidatorHandler

All Implemented Interfaces:

ImportOfBizEntityHandler

public class AttachmentFileValidatorHandler
extends Object
implements ImportOfBizEntityHandler

This handler inspects attachment entries and if the user is importing attachments will check to see that the attachment file exists for the corresponding database entry.

Any attachments that are not found will cause a warning to be generated and placed into the MessageSet.

Since:

v3.13

Constructor Summary

Constructors

Constructor and Description
AttachmentFileValidatorHandler(BackupProject backupProject, ProjectImportOptions projectImportOptions, BackupSystemInformation backupSystemInformation, I18nHelper i18nHelper, AttachmentStore attachmentStore)

Method Summary

Modifier and Type	Method and Description
static boolean	canProcessEntity(String entityName, ProjectImportOptions projectImportOptions)
protected AttachmentParser	createAttachmentParser()
void	endDocument() Provides the implementation an opportunity to perform some action when the document is finished being read.
boolean	equals(Object o)
MessageSet	getValidationResults()
int	getValidAttachmentCount()
void	handleEntity(String entityName, Map<String,String> attributes) This is the main method to implement when using this ImportEntityHandler.
int	hashCode()
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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttachmentFileValidatorHandler

public AttachmentFileValidatorHandler(BackupProject backupProject,
                                      ProjectImportOptions projectImportOptions,
                                      BackupSystemInformation backupSystemInformation,
                                      I18nHelper i18nHelper,
                                      AttachmentStore attachmentStore)

Method Detail

createAttachmentParser

protected AttachmentParser createAttachmentParser()

handleEntity

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

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.

canProcessEntity

public static boolean canProcessEntity(String entityName,
                                       ProjectImportOptions projectImportOptions)

getValidationResults

public MessageSet getValidationResults()

getValidAttachmentCount

public int getValidAttachmentCount()

startDocument

public void startDocument()

Description copied from interface: ImportOfBizEntityHandler

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

Specified by:

startDocument in interface ImportOfBizEntityHandler

endDocument

public void endDocument()

Description copied from interface: ImportOfBizEntityHandler

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

Specified by:

endDocument in interface ImportOfBizEntityHandler

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object