Class AbstractXmlExporter
- java.lang.Object
-
- com.atlassian.confluence.importexport.Exporter
-
- com.atlassian.confluence.impl.importexport.AbstractExporterImpl
-
- com.atlassian.confluence.impl.importexport.AbstractXmlExporter
-
- Direct Known Subclasses:
AbstractFileXmlExporter
public abstract class AbstractXmlExporter extends AbstractExporterImpl
abstract class that deals strictly with the conversion of a objects to an xml stream- Since:
- 7.14
-
-
Field Summary
Fields Modifier and Type Field Description static StringATTACHMENTS_DIRECTORYDirectory into which attachments will be placed in the exported ZIP fileprotected BootstrapManagerbootstrapManagerstatic StringENTITIES_FILE_NAMEstatic StringEXPORT_DESCRIPTOR_FILE_NAMEprotected net.sf.hibernate.SessionFactorysessionFactoryprotected SpaceManagerspaceManagerstatic StringTEMPLATES_DIRECTORYDirectory into which template overrides will be placed in the exported ZIP file-
Fields inherited from class com.atlassian.confluence.impl.importexport.AbstractExporterImpl
i18nBeanFactory
-
-
Constructor Summary
Constructors Constructor Description AbstractXmlExporter()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected voidbackupEntities(HibernateObjectHandleTranslator translator, com.atlassian.core.util.ProgressMeter progress)Deprecated.since 7.16.0 usecom.atlassian.confluence.impl.importexport.export.BackupDescriptorWriterprotected voidbackupEverything(HibernateObjectHandleTranslator translator, com.atlassian.core.util.ProgressMeter progress)StringdoExport(HibernateObjectHandleTranslator translator, com.atlassian.core.util.ProgressMeter progress)protected OutputStreamgetDescriptorOutputStream()protected ExportScopegetExportScope()protected abstract List<TransientHibernateHandle>getHandlesOfObjectsForExport(HibernateObjectHandleTranslator translator, net.sf.hibernate.Session session)protected List<ConfluenceEntityObject>getObjectsExcludedFromExport()Gets a list of actual objects (not handles) to exclude from export.protected SettingsManagergetSettingsManager()protected abstract ListgetSourceTemplateDirForCopying()protected OutputStreamgetXmlOutputStream()output stream to write XML object information tovoidsetBootstrapManager(BootstrapManager bootstrapManager)protected voidsetCustomProperties(ExportDescriptor exportDescriptor)Override this in subclasses to add extra properties to the export descriptor.voidsetSessionFactory(net.sf.hibernate.SessionFactory sessionFactory)voidsetSettingsManager(SettingsManager settingsManager)voidsetSpaceManager(SpaceManager spaceManager)voidsetUpgradeManager(UpgradeManager upgradeManager)protected voidwriteBackupDescriptor()-
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
doExport, getContext, setContext
-
-
-
-
Field Detail
-
EXPORT_DESCRIPTOR_FILE_NAME
public static final String EXPORT_DESCRIPTOR_FILE_NAME
- See Also:
- Constant Field Values
-
ENTITIES_FILE_NAME
public static final String ENTITIES_FILE_NAME
- See Also:
- Constant Field Values
-
ATTACHMENTS_DIRECTORY
public static final String ATTACHMENTS_DIRECTORY
Directory into which attachments will be placed in the exported ZIP file- See Also:
- Constant Field Values
-
TEMPLATES_DIRECTORY
public static final String TEMPLATES_DIRECTORY
Directory into which template overrides will be placed in the exported ZIP file- See Also:
- Constant Field Values
-
sessionFactory
protected net.sf.hibernate.SessionFactory sessionFactory
-
bootstrapManager
protected BootstrapManager bootstrapManager
-
spaceManager
protected SpaceManager spaceManager
-
-
Method Detail
-
getHandlesOfObjectsForExport
protected abstract List<TransientHibernateHandle> getHandlesOfObjectsForExport(HibernateObjectHandleTranslator translator, net.sf.hibernate.Session session) throws ImportExportException
- Throws:
ImportExportException
-
setSessionFactory
public void setSessionFactory(net.sf.hibernate.SessionFactory sessionFactory)
-
setBootstrapManager
public void setBootstrapManager(BootstrapManager bootstrapManager)
-
getObjectsExcludedFromExport
protected List<ConfluenceEntityObject> getObjectsExcludedFromExport() throws ImportExportException
Gets a list of actual objects (not handles) to exclude from export.- Throws:
ImportExportException
-
doExport
public String doExport(HibernateObjectHandleTranslator translator, com.atlassian.core.util.ProgressMeter progress) throws ImportExportException
- Throws:
ImportExportException
-
backupEverything
protected void backupEverything(HibernateObjectHandleTranslator translator, com.atlassian.core.util.ProgressMeter progress) throws ImportExportException
- Throws:
ImportExportException
-
writeBackupDescriptor
protected void writeBackupDescriptor() throws ImportExportException- Throws:
ImportExportException
-
setCustomProperties
protected void setCustomProperties(ExportDescriptor exportDescriptor)
Override this in subclasses to add extra properties to the export descriptor.
-
getDescriptorOutputStream
protected OutputStream getDescriptorOutputStream() throws FileNotFoundException
- Throws:
FileNotFoundException
-
getXmlOutputStream
protected OutputStream getXmlOutputStream() throws IOException
output stream to write XML object information to- Returns:
- the XMLOutputStream
- Throws:
FileNotFoundExceptionIOException
-
getExportScope
protected ExportScope getExportScope()
-
getSourceTemplateDirForCopying
protected abstract List getSourceTemplateDirForCopying()
-
backupEntities
@Deprecated protected void backupEntities(HibernateObjectHandleTranslator translator, com.atlassian.core.util.ProgressMeter progress) throws ImportExportException
Deprecated.since 7.16.0 usecom.atlassian.confluence.impl.importexport.export.BackupDescriptorWriter- Throws:
ImportExportException
-
setSettingsManager
public void setSettingsManager(SettingsManager settingsManager)
-
setSpaceManager
public void setSpaceManager(SpaceManager spaceManager)
-
setUpgradeManager
public void setUpgradeManager(UpgradeManager upgradeManager)
-
getSettingsManager
protected SettingsManager getSettingsManager()
-
-