org.opencms.importexport
Class CmsImportVersion4

java.lang.Object
  org.opencms.importexport.A_CmsImport
      org.opencms.importexport.CmsImportVersion4

All Implemented Interfaces:

I_CmsImport

public class CmsImportVersion4

extends A_CmsImport

Implementation of the OpenCms Import Interface (I_CmsImport) for the import version 4.

This import format is used in OpenCms since 5.1.6.

Since:

6.0.0

Version:

$Revision: 1.84 $

Author:

Michael Emmerich, Thomas Weckert

See Also:

A_CmsImport

Field Summary

Fields inherited from class org.opencms.importexport.A_CmsImport

DEBUG, m_cms, m_convertToXmlPage, m_docXml, m_groupsToCreate, m_importingChannelData, m_importPath, m_importResource, m_importZip, m_linkPropertyStorage, m_linkStorage, m_report, m_userMessages, RESOURCE_TYPE_LEGACY_PAGE_NAME, RESOURCE_TYPE_LINK_ID, RESOURCE_TYPE_LINK_NAME, RESOURCE_TYPE_NEWPAGE_ID, RESOURCE_TYPE_NEWPAGE_NAME

Constructor Summary

CmsImportVersion4()
Creates a new CmsImportVerion4 object.

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.
protected void	importUser(String name, String description, String flags, String password, String firstname, String lastname, String email, String address, String type, Map userInfo, List userGroups) Imports a single user.

Methods inherited from class org.opencms.importexport.A_CmsImport

checkImmutable, cleanUp, convertDigestEncoding, convertPointerToSiblings, getFileBytes, getImportAccessControlEntry, getLocale, importAccessControlEntries, importGroup, importGroups, importUsers, initialize, readPropertiesFromManifest

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsImportVersion4

public CmsImportVersion4()

Creates a new CmsImportVerion4 object.

Method Detail

getVersion

public int getVersion()

Description copied from interface: I_CmsImport

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 number of this import implementation

See Also:

I_CmsImport.getVersion()

importResources

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

Description copied from interface: I_CmsImport

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

See Also:

I_CmsImport.importResources(org.opencms.file.CmsObject, java.lang.String, org.opencms.report.I_CmsReport, java.io.File, java.util.zip.ZipFile, org.dom4j.Document)

importUser

protected void importUser(String name,
                          String description,
                          String flags,
                          String password,
                          String firstname,
                          String lastname,
                          String email,
                          String address,
                          String type,
                          Map userInfo,
                          List userGroups)
                   throws CmsImportExportException

Imports a single user.

Overrides:

importUser in class A_CmsImport

Parameters:

name - user name

description - user description

flags - user flags

password - user password

firstname - firstname of the user

lastname - lastname of the user

email - user email

address - user address

type - user type

userInfo - user info

userGroups - user groups

Throws:

CmsImportExportException - in case something goes wrong