com.atlassian.crowd.migration

Interface XmlMigrationManager

All Known Implementing Classes:

XmlMigrationManagerImpl

public interface XmlMigrationManager

Method Summary

Modifier and Type	Method and Description
long	exportXml(String path, Map<String,Object> options) Exports the Crowd server's state to an XML file.
long	importXml(String path) Imports exported Crowd server state from an XML file.
void	runPostImportActions(String path) For testing purposes only.

Method Detail

exportXml

long exportXml(String path,
               Map<String,Object> options)
        throws ExportException,
               BackupOrRestoreAlreadyInProgressException

Exports the Crowd server's state to an XML file. This exports data from the Crowd database, crowd.cfg.xml and crowd.properties. The XML file will be a Crowd 2.x export, incompatible with Crowd 1.x.

Parameters:

path - file path of export XML.

options - export options.

Returns:

time taken to export (milliseconds).

Throws:

ExportException - something went wrong during the export.

BackupOrRestoreAlreadyInProgressException - in case a backup or a restore is already in progress

importXml

long importXml(String path)
        throws ImportException,
               BackupOrRestoreAlreadyInProgressException

Imports exported Crowd server state from an XML file. The XML file can be a Crowd 1.x export or a Crowd 2.x export.

Parameters:

path - file path of the XML backup to import.

Returns:

time taken to import (milliseconds).

Throws:

ImportException - something went wrong during the import.

BackupOrRestoreAlreadyInProgressException - in case a backup or a restore is already in progress

runPostImportActions

@Internal
void runPostImportActions(String path)
                             throws ImportException

For testing purposes only. Called by the external process after restoring database state.

Parameters:

path - file path of the XML backup that was restored

Throws:

ImportException - something went wrong during post import actions