public interface

AutoExport

com.atlassian.jira.bean.export.AutoExport
Known Indirect Subclasses

Class Overview

Abstraction to perform the actual export of backup data from JIRA. Implementations typically have some backing configuration.

Summary

Constants
String BASE_FILE_NAME A default filename prefix that can be used by implementations.
String FIX_INVALID_XML_CHARACTERS
Public Methods
String exportData()
Performs the actual export of the data according to the implementation's configuration.
String getExportFilePath()
Returns the path to be used for backing up data.

Constants

public static final String BASE_FILE_NAME

A default filename prefix that can be used by implementations.

Constant Value: "jira_autoexport_"

public static final String FIX_INVALID_XML_CHARACTERS

Constant Value: "fixchars"

Public Methods

public String exportData ()

Performs the actual export of the data according to the implementation's configuration. Implementations may choose what filename is ultimately used.

Returns
  • the filename ultimately used for the export.
Throws
FileNotFoundException if the configured backup directory doesn't exist.
FileExistsException if the backup filename configured to be used is already taken.
IllegalXMLCharactersException if the backup data contains illegal characters for XML formatting.
Exception for no good reason.

public String getExportFilePath ()

Returns the path to be used for backing up data.

Returns
  • the path.
Throws
FileNotFoundException if configuration of the backup paths forces a path that doesn't exist.
FileExistsException if a file already exists at the path to which export should go.
IOException if there is a problem with the filesystem when determining the filepath.