com.atlassian.confluence.importexport
Interface ImportExportManager

All Known Implementing Classes:
DefaultImportExportManager

public interface ImportExportManager


Field Summary
static String EXPORT_XML_SCOPE_ALL
          Deprecated. since 4.2 use ExportScope.ALL.
static String EXPORT_XML_SCOPE_PAGE
          Deprecated. since 4.2 use ExportScope.PAGE.
static String EXPORT_XML_SCOPE_SPACE
          Deprecated. since 4.2 use ExportScope.SPACE.
static String TYPE_ALL_DATA
           
static String TYPE_HTML
           
static String TYPE_MOINMOIN
           
static String TYPE_PDF
           
static String TYPE_XML
           
 
Method Summary
 void doImport(ImportContext context)
          Performs an import specified by the given context.
 String exportAs(ExportContext context, com.atlassian.core.util.ProgressMeter progress)
           
 ContentTree getContentTree(com.atlassian.user.User user, Space space)
           
 List getImportExportTypeSpecifications()
           
 void importAs(Object type, ImportContext context)
          Deprecated. since 4.2 use doImport(ImportContext).
 boolean isImportAllowed(String buildNumber)
          Is the manager capable of importing a backup of the given build number.
 ImmutableImportProcessorSummary performImport(ImportContext context)
          Performs an import specified by the given context and returns the summary of import result.
 String prepareDownloadPath(String path)
          Helper method - returns the location to be used in the URL generated to download an exported archive.
 

Field Detail

TYPE_ALL_DATA

static final String TYPE_ALL_DATA
See Also:
Constant Field Values

TYPE_XML

static final String TYPE_XML
See Also:
Constant Field Values

TYPE_HTML

static final String TYPE_HTML
See Also:
Constant Field Values

TYPE_PDF

static final String TYPE_PDF
See Also:
Constant Field Values

TYPE_MOINMOIN

static final String TYPE_MOINMOIN
See Also:
Constant Field Values

EXPORT_XML_SCOPE_PAGE

@Deprecated
static final String EXPORT_XML_SCOPE_PAGE
Deprecated. since 4.2 use ExportScope.PAGE.
See Also:
Constant Field Values

EXPORT_XML_SCOPE_SPACE

@Deprecated
static final String EXPORT_XML_SCOPE_SPACE
Deprecated. since 4.2 use ExportScope.SPACE.
See Also:
Constant Field Values

EXPORT_XML_SCOPE_ALL

@Deprecated
static final String EXPORT_XML_SCOPE_ALL
Deprecated. since 4.2 use ExportScope.ALL.
See Also:
Constant Field Values
Method Detail

importAs

void importAs(Object type,
              ImportContext context)
              throws ImportExportException
Deprecated. since 4.2 use doImport(ImportContext).

Throws:
ImportExportException

doImport

void doImport(ImportContext context)
              throws ImportExportException
Performs an import specified by the given context.

Parameters:
context - a filled out context
Throws:
ImportExportException

performImport

ImmutableImportProcessorSummary performImport(ImportContext context)
                                              throws ImportExportException
Performs an import specified by the given context and returns the summary of import result.

Parameters:
context - a filled out context
Returns:
the summary of all remapped ids
Throws:
ImportExportException - if somethings goes wrong in the import

exportAs

String exportAs(ExportContext context,
                com.atlassian.core.util.ProgressMeter progress)
                throws ImportExportException
Throws:
ImportExportException

getImportExportTypeSpecifications

List getImportExportTypeSpecifications()

getContentTree

ContentTree getContentTree(com.atlassian.user.User user,
                           Space space)
Parameters:
user -
space -
Returns:
a tree of ContentNodes for each page in the space the user can see (by checking page level permissions)

prepareDownloadPath

String prepareDownloadPath(String path)
                           throws IOException
Helper method - returns the location to be used in the URL generated to download an exported archive.

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

isImportAllowed

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.


Copyright © 2003-2013 Atlassian. All Rights Reserved.