com.atlassian.confluence.importexport.xmlimport

Class BackupImporter

java.lang.Object

com.atlassian.confluence.importexport.Importer

com.atlassian.confluence.importexport.xmlimport.BackupImporter

Direct Known Subclasses:

FileBackupImporter

public abstract class BackupImporter
extends Importer

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFLUENCE_IMPORT_USE_LEGACY_IMPORTER
static BuildAndVersionNumber	FULL_EXPORT_BACKWARDS_COMPATIBILITY Backwards compatibility for full export.
static int	MINIMUM_BUILD_NUMBER
static BuildAndVersionNumber	MINIMUM_FULL_IMPORT_BUILD_NUMBER Backwards compatibility for full export.
static BuildAndVersionNumber	MINIMUM_SPACE_IMPORT_BUILD_NUMBER If you change this, you will break OD <-> BTF imports.
static String	MINIMUM_VERSION
static BuildAndVersionNumber	SPACE_EXPORT_BACKWARDS_COMPATIBILITY Backwards compatibility of a space export.

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

context, sessionFactory

Constructor Summary

Constructors

Constructor and Description
BackupImporter()

Method Summary

Modifier and Type	Method and Description
void	deleteAllDatabaseContent()
protected ImportProcessorSummary	doImportInternal() Performs the actual import.
protected boolean	doSpecialProcessing(net.sf.hibernate.Session session, TransientHibernateHandle key)
String	getBuildNumberOfImport()
String	getCreatedByBuildNumberOfImport()
protected abstract Properties	getDescriptorProperties()
String	getExportType()
protected UpgradeManager	getUpgradeManager()
abstract InputStream	getXmlEntitiesStream()
protected ImportProcessorSummary	importEntities(boolean hasExtraToImport)
protected ImportProcessorSummary	importEverything()
protected ImportProcessorSummary	importEverything(boolean hasExtraToImport)
boolean	isBackupAttachments()
static boolean	isBackupSupportedVersion(String buildNumberOfImport)
protected boolean	isExportedDefaultUserGroupPermission(SpacePermission permission)
boolean	isExportScopeAll()
boolean	isIncrementalImport()
protected void	postImportAndCleanUp() Perform any special logic after the import and post-import tasks are complete.
protected void	preImport() Perform any special logic prior to the import starting.
void	setBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)
void	setCacheFlusher(CacheFlusher cacheFlusher)
void	setCacheManager(com.atlassian.cache.CacheManager cacheManager) Deprecated. since 5.10 Use setCacheFlusher(CacheFlusher)
void	setI18NBeanFactory(I18NBeanFactory i18NBeanFactory)
void	setIncrementalImport(Boolean value) Deprecated. since 3.5 this is not used anywhere
void	setIndexManager(ConfluenceIndexManager indexManager)
void	setPluginStateStore(com.atlassian.plugin.manager.PluginPersistentStateStore pluginStateStore)
void	setPostRestoreUpgradeTasks(List<UpgradeTask> postRestoreUpgradeTasks)
void	setPreProcessors(List<ImportedObjectPreProcessor> preProcessors)
void	setScheduler(org.quartz.Scheduler scheduler)
void	setSchedulerService(com.atlassian.scheduler.core.LifecycleAwareSchedulerService schedulerService)
void	setSchemaHelper(SchemaHelper schemaHelper)
void	setSettingsManager(SettingsManager settingsManager)
void	setSpaceManager(SpaceManager spaceManager)
void	setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)
void	setUpgradeManager(UpgradeManager upgradeManager)
void	setUserAccessor(UserAccessor userAccessor)
void	setXmlImporter(XmlImporter xmlImporter)
protected void	unIndexAll()

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

completeProgessMeter, doImport, getEventPublisher, publishEvent, setContext, setEventPublisher, setPostImportTasks, setSessionFactory

Methods inherited from class java.lang.Object

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

Field Detail

CONFLUENCE_IMPORT_USE_LEGACY_IMPORTER

public static final String CONFLUENCE_IMPORT_USE_LEGACY_IMPORTER

See Also:

Constant Field Values

MINIMUM_BUILD_NUMBER

public static final int MINIMUM_BUILD_NUMBER

See Also:

Constant Field Values

MINIMUM_VERSION

public static final String MINIMUM_VERSION

See Also:

Constant Field Values

MINIMUM_FULL_IMPORT_BUILD_NUMBER

public static final BuildAndVersionNumber MINIMUM_FULL_IMPORT_BUILD_NUMBER

Backwards compatibility for full export. It means it is possible to put an export from the old database in the new one and run all upgrade tasks.

If you change this, you will break OD <-> BTF imports. For help to review your decision, please see Please see https://pug.jira-dev.com/wiki/display/CONFDEV/How+to+add+to+or+change+the+Confluence+Database

MINIMUM_SPACE_IMPORT_BUILD_NUMBER

public static final BuildAndVersionNumber MINIMUM_SPACE_IMPORT_BUILD_NUMBER

If you change this, you will break OD <-> BTF imports. For help to review your decision, please see https://pug.jira-dev.com/wiki/display/CONFDEV/How+to+add+to+or+change+the+Confluence+Database

FULL_EXPORT_BACKWARDS_COMPATIBILITY

public static final BuildAndVersionNumber FULL_EXPORT_BACKWARDS_COMPATIBILITY

Backwards compatibility for full export. It means an export from the current database will be successfully used as-is by a former version of Confluence.

If you change this, you will break OD <-> BTF imports. For help to review your decision, please see https://pug.jira-dev.com/wiki/display/CONFDEV/How+to+add+to+or+change+the+Confluence+Database

SPACE_EXPORT_BACKWARDS_COMPATIBILITY

public static final BuildAndVersionNumber SPACE_EXPORT_BACKWARDS_COMPATIBILITY

Backwards compatibility of a space export. It is equal to the backwards compatibility of a full export and this constant is provided for clarity.

Constructor Detail

BackupImporter

public BackupImporter()

Method Detail

setIncrementalImport

@Deprecated
public void setIncrementalImport(Boolean value)

Deprecated. since 3.5 this is not used anywhere

preImport

protected void preImport()
                  throws ImportExportException

Description copied from class: Importer

Perform any special logic prior to the import starting. Default implementation does nothing.

Overrides:

preImport in class Importer

Throws:

ImportExportException - if the import should be aborted

isBackupSupportedVersion

public static boolean isBackupSupportedVersion(String buildNumberOfImport)

doImportInternal

protected ImportProcessorSummary doImportInternal()
                                           throws ImportExportException

Description copied from class: Importer

Performs the actual import.

Specified by:

doImportInternal in class Importer

Throws:

ImportExportException - if there was a problem executing the import

See Also:

ImportExportManager.performImport(ImportContext)

postImportAndCleanUp

protected void postImportAndCleanUp()
                             throws ImportExportException

Description copied from class: Importer

Perform any special logic after the import and post-import tasks are complete. This method will run even if the import fails. The default implementation does nothing.

Overrides:

postImportAndCleanUp in class Importer

Throws:

ImportExportException - if the import process should be aborted

importEverything

protected ImportProcessorSummary importEverything()
                                           throws ImportExportException

Throws:

ImportExportException

importEverything

protected ImportProcessorSummary importEverything(boolean hasExtraToImport)
                                           throws ImportExportException

Throws:

ImportExportException

importEntities

protected ImportProcessorSummary importEntities(boolean hasExtraToImport)
                                         throws ImportExportException

Throws:

ImportExportException

doSpecialProcessing

protected boolean doSpecialProcessing(net.sf.hibernate.Session session,
                                      TransientHibernateHandle key)
                               throws ImportExportException,
                                      net.sf.hibernate.HibernateException

Throws:

ImportExportException

net.sf.hibernate.HibernateException

isExportedDefaultUserGroupPermission

protected boolean isExportedDefaultUserGroupPermission(SpacePermission permission)

deleteAllDatabaseContent

public void deleteAllDatabaseContent()
                              throws net.sf.hibernate.HibernateException,
                                     SQLException,
                                     com.atlassian.config.ConfigurationException

Throws:

net.sf.hibernate.HibernateException

SQLException

com.atlassian.config.ConfigurationException

unIndexAll

protected void unIndexAll()

getDescriptorProperties

protected abstract Properties getDescriptorProperties()
                                               throws ImportExportException

Throws:

ImportExportException

setCacheManager

@Deprecated
public void setCacheManager(com.atlassian.cache.CacheManager cacheManager)

Deprecated. since 5.10 Use setCacheFlusher(CacheFlusher)

setCacheFlusher

public void setCacheFlusher(CacheFlusher cacheFlusher)

setUserAccessor

public void setUserAccessor(UserAccessor userAccessor)

setSchemaHelper

public void setSchemaHelper(SchemaHelper schemaHelper)

getExportType

public String getExportType()
                     throws ImportExportException

Throws:

ImportExportException

isBackupAttachments

public boolean isBackupAttachments()
                            throws ImportExportException

Throws:

ImportExportException

getBuildNumberOfImport

public String getBuildNumberOfImport()
                              throws ImportExportException

Throws:

ImportExportException

getCreatedByBuildNumberOfImport

public String getCreatedByBuildNumberOfImport()
                                       throws ImportExportException

Throws:

ImportExportException

isIncrementalImport

public boolean isIncrementalImport()
                            throws ImportExportException

Throws:

ImportExportException

isExportScopeAll

public boolean isExportScopeAll()
                         throws ImportExportException

Throws:

ImportExportException

getXmlEntitiesStream

public abstract InputStream getXmlEntitiesStream()
                                          throws ImportExportException

Throws:

ImportExportException

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

setIndexManager

public void setIndexManager(ConfluenceIndexManager indexManager)

setScheduler

public void setScheduler(org.quartz.Scheduler scheduler)

setSchedulerService

public void setSchedulerService(com.atlassian.scheduler.core.LifecycleAwareSchedulerService schedulerService)

setI18NBeanFactory

public void setI18NBeanFactory(I18NBeanFactory i18NBeanFactory)

setPostRestoreUpgradeTasks

public void setPostRestoreUpgradeTasks(List<UpgradeTask> postRestoreUpgradeTasks)

setUpgradeManager

public void setUpgradeManager(UpgradeManager upgradeManager)

getUpgradeManager

protected UpgradeManager getUpgradeManager()

setXmlImporter

public void setXmlImporter(XmlImporter xmlImporter)

setTransactionManager

public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)

setPreProcessors

public void setPreProcessors(List<ImportedObjectPreProcessor> preProcessors)

setPluginStateStore

public void setPluginStateStore(com.atlassian.plugin.manager.PluginPersistentStateStore pluginStateStore)

setBandanaManager

public void setBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)

setSettingsManager

public void setSettingsManager(SettingsManager settingsManager)