com.atlassian.confluence.importexport

Class DefaultImportExportManager

java.lang.Object

com.atlassian.confluence.importexport.DefaultImportExportManager

All Implemented Interfaces:

ImportExportManager

public class DefaultImportExportManager
extends Object
implements ImportExportManager

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXPORT_ALL_FILE_PREFIX
static ArrayList<String>	importExportTypes Deprecated. since 5.10 Use getImportExportTypeSpecifications()

Fields inherited from interface com.atlassian.confluence.importexport.ImportExportManager

TYPE_ALL_DATA, TYPE_HTML, TYPE_MOINMOIN, TYPE_PDF, TYPE_XML

Constructor Summary

Constructors

Constructor and Description
DefaultImportExportManager(ContentPermissionManager contentPermissionManager, BootstrapManager bootstrapManager, PageManager pageManager, com.atlassian.event.api.EventPublisher eventPublisher, UpgradeManager upgradeManager, com.atlassian.plugin.PluginController pluginController, com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Summary

Modifier and Type	Method and Description
protected String	doExport(ExportContext context, com.atlassian.core.util.ProgressMeter progress)
void	doImport(ImportContext context) Performs an import specified by the given context.
protected ImmutableImportProcessorSummary	doPerformImport(ImportContext context)
String	exportAs(ExportContext context, com.atlassian.core.util.ProgressMeter progress)
ContentPermissionManager	getContentPermissionManager()
ContentTree	getContentTree(com.atlassian.user.User user, Space space) Returns a tree of content including pages for a space.
List	getImportExportTypeSpecifications()
BuildNumber	getOldestSpaceImportAllowed() The oldest build number a space can be imported from.
ContentTree	getPageBlogTree(com.atlassian.user.User user, Space space) Returns a tree of content including pages and blog posts for a space.
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.
protected Cleanup	temporarilyShutdownInterferingPlugins(ImportContext context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXPORT_ALL_FILE_PREFIX

public static final String EXPORT_ALL_FILE_PREFIX

See Also:

Constant Field Values

importExportTypes

@Deprecated
public static final ArrayList<String> importExportTypes

Deprecated. since 5.10 Use getImportExportTypeSpecifications()

Constructor Detail

DefaultImportExportManager

public DefaultImportExportManager(ContentPermissionManager contentPermissionManager,
                                  BootstrapManager bootstrapManager,
                                  PageManager pageManager,
                                  com.atlassian.event.api.EventPublisher eventPublisher,
                                  UpgradeManager upgradeManager,
                                  com.atlassian.plugin.PluginController pluginController,
                                  com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Detail

doImport

public void doImport(ImportContext context)
              throws ImportExportException

Description copied from interface: ImportExportManager

Performs an import specified by the given context.

Specified by:

doImport in interface ImportExportManager

Parameters:

context - a filled out context

Throws:

ImportExportException

performImport

public ImmutableImportProcessorSummary performImport(ImportContext context)
                                              throws ImportExportException

Description copied from interface: ImportExportManager

Performs an import specified by the given context and returns the summary of import result.

Specified by:

performImport in interface ImportExportManager

Parameters:

context - a filled out context

Returns:

the summary of all remapped ids

Throws:

ImportExportException - if somethings goes wrong in the import

doPerformImport

protected ImmutableImportProcessorSummary doPerformImport(ImportContext context)
                                                   throws ImportExportException

Throws:

ImportExportException

temporarilyShutdownInterferingPlugins

protected final Cleanup temporarilyShutdownInterferingPlugins(ImportContext context)

exportAs

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

Specified by:

exportAs in interface ImportExportManager

Throws:

ImportExportException

doExport

protected String doExport(ExportContext context,
                          com.atlassian.core.util.ProgressMeter progress)
                   throws ImportExportException

Throws:

ImportExportException

getImportExportTypeSpecifications

public List getImportExportTypeSpecifications()

Specified by:

getImportExportTypeSpecifications in interface ImportExportManager

getContentTree

public ContentTree getContentTree(com.atlassian.user.User user,
                                  Space space)

Description copied from interface: ImportExportManager

Returns a tree of content including pages for a space.

Specified by:

getContentTree in interface ImportExportManager

Parameters:

user - to generate tree of content for, taking into account their permission

space - to generate tree of content from

Returns:

a tree of ContentNodes for each page in the space the user can see

getPageBlogTree

public ContentTree getPageBlogTree(com.atlassian.user.User user,
                                   Space space)

Description copied from interface: ImportExportManager

Returns a tree of content including pages and blog posts for a space.

Specified by:

getPageBlogTree in interface ImportExportManager

Parameters:

user - to generate tree of content for, taking into account their permission

space - to generate tree of content from

Returns:

a tree of ContentNodes for each page and blog post in the space the user can see

prepareDownloadPath

public String prepareDownloadPath(String path)
                           throws IOException

Description copied from interface: ImportExportManager

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

Specified by:

prepareDownloadPath in interface ImportExportManager

Returns:

- relative path to be combined with the URL of the site to download the archive.

Throws:

IOException

isImportAllowed

public boolean isImportAllowed(String buildNumber)

Description copied from interface: ImportExportManager

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.

Specified by:

isImportAllowed in interface ImportExportManager

Parameters:

buildNumber - the build number of the backup to be imported

Returns:

true if that build number is supported, false otherwise.

getOldestSpaceImportAllowed

public BuildNumber getOldestSpaceImportAllowed()

Description copied from interface: ImportExportManager

The oldest build number a space can be imported from. Space backups from early versions of Confluence are no longer supported for importing.

Specified by:

getOldestSpaceImportAllowed in interface ImportExportManager

Returns:

the oldest build number allowed.

getContentPermissionManager

public ContentPermissionManager getContentPermissionManager()