org.opencms.importexport
Class A_CmsImport

java.lang.Object
  extended byorg.opencms.importexport.A_CmsImport
All Implemented Interfaces:
I_CmsImport
Direct Known Subclasses:
CmsImportVersion2, CmsImportVersion3, CmsImportVersion4, CmsImportVersion5

Deprecated. the import is done starting with CmsImportVersion7 with the digester

public abstract class A_CmsImport
extends java.lang.Object
implements I_CmsImport

Collection of common used methods for implementing OpenCms Import classes.

This class does not implement a real OpenCms import, real import implementation should be inherited form this class.

Since:
6.0.0
Version:
$Revision: 1.89 $
Author:
Michael Emmerich, Thomas Weckert
See Also:
I_CmsImport

Field Summary
static java.lang.String A_NAME
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "userinfo/entry@name" attribute, contains the additional user info entry name.
static java.lang.String A_TYPE
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "userinfo/entry@type" attribute, contains the additional user info entry data type name.
protected static int DEBUG
          Deprecated. Debug flag to show debug output.
protected  CmsObject m_cms
          Deprecated. The cms context to do the import operations with.
protected  boolean m_convertToXmlPage
          Deprecated. Flag for conversion to xml pages.
protected  org.dom4j.Document m_docXml
          Deprecated. The xml manifest-file.
protected  java.util.Stack m_groupsToCreate
          Deprecated. Groups to create during import are stored here.
protected  java.lang.String m_importPath
          Deprecated. The import-path to write resources into the cms.
protected  java.io.File m_importResource
          Deprecated. The import-resource (folder) to load resources from.
protected  java.util.zip.ZipFile m_importZip
          Deprecated. The import-resource (zip) to load resources from.
protected  java.util.Map m_linkPropertyStorage
          Deprecated. Storage for all pointer properties which must be converted into links.
protected  java.util.Map m_linkStorage
          Deprecated. Storage for all pointers which must be converted into links.
protected  I_CmsReport m_report
          Deprecated. The object to report the log messages.
protected  I_CmsMessageBundle m_userMessages
          Deprecated. Messages object with the locale of the current user.
static java.lang.String N_ACCESS
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "access" node.
static java.lang.String N_ACCESSCONTROL_ALLOWEDPERMISSIONS
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "allowed" node, to identify allowed user permissions.
static java.lang.String N_ACCESSCONTROL_DENIEDPERMISSIONS
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "denied" node, to identify denied user permissions.
static java.lang.String N_ACCESSCONTROL_ENTRIES
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "accesscontrol" node, to identify access control entries.
static java.lang.String N_ACCESSCONTROL_ENTRY
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "accessentry" node, to identify a single access control entry.
static java.lang.String N_ACCESSCONTROL_PERMISSIONSET
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "permissionset" node, to identify a permission set.
static java.lang.String N_ACCESSCONTROL_PRINCIPAL
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "uuidprincipal" node, to identify a principal UUID.
static java.lang.String N_DATECREATED
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "datecreated" node, contains the date created VFS file attribute.
static java.lang.String N_DATEEXPIRED
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "dateexpired" node, contains the expiration date VFS file attribute.
static java.lang.String N_DATELASTMODIFIED
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "datelastmodified" node, contains the date last modified VFS file attribute.
static java.lang.String N_DATERELEASED
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "datereleased" node, contains the release date VFS file attribute.
static java.lang.String N_DEFAULTGROUP
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "defaultgroup" node, for backward compatibility with OpenCms 5.x.
static java.lang.String N_DESCRIPTION
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "description" node, contains a users description test.
static java.lang.String N_DESTINATION
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "destination" node, contains target VFS file name.
static java.lang.String N_EMAIL
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "email" node, contains a users email.
static java.lang.String N_FILE
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "file" node, container node for all VFS resources.
static java.lang.String N_FIRSTNAME
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "firstname" node, contains a users first name.
static java.lang.String N_FLAGS
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "flags" node, contains the flags of a VFS resource.
static java.lang.String N_GROUPDATA
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "groupdata" node, contains a users group data.
static java.lang.String N_GROUPNAME
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "groupname" node, contains a groups name.
static java.lang.String N_ID
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "id" node, only required for backward compatibility with import version 2.
static java.lang.String N_LASTMODIFIED
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "lastmodified" node, only required for backward compatibility with import version 2.
static java.lang.String N_LASTNAME
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "lastname" node, contains a users last name.
static java.lang.String N_NAME
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "name" node, contains a users login name.
static java.lang.String N_ORGUNITDATA
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "orgunitdatas" node, starts the organizational unit data.
static java.lang.String N_PARENTGROUP
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "parentgroup" node, contains a groups parent group name.
static java.lang.String N_PASSWORD
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "password" node, contains a users encrypted password.
static java.lang.String N_PROPERTIES
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "properties" node, starts the list of properties of a VFS resource.
static java.lang.String N_PROPERTY
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "property" node, starts a property for a VFS resource.
static java.lang.String N_PROPERTY_ATTRIB_TYPE
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "type" property attribute, contains a property type.
static java.lang.String N_PROPERTY_ATTRIB_TYPE_SHARED
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "shared" property type attribute value.
static java.lang.String N_RELATION
          Deprecated. Tag in the [@link #EXPORT_MANIFEST} for the "relation" node, starts a relation for a VFS resource.
static java.lang.String N_RELATION_ATTRIBUTE_ID
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "id" relation attribute, contains the structure id of the target resource of the relation.
static java.lang.String N_RELATION_ATTRIBUTE_PATH
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "path" relation attribute, contains the path to the target resource of the relation.
static java.lang.String N_RELATION_ATTRIBUTE_TYPE
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "type" relation attribute, contains the type of relation.
static java.lang.String N_RELATIONS
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "relations" node, starts the list of relations of a VFS resources.
static java.lang.String N_SOURCE
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "source" node, contains the source path of a VFS resource in the import zip (or folder).
static java.lang.String N_TAG_ADDRESS
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "address" node, contains a users address.
static java.lang.String N_TYPE
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "type" node, the resource type name of a VFS resource.
static java.lang.String N_USER
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "user" node, starts the user data.
static java.lang.String N_USERCREATED
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "usercreated" node, contains the name of the user who created the VFS resource.
static java.lang.String N_USERDATA
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "userdata" node, starts the list of users.
static java.lang.String N_USERGROUPDATA
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "usergroupdatas" node, starts the users group data.
static java.lang.String N_USERGROUPS
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "usergroups" node, starts the users group data.
static java.lang.String N_USERINFO
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "userinfo" node, contains the additional user info.
static java.lang.String N_USERINFO_ENTRY
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "userinfo/entry" node, contains the additional user info entry value.
static java.lang.String N_USERLASTMODIFIED
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "userlastmodified" node, contains the name of the user who last modified the VFS resource.
static java.lang.String N_UUIDRESOURCE
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "uuidresource" node, contains a the resource UUID of a VFS resource.
static java.lang.String N_UUIDSTRUCTURE
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "uuidstructure" node, only required for backward compatibility with import version 2.
static java.lang.String N_VALUE
          Deprecated. Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "value" node, contains the value of a property.
static java.lang.String RESOURCE_TYPE_LEGACY_PAGE_NAME
          Deprecated. The name of the legacy resource type "page".
protected static int RESOURCE_TYPE_LINK_ID
          Deprecated. The id of the legacy resource type "link".
protected static java.lang.String RESOURCE_TYPE_LINK_NAME
          Deprecated. The name of the legacy resource type "link".
protected static int RESOURCE_TYPE_NEWPAGE_ID
          Deprecated. The id of the legacy resource type "newpage".
protected static java.lang.String RESOURCE_TYPE_NEWPAGE_NAME
          Deprecated. The name of the legacy resource type "newpage".
 
Constructor Summary
A_CmsImport()
          Deprecated.  
 
Method Summary
protected  boolean checkImmutable(java.lang.String translatedName, java.util.List immutableResources)
          Deprecated. Checks if the resources is in the list of immutalbe resources.
protected  void cleanUp()
          Deprecated. Cleans up member variables after the import is finished.
 java.lang.String convertDigestEncoding(java.lang.String value)
          Deprecated. Converts a given digest to base64 encoding.
protected  void convertPointerToSiblings()
          Deprecated. Converts old style pointers to siblings if possible.
 java.lang.String getChildElementTextValue(org.dom4j.Element parentElement, java.lang.String elementName)
          Deprecated. Returns the value of a child element with a specified name for a given parent element.
protected  byte[] getFileBytes(java.lang.String filename)
          Deprecated. Returns a byte array containing the content of the file.
protected  CmsAccessControlEntry getImportAccessControlEntry(CmsResource res, java.lang.String id, java.lang.String allowed, java.lang.String denied, java.lang.String flags)
          Deprecated. Creates a new access control entry and stores it for later write out.
protected  java.util.Locale getLocale(java.lang.String destination, java.util.List properties)
          Deprecated. Returns the appropriate locale for the given destination.
protected  void importAccessControlEntries(CmsResource resource, java.util.List aceList)
          Deprecated. Writes already imported access control entries for a given resource.
protected  void importGroup(java.lang.String name, java.lang.String description, java.lang.String flags, java.lang.String parentgroupName)
          Deprecated. Imports a single group.
protected  void importGroups()
          Deprecated. Imports the OpenCms groups.
protected  void importUser(java.lang.String name, java.lang.String flags, java.lang.String password, java.lang.String firstname, java.lang.String lastname, java.lang.String email, long dateCreated, java.util.Map userInfo, java.util.List userGroups)
          Deprecated. Imports a single user.
protected  void importUsers()
          Deprecated. Imports the OpenCms users.
protected  void initialize()
          Deprecated. Initializes all member variables before the import is started.
 boolean matches(CmsImportParameters parameters)
          Deprecated. Checks if the file given as parameter matches this import version implementation.
protected  java.util.List readPropertiesFromManifest(org.dom4j.Element parentElement, java.util.List ignoredPropertyKeys)
          Deprecated. Reads all properties below a specified parent element from the manifest.xml.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opencms.importexport.I_CmsImport
getVersion, importData, importResources
 

Field Detail

A_NAME

public static final java.lang.String A_NAME
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "userinfo/entry@name" attribute, contains the additional user info entry name.

See Also:
Constant Field Values

A_TYPE

public static final java.lang.String A_TYPE
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "userinfo/entry@type" attribute, contains the additional user info entry data type name.

See Also:
Constant Field Values

N_ACCESS

public static final java.lang.String N_ACCESS
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "access" node.

See Also:
Constant Field Values

N_ACCESSCONTROL_ALLOWEDPERMISSIONS

public static final java.lang.String N_ACCESSCONTROL_ALLOWEDPERMISSIONS
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "allowed" node, to identify allowed user permissions.

See Also:
Constant Field Values

N_ACCESSCONTROL_DENIEDPERMISSIONS

public static final java.lang.String N_ACCESSCONTROL_DENIEDPERMISSIONS
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "denied" node, to identify denied user permissions.

See Also:
Constant Field Values

N_ACCESSCONTROL_ENTRIES

public static final java.lang.String N_ACCESSCONTROL_ENTRIES
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "accesscontrol" node, to identify access control entries.

See Also:
Constant Field Values

N_ACCESSCONTROL_ENTRY

public static final java.lang.String N_ACCESSCONTROL_ENTRY
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "accessentry" node, to identify a single access control entry.

See Also:
Constant Field Values

N_ACCESSCONTROL_PERMISSIONSET

public static final java.lang.String N_ACCESSCONTROL_PERMISSIONSET
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "permissionset" node, to identify a permission set.

See Also:
Constant Field Values

N_ACCESSCONTROL_PRINCIPAL

public static final java.lang.String N_ACCESSCONTROL_PRINCIPAL
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "uuidprincipal" node, to identify a principal UUID.

See Also:
Constant Field Values

N_DATECREATED

public static final java.lang.String N_DATECREATED
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "datecreated" node, contains the date created VFS file attribute.

See Also:
Constant Field Values

N_DATEEXPIRED

public static final java.lang.String N_DATEEXPIRED
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "dateexpired" node, contains the expiration date VFS file attribute.

See Also:
Constant Field Values

N_DATELASTMODIFIED

public static final java.lang.String N_DATELASTMODIFIED
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "datelastmodified" node, contains the date last modified VFS file attribute.

See Also:
Constant Field Values

N_DATERELEASED

public static final java.lang.String N_DATERELEASED
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "datereleased" node, contains the release date VFS file attribute.

See Also:
Constant Field Values

N_DEFAULTGROUP

public static final java.lang.String N_DEFAULTGROUP
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "defaultgroup" node, for backward compatibility with OpenCms 5.x.

See Also:
Constant Field Values

N_DESCRIPTION

public static final java.lang.String N_DESCRIPTION
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "description" node, contains a users description test.

See Also:
Constant Field Values

N_DESTINATION

public static final java.lang.String N_DESTINATION
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "destination" node, contains target VFS file name.

See Also:
Constant Field Values

N_EMAIL

public static final java.lang.String N_EMAIL
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "email" node, contains a users email.

See Also:
Constant Field Values

N_FILE

public static final java.lang.String N_FILE
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "file" node, container node for all VFS resources.

See Also:
Constant Field Values

N_FIRSTNAME

public static final java.lang.String N_FIRSTNAME
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "firstname" node, contains a users first name.

See Also:
Constant Field Values

N_FLAGS

public static final java.lang.String N_FLAGS
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "flags" node, contains the flags of a VFS resource.

See Also:
Constant Field Values

N_GROUPDATA

public static final java.lang.String N_GROUPDATA
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "groupdata" node, contains a users group data.

See Also:
Constant Field Values

N_GROUPNAME

public static final java.lang.String N_GROUPNAME
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "groupname" node, contains a groups name.

See Also:
Constant Field Values

N_ID

public static final java.lang.String N_ID
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "id" node, only required for backward compatibility with import version 2.

See Also:
Constant Field Values

N_LASTMODIFIED

public static final java.lang.String N_LASTMODIFIED
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "lastmodified" node, only required for backward compatibility with import version 2.

See Also:
Constant Field Values

N_LASTNAME

public static final java.lang.String N_LASTNAME
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "lastname" node, contains a users last name.

See Also:
Constant Field Values

N_NAME

public static final java.lang.String N_NAME
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "name" node, contains a users login name.

See Also:
Constant Field Values

N_ORGUNITDATA

public static final java.lang.String N_ORGUNITDATA
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "orgunitdatas" node, starts the organizational unit data.

See Also:
Constant Field Values

N_PARENTGROUP

public static final java.lang.String N_PARENTGROUP
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "parentgroup" node, contains a groups parent group name.

See Also:
Constant Field Values

N_PASSWORD

public static final java.lang.String N_PASSWORD
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "password" node, contains a users encrypted password.

See Also:
Constant Field Values

N_PROPERTIES

public static final java.lang.String N_PROPERTIES
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "properties" node, starts the list of properties of a VFS resource.

See Also:
Constant Field Values

N_PROPERTY

public static final java.lang.String N_PROPERTY
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "property" node, starts a property for a VFS resource.

See Also:
Constant Field Values

N_PROPERTY_ATTRIB_TYPE

public static final java.lang.String N_PROPERTY_ATTRIB_TYPE
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "type" property attribute, contains a property type.

See Also:
Constant Field Values

N_PROPERTY_ATTRIB_TYPE_SHARED

public static final java.lang.String N_PROPERTY_ATTRIB_TYPE_SHARED
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "shared" property type attribute value.

See Also:
Constant Field Values

N_RELATION

public static final java.lang.String N_RELATION
Deprecated. 
Tag in the [@link #EXPORT_MANIFEST} for the "relation" node, starts a relation for a VFS resource.

See Also:
Constant Field Values

N_RELATION_ATTRIBUTE_ID

public static final java.lang.String N_RELATION_ATTRIBUTE_ID
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "id" relation attribute, contains the structure id of the target resource of the relation.

See Also:
Constant Field Values

N_RELATION_ATTRIBUTE_PATH

public static final java.lang.String N_RELATION_ATTRIBUTE_PATH
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "path" relation attribute, contains the path to the target resource of the relation.

See Also:
Constant Field Values

N_RELATION_ATTRIBUTE_TYPE

public static final java.lang.String N_RELATION_ATTRIBUTE_TYPE
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "type" relation attribute, contains the type of relation.

See Also:
Constant Field Values

N_RELATIONS

public static final java.lang.String N_RELATIONS
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "relations" node, starts the list of relations of a VFS resources.

See Also:
Constant Field Values

N_SOURCE

public static final java.lang.String N_SOURCE
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "source" node, contains the source path of a VFS resource in the import zip (or folder).

See Also:
Constant Field Values

N_TAG_ADDRESS

public static final java.lang.String N_TAG_ADDRESS
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "address" node, contains a users address.

See Also:
Constant Field Values

N_TYPE

public static final java.lang.String N_TYPE
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "type" node, the resource type name of a VFS resource.

See Also:
Constant Field Values

N_USER

public static final java.lang.String N_USER
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "user" node, starts the user data.

See Also:
Constant Field Values

N_USERCREATED

public static final java.lang.String N_USERCREATED
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "usercreated" node, contains the name of the user who created the VFS resource.

See Also:
Constant Field Values

N_USERDATA

public static final java.lang.String N_USERDATA
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "userdata" node, starts the list of users.

See Also:
Constant Field Values

N_USERGROUPDATA

public static final java.lang.String N_USERGROUPDATA
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "usergroupdatas" node, starts the users group data.

See Also:
Constant Field Values

N_USERGROUPS

public static final java.lang.String N_USERGROUPS
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "usergroups" node, starts the users group data.

See Also:
Constant Field Values

N_USERINFO

public static final java.lang.String N_USERINFO
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "userinfo" node, contains the additional user info.

See Also:
Constant Field Values

N_USERINFO_ENTRY

public static final java.lang.String N_USERINFO_ENTRY
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "userinfo/entry" node, contains the additional user info entry value.

See Also:
Constant Field Values

N_USERLASTMODIFIED

public static final java.lang.String N_USERLASTMODIFIED
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "userlastmodified" node, contains the name of the user who last modified the VFS resource.

See Also:
Constant Field Values

N_UUIDRESOURCE

public static final java.lang.String N_UUIDRESOURCE
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "uuidresource" node, contains a the resource UUID of a VFS resource.

See Also:
Constant Field Values

N_UUIDSTRUCTURE

public static final java.lang.String N_UUIDSTRUCTURE
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "uuidstructure" node, only required for backward compatibility with import version 2.

See Also:
Constant Field Values

N_VALUE

public static final java.lang.String N_VALUE
Deprecated. 
Tag in the CmsImportExportManager.EXPORT_MANIFEST for the "value" node, contains the value of a property.

See Also:
Constant Field Values

RESOURCE_TYPE_LEGACY_PAGE_NAME

public static final java.lang.String RESOURCE_TYPE_LEGACY_PAGE_NAME
Deprecated. 
The name of the legacy resource type "page".

See Also:
Constant Field Values

DEBUG

protected static final int DEBUG
Deprecated. 
Debug flag to show debug output.

See Also:
Constant Field Values

RESOURCE_TYPE_LINK_ID

protected static final int RESOURCE_TYPE_LINK_ID
Deprecated. 
The id of the legacy resource type "link".

See Also:
Constant Field Values

RESOURCE_TYPE_LINK_NAME

protected static final java.lang.String RESOURCE_TYPE_LINK_NAME
Deprecated. 
The name of the legacy resource type "link".

See Also:
Constant Field Values

RESOURCE_TYPE_NEWPAGE_ID

protected static final int RESOURCE_TYPE_NEWPAGE_ID
Deprecated. 
The id of the legacy resource type "newpage".

See Also:
Constant Field Values

RESOURCE_TYPE_NEWPAGE_NAME

protected static final java.lang.String RESOURCE_TYPE_NEWPAGE_NAME
Deprecated. 
The name of the legacy resource type "newpage".

See Also:
Constant Field Values

m_cms

protected CmsObject m_cms
Deprecated. 
The cms context to do the import operations with.


m_convertToXmlPage

protected boolean m_convertToXmlPage
Deprecated. 
Flag for conversion to xml pages.


m_docXml

protected org.dom4j.Document m_docXml
Deprecated. 
The xml manifest-file.


m_groupsToCreate

protected java.util.Stack m_groupsToCreate
Deprecated. 
Groups to create during import are stored here.


m_importPath

protected java.lang.String m_importPath
Deprecated. 
The import-path to write resources into the cms.


m_importResource

protected java.io.File m_importResource
Deprecated. 
The import-resource (folder) to load resources from.


m_importZip

protected java.util.zip.ZipFile m_importZip
Deprecated. 
The import-resource (zip) to load resources from.


m_linkPropertyStorage

protected java.util.Map m_linkPropertyStorage
Deprecated. 
Storage for all pointer properties which must be converted into links.


m_linkStorage

protected java.util.Map m_linkStorage
Deprecated. 
Storage for all pointers which must be converted into links.


m_report

protected I_CmsReport m_report
Deprecated. 
The object to report the log messages.


m_userMessages

protected I_CmsMessageBundle m_userMessages
Deprecated. 
Messages object with the locale of the current user.

Constructor Detail

A_CmsImport

public A_CmsImport()
Deprecated. 
Method Detail

convertDigestEncoding

public java.lang.String convertDigestEncoding(java.lang.String value)
Deprecated. 
Converts a given digest to base64 encoding.

Parameters:
value - the digest value in the legacy encoding
Returns:
the digest in the new encoding

getChildElementTextValue

public java.lang.String getChildElementTextValue(org.dom4j.Element parentElement,
                                                 java.lang.String elementName)
Deprecated. 
Returns the value of a child element with a specified name for a given parent element.

Parameters:
parentElement - the parent element
elementName - the child element name
Returns:
the value of the child node, or null if something went wrong

matches

public boolean matches(CmsImportParameters parameters)
                throws CmsImportExportException
Deprecated. 
Description copied from interface: I_CmsImport
Checks if the file given as parameter matches this import version implementation.

Specified by:
matches in interface I_CmsImport
Parameters:
parameters - the parameters to use during matching
Returns:
true if the file can be imported by this import version implementation
Throws:
CmsImportExportException - if something goes wrong
See Also:
I_CmsImport.matches(org.opencms.importexport.CmsImportParameters)

checkImmutable

protected boolean checkImmutable(java.lang.String translatedName,
                                 java.util.List immutableResources)
Deprecated. 
Checks if the resources is in the list of immutalbe resources.

Parameters:
translatedName - the name of the resource
immutableResources - the list of the immutable resources
Returns:
true or false

cleanUp

protected void cleanUp()
Deprecated. 
Cleans up member variables after the import is finished.

This is required since there is only one instance for each import version that is kept in memory and reused.


convertPointerToSiblings

protected void convertPointerToSiblings()
Deprecated. 
Converts old style pointers to siblings if possible.


getFileBytes

protected byte[] getFileBytes(java.lang.String filename)
Deprecated. 
Returns a byte array containing the content of the file.

Parameters:
filename - the name of the file to read
Returns:
a byte array containing the content of the file

getImportAccessControlEntry

protected CmsAccessControlEntry getImportAccessControlEntry(CmsResource res,
                                                            java.lang.String id,
                                                            java.lang.String allowed,
                                                            java.lang.String denied,
                                                            java.lang.String flags)
Deprecated. 
Creates a new access control entry and stores it for later write out.

Parameters:
res - the resource
id - the id of the principal
allowed - the allowed permissions
denied - the denied permissions
flags - the flags
Returns:
the created ACE

getLocale

protected java.util.Locale getLocale(java.lang.String destination,
                                     java.util.List properties)
Deprecated. 
Returns the appropriate locale for the given destination.

Parameters:
destination - the destination path (parent must exist)
properties - the properties to check at first
Returns:
the locale

importAccessControlEntries

protected void importAccessControlEntries(CmsResource resource,
                                          java.util.List aceList)
Deprecated. 
Writes already imported access control entries for a given resource.

Parameters:
resource - the resource assigned to the access control entries
aceList - the access control entries to create

importGroup

protected void importGroup(java.lang.String name,
                           java.lang.String description,
                           java.lang.String flags,
                           java.lang.String parentgroupName)
                    throws CmsImportExportException
Deprecated. 
Imports a single group.

Parameters:
name - the name of the group
description - group description
flags - group flags
parentgroupName - name of the parent group
Throws:
CmsImportExportException - if something goes wrong

importGroups

protected void importGroups()
                     throws CmsImportExportException
Deprecated. 
Imports the OpenCms groups.

Throws:
CmsImportExportException - if something goes wrong

importUser

protected void importUser(java.lang.String name,
                          java.lang.String flags,
                          java.lang.String password,
                          java.lang.String firstname,
                          java.lang.String lastname,
                          java.lang.String email,
                          long dateCreated,
                          java.util.Map userInfo,
                          java.util.List userGroups)
                   throws CmsImportExportException
Deprecated. 
Imports a single user.

Parameters:
name - user name
flags - user flags
password - user password
firstname - firstname of the user
lastname - lastname of the user
email - user email
dateCreated - creation date
userInfo - user info
userGroups - user groups
Throws:
CmsImportExportException - in case something goes wrong

importUsers

protected void importUsers()
                    throws CmsImportExportException
Deprecated. 
Imports the OpenCms users.

Throws:
CmsImportExportException - if something goes wrong

initialize

protected void initialize()
Deprecated. 
Initializes all member variables before the import is started.

This is required since there is only one instance for each import version that is kept in memory and reused.


readPropertiesFromManifest

protected java.util.List readPropertiesFromManifest(org.dom4j.Element parentElement,
                                                    java.util.List ignoredPropertyKeys)
Deprecated. 
Reads all properties below a specified parent element from the manifest.xml.

Parameters:
parentElement - the current file node
ignoredPropertyKeys - a list of properties to be ignored
Returns:
a list with all properties