com.atlassian.crowd.migration
Interface XmlMigrationManager

All Known Implementing Classes:

XmlMigrationManagerImpl

public interface XmlMigrationManager

Method Summary

long	exportXml(java.lang.String path, java.util.Map options) Exports the Crowd server's state to an XML file.
long	importXml(java.lang.String path) Imports exported Crowd server state from an XML file.

Method Detail

exportXml

long exportXml(java.lang.String path,
               java.util.Map options)
               throws ExportException

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.

importXml

long importXml(java.lang.String path)
               throws ImportException

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.