org.opencms.importexport
Interface I_CmsImport

All Known Implementing Classes:

A_CmsImport, CmsImportVersion2, CmsImportVersion3, CmsImportVersion4

public interface I_CmsImport

This interface describes a import class which is used to import resources into the VFS.

OpenCms supports different import versions, for each version a own import class must be implemented. A group of common used methods can be found in A_CmsImport.

Since:

6.0.0

Version:

$Revision: 1.16 $

Author:

Michael Emmerich, Thomas Weckert

Method Summary

int	getVersion() Returns the version of the import implementation.
void	importResources(CmsObject cms, String importPath, I_CmsReport report, File importResource, ZipFile importZip, Document docXml) Imports the resources.

Method Detail

getVersion

int getVersion()

Returns the version of the import implementation.

• 0 indicates an export file without a version number, that is before version 4.3.23 of OpenCms
• 1 indicates an export file of OpenCms with a version before 5.0.0
• 2 indicates an export file of OpenCms with a version before 5.1.2
• 3 indicates an export file of OpenCms with a version before 5.1.6
• 4 indicates an export file of OpenCms with a version after 5.1.6

Returns:

the version of the import implementation

importResources

void importResources(CmsObject cms,
                     String importPath,
                     I_CmsReport report,
                     File importResource,
                     ZipFile importZip,
                     Document docXml)
                     throws CmsImportExportException

Imports the resources.

Parameters:

cms - the current users OpenCms context

importPath - the path in the OpenCms VFS to import into

report - a report object to output the progress information to

importResource - the import-resource (folder) to load resources from

importZip - the import-resource (zip) to load resources from

docXml - the manifest.xml file which contains the meta information of the imported files

Throws:

CmsImportExportException - if something goes wrong