com.atlassian.confluence.it.export
Class Importer

java.lang.Object
  extended by com.atlassian.confluence.it.export.Importer

public final class Importer
extends java.lang.Object

Contains methods for testing XML backup imports via Confluence admin panel.


Field Summary
static TimePeriod DEFAULT_TIMEOUT
           
static TimePeriod LONG_TIMEOUT
           
static TimePeriod RIDICULOUSLY_LONG_TIMEOUT
           
 
Constructor Summary
Importer(ConfluenceRpc rpc, java.lang.String configuredBaseUrl)
          Assumes that the webTester is already on the edit screen.
Importer(ConfluenceRpc rpc, java.lang.String configuredBaseUrl, net.sourceforge.jwebunit.junit.WebTester webTester)
           
 
Method Summary
 void attemptInvalidSpaceImport(java.io.File backupFile)
          Attempt to import a space backup that is expected to fail.
 java.lang.String getExportBuildNumber()
           
 java.lang.String getImportBackupValidationError(java.io.File backupFile)
           
 java.lang.String getOldestSpaceImportAllowed()
           
 java.lang.String getPluginExportCompatibility(java.lang.String pluginKey)
           
 void importGlobalBackup(java.io.File backupFile, TimePeriod importTimeout, DirectoryConfiguration directoryConfig, AdminConsole adminConsole)
          Perform a site import via the web ui.
 void importGlobalBackup(java.io.File backupFile, TimePeriod importTimeout, DirectoryConfiguration directoryConfig, AdminConsole adminConsole, boolean kickOfReindex)
          Perform a site import via the web ui.
 void importGlobalBackupAndWaitForReindex(java.io.File backupFile, TimePeriod importTimeout, DirectoryConfiguration directoryConfig, AdminConsole adminConsole)
           
 void importSpaceBackup(java.io.File backupFile, TimePeriod importTimeout)
          Import an xml exported space from the classpath into Confluence via the web ui.
 void importSynchronously(java.io.File exportZip, DirectoryConfiguration directoryConfig, AdminConsole adminConsole)
          This method tests the synchronous import mode in Confluence.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_TIMEOUT

public static final TimePeriod DEFAULT_TIMEOUT

LONG_TIMEOUT

public static final TimePeriod LONG_TIMEOUT

RIDICULOUSLY_LONG_TIMEOUT

public static final TimePeriod RIDICULOUSLY_LONG_TIMEOUT
Constructor Detail

Importer

public Importer(ConfluenceRpc rpc,
                java.lang.String configuredBaseUrl)
Assumes that the webTester is already on the edit screen.

Parameters:
rpc - must be logged in as a user with administrative privileges.

Importer

public Importer(ConfluenceRpc rpc,
                java.lang.String configuredBaseUrl,
                net.sourceforge.jwebunit.junit.WebTester webTester)
Method Detail

importSpaceBackup

public void importSpaceBackup(java.io.File backupFile,
                              TimePeriod importTimeout)

Import an xml exported space from the classpath into Confluence via the web ui. It sets the TextField containing location of the backup file, which must be set in setBackupFile method.

Does Not Rebuild Index.

This method relies on being the only import process running at the time, since it waits for an ImportFinishedEvent - up to the given timeout amount

Parameters:
backupFile - to be imported
importTimeout - maximum amount of time to wait for the import before failing with a RuntimeException.

attemptInvalidSpaceImport

public void attemptInvalidSpaceImport(java.io.File backupFile)
Attempt to import a space backup that is expected to fail. This import makes no assertions about success and does not wait for completion.


importGlobalBackup

public void importGlobalBackup(java.io.File backupFile,
                               TimePeriod importTimeout,
                               DirectoryConfiguration directoryConfig,
                               AdminConsole adminConsole)

Perform a site import via the web ui. It sets the TextField containing location of the backup file, which must be set in setBackupFile method. After the import is performed, the base url setting is restored.

Does Not Rebuild Index.

This method relies on being the only import process running at the time, since it waits for an ImportFinishedEvent - up to the given timeout amount

Parameters:
backupFile - to be imported
importTimeout - maximum amount of time to wait for the import before failing with a RuntimeException.
directoryConfig - the expected user directory configuration, which must be restored following a global
adminConsole - required to disable websudo and enable the remote api

importGlobalBackup

public void importGlobalBackup(java.io.File backupFile,
                               TimePeriod importTimeout,
                               DirectoryConfiguration directoryConfig,
                               AdminConsole adminConsole,
                               boolean kickOfReindex)

Perform a site import via the web ui. It sets the TextField containing location of the backup file, which must be set in setBackupFile method. After the import is performed, the base url setting is restored.

This method relies on being the only import process running at the time, since it waits for an ImportFinishedEvent - up to the given timeout amount

Parameters:
backupFile - to be imported
importTimeout - maximum amount of time to wait for the import before failing with a RuntimeException.
directoryConfig - the expected user directory configuration, which must be restored following a global
adminConsole - required to disable websudo and enable the remote api
kickOfReindex - kick off the reindexing after import

getImportBackupValidationError

public java.lang.String getImportBackupValidationError(java.io.File backupFile)

importGlobalBackupAndWaitForReindex

public void importGlobalBackupAndWaitForReindex(java.io.File backupFile,
                                                TimePeriod importTimeout,
                                                DirectoryConfiguration directoryConfig,
                                                AdminConsole adminConsole)

importSynchronously

public void importSynchronously(java.io.File exportZip,
                                DirectoryConfiguration directoryConfig,
                                AdminConsole adminConsole)
This method tests the synchronous import mode in Confluence. This mode was originally introduced to assist with testing but runs into difficulties for slower imports. However, since the plugin func-test library uses the synchronous import mode we have to maintain it here too.


getExportBuildNumber

public java.lang.String getExportBuildNumber()

getOldestSpaceImportAllowed

public java.lang.String getOldestSpaceImportAllowed()

getPluginExportCompatibility

public java.lang.String getPluginExportCompatibility(java.lang.String pluginKey)


Copyright © 2003-2014 Atlassian. All Rights Reserved.