com.atlassian.jira.bean.export
Interface AutoExport

All Known Implementing Classes:

AutoExportImpl

public interface AutoExport

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

Field Summary

static String	BASE_FILE_NAME A default filename prefix that can be used by implementations.
static String	FIX_INVALID_XML_CHARACTERS

Method Summary

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.

Field Detail

FIX_INVALID_XML_CHARACTERS

static final String FIX_INVALID_XML_CHARACTERS

See Also:

Constant Field Values

BASE_FILE_NAME

static final String BASE_FILE_NAME

A default filename prefix that can be used by implementations.

See Also:

Constant Field Values

Method Detail

exportData

String exportData()
                  throws FileNotFoundException,
                         FileExistsException,
                         IllegalXMLCharactersException,
                         Exception

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.

getExportFilePath

String getExportFilePath()
                         throws FileNotFoundException,
                                FileExistsException,
                                IOException

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.