Package com.atlassian.confluence.impl.importexport

Class AbstractFileXmlExporter

java.lang.Object

com.atlassian.confluence.importexport.Exporter

com.atlassian.confluence.impl.importexport.AbstractExporterImpl

com.atlassian.confluence.impl.importexport.AbstractXmlExporter

com.atlassian.confluence.impl.importexport.AbstractFileXmlExporter

Direct Known Subclasses:

SiteBackupExporter, SpaceBackupExporter

public abstract class AbstractFileXmlExporter
extends AbstractXmlExporter

Performs the file IO side of the export/backup

For example: - copying attachments to temp directory - copying config files

Then performs the zipping and packaging into a zip file

Since:

7.14

Field Summary

Fields

Modifier and Type	Field	Description
protected AttachmentManager	attachmentManager

Fields inherited from class com.atlassian.confluence.impl.importexport.AbstractXmlExporter

ATTACHMENTS_DIRECTORY, bootstrapManager, ENTITIES_FILE_NAME, EXPORT_DESCRIPTOR_FILE_NAME, sessionFactory5, spaceManager, TEMPLATES_DIRECTORY

Fields inherited from class com.atlassian.confluence.impl.importexport.AbstractExporterImpl

i18nBeanFactory

Fields inherited from class com.atlassian.confluence.importexport.Exporter

context

Constructor Summary

Constructors

Constructor	Description
AbstractFileXmlExporter()

Method Summary

Modifier and Type	Method	Description
protected void	backupAttachments()	Backs up the Attachments and stores them in the "attachments" directory of the export.
protected void	backupConfigFiles()
protected void	backupEverything(HibernateObjectHandleTranslator translator, com.atlassian.core.util.ProgressMeter progress)	copies attachments, templates and config files
protected void	backupPluginData()
protected void	backupResources()
protected void	backupTemplates()
String	doExport(com.atlassian.core.util.ProgressMeter progress)	Exports the content specified by the configured ExportContext.
protected String	doExportInternal(com.atlassian.core.util.ProgressMeter progress)
protected abstract List<Space>	getIncludedSpaces()	Returns the List of Spaces that should be included in the export
void	setAttachmentManager(AttachmentManager attachmentManager)
void	setBackupRestoreProviderManager(BackupRestoreProviderManager backupRestoreProviderManager)
void	setConfluenceHome(com.atlassian.dc.filestore.api.compat.FilesystemPath confluenceHome)

Methods inherited from class com.atlassian.confluence.impl.importexport.AbstractXmlExporter

backupEntities, doExport, getDescriptorOutputStream, getExportScope, getHandlesOfObjectsForExport, getObjectsExcludedFromExport, getSettingsManager, getSourceTemplateDirForCopying, getXmlOutputStream, setBootstrapManager, setCustomProperties, setSessionFactory5, setSettingsManager, setSpaceManager, setUpgradeManager, writeBackupDescriptor

Methods inherited from class com.atlassian.confluence.impl.importexport.AbstractExporterImpl

checkHaveSomethingToExport, createAndSetExportDirectory, createExportDirectory, ensureDirectoryCreated, getSpaceKeyForExportFileName, getWorkingExportContext, prepareExportFileName, setExportFileNameGenerator, setI18NBeanFactory

Methods inherited from class com.atlassian.confluence.importexport.Exporter

getContext, setContext

Methods inherited from class java.lang.Object

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

Field Detail

attachmentManager

protected AttachmentManager attachmentManager

Constructor Detail

AbstractFileXmlExporter

public AbstractFileXmlExporter()

Method Detail

doExport

public String doExport(com.atlassian.core.util.ProgressMeter progress)
                throws ImportExportException

Description copied from class: Exporter

Exports the content specified by the configured ExportContext.

Specified by:

doExport in class Exporter

Parameters:

progress - the meter to update with progress during the export.

Returns:

the path to the exported content.

Throws:

ImportExportException - if it fails for any reason.

doExportInternal

protected String doExportInternal(com.atlassian.core.util.ProgressMeter progress)
                           throws ImportExportException

Throws:

ImportExportException

backupEverything

protected void backupEverything(HibernateObjectHandleTranslator translator,
                                com.atlassian.core.util.ProgressMeter progress)
                         throws ImportExportException

copies attachments, templates and config files

Overrides:

backupEverything in class AbstractXmlExporter

Throws:

ImportExportException

getIncludedSpaces

protected abstract List<Space> getIncludedSpaces()

Returns the List of Spaces that should be included in the export

When all Spaces are included, an empty List should be returned

Returns:

a List of Space objects

See Also:

AttachmentDao.AttachmentCopier.setSpacesToInclude(List)

backupAttachments

protected void backupAttachments()
                          throws ImportExportException

Backs up the Attachments and stores them in the "attachments" directory of the export.

This method copies all attachments from the current Attachment store to the export location.

The spaces to be included in the export are used to restrict what attachments are included. The pages to be excluded in the export are used to restrict what attachments are included.

Throws:

ImportExportException

See Also:

AbstractXmlExporter.getObjectsExcludedFromExport(), getIncludedSpaces()

backupResources

protected void backupResources()
                        throws ImportExportException

Throws:

ImportExportException

backupTemplates

protected void backupTemplates()
                        throws ImportExportException

Throws:

ImportExportException

backupConfigFiles

protected void backupConfigFiles()
                          throws ImportExportException

Throws:

ImportExportException

backupPluginData

protected void backupPluginData()
                         throws ImportExportException

Throws:

ImportExportException

setAttachmentManager

public void setAttachmentManager(AttachmentManager attachmentManager)

setBackupRestoreProviderManager

public void setBackupRestoreProviderManager(BackupRestoreProviderManager backupRestoreProviderManager)

setConfluenceHome

public void setConfluenceHome(com.atlassian.dc.filestore.api.compat.FilesystemPath confluenceHome)