public interface

ImportExportManager

com.atlassian.confluence.importexport.ImportExportManager
Known Indirect Subclasses

Summary

Constants
String EXPORT_XML_SCOPE_ALL This constant is deprecated. since 4.2 use ALL.
String EXPORT_XML_SCOPE_PAGE This constant is deprecated. since 4.2 use PAGE.
String EXPORT_XML_SCOPE_SPACE This constant is deprecated. since 4.2 use SPACE.
String TYPE_ALL_DATA
String TYPE_HTML
String TYPE_MOINMOIN
String TYPE_PDF
String TYPE_XML
Public Methods
void doImport(ImportContext context)
Performs an import specified by the given context.
String exportAs(ExportContext context, ProgressMeter progress)
ContentTree getContentTree(User user, Space space)
List getImportExportTypeSpecifications()
void importAs(Object type, ImportContext context)
This method is deprecated. since 4.2 use doImport(ImportContext).
boolean isImportAllowed(String buildNumber)
Is the manager capable of importing a backup of the given build number.
String prepareDownloadPath(String path)
Helper method - returns the location to be used in the URL generated to download an exported archive.

Constants

public static final String EXPORT_XML_SCOPE_ALL

This constant is deprecated.
since 4.2 use ALL.

Constant Value: "all"

public static final String EXPORT_XML_SCOPE_PAGE

This constant is deprecated.
since 4.2 use PAGE.

Constant Value: "page"

public static final String EXPORT_XML_SCOPE_SPACE

This constant is deprecated.
since 4.2 use SPACE.

Constant Value: "space"

public static final String TYPE_ALL_DATA

Constant Value: "TYPE_ALL_DATA"

public static final String TYPE_HTML

Constant Value: "TYPE_HTML"

public static final String TYPE_MOINMOIN

Constant Value: "TYPE_MOINMOIN"

public static final String TYPE_PDF

Constant Value: "TYPE_PDF"

public static final String TYPE_XML

Constant Value: "TYPE_XML"

Public Methods

public void doImport (ImportContext context)

Performs an import specified by the given context.

Parameters
context a filled out context
Throws
ImportExportException

public String exportAs (ExportContext context, ProgressMeter progress)

Throws
ImportExportException

public ContentTree getContentTree (User user, Space space)

Returns
  • a tree of ContentNodes for each page in the space the user can see (by checking page level permissions)

public List getImportExportTypeSpecifications ()

public void importAs (Object type, ImportContext context)

This method is deprecated.
since 4.2 use doImport(ImportContext).

Throws
ImportExportException

public boolean isImportAllowed (String buildNumber)

Is the manager capable of importing a backup of the given build number. Backups from early versions of Confluence are no longer supported for importing.

Parameters
buildNumber the build number of the backup to be imported
Returns
  • true if that build number is supported, false otherwise.

public String prepareDownloadPath (String path)

Helper method - returns the location to be used in the URL generated to download an exported archive.

Returns
  • - relative path to be combined with the URL of the site to download the archive.
Throws
IOException