public class CmsImportVersion10 extends java.lang.Object implements I_CmsImport
| Modifier and Type | Class and Description |
|---|---|
static class |
CmsImportVersion10.RelationData
Data class to temporarily keep track of relation data for a resource to be imported.
|
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
A_NAME
Tag for the "userinfo / entry name" attribute, contains the additional user info entry name.
|
static java.lang.String |
A_TYPE
Tag for the "type" attribute, contains the property type.
|
protected static long |
DATE_CREATED_UNSPECIFIED
Constant for the unspecified creation date.
|
protected static long |
DATE_LAST_MODIFICATION_FILETIME
Constant for using file time as last modification date on file import.
|
protected static long |
DATE_LAST_MODIFICATION_UNSPECIFIED
Constant for an unspecified last modification date.
|
static java.lang.String |
DTD_FILENAME
The name of the DTD for this import version.
|
static java.lang.String |
DTD_LOCATION
The location of the OpenCms configuration DTD if the default prefix is the system ID.
|
static int |
IMPORT_VERSION10
The version number of this import implementation.
|
protected int |
m_aceFlags
The ACE flags value.
|
protected int |
m_acePermissionsAllowed
The ACE allowed permissions value.
|
protected int |
m_acePermissionsDenied
The ACE denied permissions value.
|
protected CmsUUID |
m_acePrincipalId
The ACE principal id value.
|
protected java.util.List<CmsAccessControlEntry> |
m_aces
The list of ACEs for the current imported resource.
|
protected CmsObject |
m_cms
The cms object.
|
protected java.util.Set<CmsUUID> |
m_contentFiles
The set of resource ids of files which actually are contained in the zip file.
|
protected java.lang.String |
m_destination
The destination value.
|
protected int |
m_fileCounter
The current file counter.
|
protected java.lang.String |
m_groupDescription
The description of the current group to import.
|
protected int |
m_groupFlags
The flags of the current group to import.
|
protected java.lang.String |
m_groupName
The name of the current group to import.
|
protected java.lang.String |
m_groupParent
The parent of the current group to import.
|
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
m_groupParents
Map of all parent groups that could not be set immediately, because of the import order.
|
protected boolean |
m_hasDateLastModified
True if a modification date has been set.
|
protected boolean |
m_hasStructureId
True if a structure id has been set.
|
protected CmsImportHelper |
m_helper
The import helper.
|
protected java.util.List<java.lang.String> |
m_ignoredProperties
List of ignored properties.
|
protected java.util.List<java.lang.String> |
m_immutables
List of immutable resources.
|
protected boolean |
m_importACEs
The flag to import ACEs.
|
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> |
m_membership
The membership structure.
|
protected CmsOrganizationalUnit |
m_orgUnit
The current imported organizational unit.
|
protected java.lang.String |
m_orgUnitDescription
The organizational unit description.
|
protected int |
m_orgUnitFlags
The organizational unit flags.
|
protected java.lang.String |
m_orgUnitName
The organizational unit fqn.
|
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
m_orgUnitResources
The map of organizational unit resources, this is a global field that will be use at the end of the import.
|
protected CmsImportParameters |
m_parameters
The import parameters to use.
|
protected java.util.List<CmsResource> |
m_parseables
The list of resource to be parsed, this is a global list, which will be handled at the end of the import.
|
protected java.lang.String |
m_projectDescription
The project description.
|
protected java.lang.String |
m_projectManagers
The project managers group name.
|
protected java.lang.String |
m_projectName
The project fqn.
|
protected java.util.List<java.lang.String> |
m_projectResources
The current read project resources.
|
protected java.lang.String |
m_projectUsers
The project users group name.
|
protected java.util.Map<java.lang.String,CmsProperty> |
m_properties
The map of properties for current imported resource.
|
protected java.lang.String |
m_propertyName
The property name value.
|
protected java.lang.String |
m_propertyValue
The property value value.
|
protected CmsUUID |
m_relationId
The relation id value.
|
protected java.lang.String |
m_relationPath
The relation path value.
|
protected java.util.List<CmsImportVersion10.RelationData> |
m_relationsForResource
Holds the relation data for the resource to be imported.
|
protected CmsRelationType |
m_relationType
The relation type value.
|
protected I_CmsReport |
m_report
The report.
|
protected CmsResource |
m_resource
The current imported resource.
|
protected CmsResourceBuilder |
m_resourceBuilder
Holds the field values for the CmsResource object to be created.
|
protected java.lang.String |
m_source
The source value.
|
protected java.lang.Throwable |
m_throwable
Possible exception during xml parsing.
|
protected int |
m_totalFiles
The total number of files to import.
|
protected CmsUser |
m_user
The current imported user.
|
protected long |
m_userDateCreated
The current user date created.
|
protected java.lang.String |
m_userEmail
The current user email.
|
protected java.lang.String |
m_userFirstname
The current user first name.
|
protected int |
m_userFlags
The current user flags.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
m_userInfos
The additional information for the current imported user.
|
protected java.lang.String |
m_userLastname
The current user last name.
|
protected java.lang.String |
m_userName
The current user name.
|
protected java.lang.String |
m_userPassword
The current user password.
|
protected int |
m_version
The export version.
|
static java.lang.String |
N_ACCESSCONTROL_ALLOWEDPERMISSIONS
Tag for the "allowed" node, to identify allowed user permissions.
|
static java.lang.String |
N_ACCESSCONTROL_DENIEDPERMISSIONS
Tag for the "denied" node, to identify denied user permissions.
|
static java.lang.String |
N_ACCESSCONTROL_ENTRIES
Tag for the "accesscontrol" node, to identify access control entries.
|
static java.lang.String |
N_ACCESSCONTROL_ENTRY
Tag for the "accessentry" node, to identify a single access control entry.
|
static java.lang.String |
N_ACCESSCONTROL_PERMISSIONSET
Tag for the "permissionset" node, to identify a permission set.
|
static java.lang.String |
N_ACCESSCONTROL_PRINCIPAL
Tag for the "uuidprincipal" node, to identify a principal UUID.
|
static java.lang.String |
N_ACCOUNTS
Tag for the "accounts" node.
|
static java.lang.String |
N_DATECREATED
Tag for the "datecreated" node, contains the date created VFS file attribute.
|
static java.lang.String |
N_DATEEXPIRED
Tag for the "dateexpired" node, contains the expiration date VFS file attribute.
|
static java.lang.String |
N_DATELASTMODIFIED
Tag for the "datelastmodified" node, contains the date last modified VFS file attribute.
|
static java.lang.String |
N_DATERELEASED
Tag for the "datereleased" node, contains the release date VFS file attribute.
|
static java.lang.String |
N_DESCRIPTION
Tag for the "description" node, contains a users description test.
|
static java.lang.String |
N_DESTINATION
Tag for the "destination" node, contains target VFS file name.
|
static java.lang.String |
N_EMAIL
Tag for the "email" node, contains a users email.
|
static java.lang.String |
N_FILE
Tag for the "file" node, container node for all VFS resources.
|
static java.lang.String |
N_FILES
Tag for the "files" node, container node for all VFS resources.
|
static java.lang.String |
N_FIRSTNAME
Tag for the "firstname" node, contains a users first name.
|
static java.lang.String |
N_FLAGS
Tag for the "flags" node, contains the flags of a VFS resource.
|
static java.lang.String |
N_GROUP
Tag for the "group" node, contains a group name.
|
static java.lang.String |
N_GROUPS
Tag for the "groups" node, contains a users group data.
|
static java.lang.String |
N_ID
Tag for the "id" relation attribute, contains the structure id of the target resource of the relation.
|
static java.lang.String |
N_LASTNAME
Tag for the "lastname" node, contains a users last name.
|
static java.lang.String |
N_MANAGERSGROUP
Tag for the "managersgroup" node, contains name of the managers group of the project.
|
static java.lang.String |
N_NAME
Tag for the "name" node, contains the name of a property.
|
static java.lang.String |
N_ORGUNIT
Tag for the "orgunit" node, starts the organizational unit data.
|
static java.lang.String |
N_ORGUNITS
Tag for the "orgunits" node, starts the organizational unit data.
|
static java.lang.String |
N_PARENTGROUP
Tag for the "parentgroup" node, contains a groups parent group fqn.
|
static java.lang.String |
N_PASSWORD
Tag for the "password" node, contains a users encrypted password.
|
static java.lang.String |
N_PATH
Tag for the "path" relation attribute, contains the path to the target resource of the relation.
|
static java.lang.String |
N_PROJECT
Tag for the "project" node, starts the project data.
|
static java.lang.String |
N_PROJECTS
Tag for the "projects" node, starts the project data.
|
static java.lang.String |
N_PROPERTIES
Tag for the "properties" node, starts the list of properties of a VFS resource.
|
static java.lang.String |
N_PROPERTY
Tag for the "property" node, starts a property for a VFS resource.
|
static java.lang.String |
N_RELATION
Tag in the
CmsImportExportManager.EXPORT_MANIFEST for the "relation" node, starts a relation for a VFS resource. |
static java.lang.String |
N_RELATIONS
Tag for the "relations" node, starts the list of relations of a VFS resources.
|
static java.lang.String |
N_RESOURCE
Tag for the "resource" node, contains the a organizational unit resource name.
|
static java.lang.String |
N_RESOURCES
Tag for the "resources" node, contains the list of organizational unit resources.
|
static java.lang.String |
N_SOURCE
Tag for the "source" node, contains the source path of a VFS resource in the import zip (or folder).
|
static java.lang.String |
N_TYPE
Tag for the "type" node, the resource type name of a VFS resource.
|
static java.lang.String |
N_USER
Tag for the "user" node, starts the user data.
|
static java.lang.String |
N_USERCREATED
Tag for the "usercreated" node, contains the name of the user who created the VFS resource.
|
static java.lang.String |
N_USERGROUP
Tag for the "usergroup" node, the name of a users group.
|
static java.lang.String |
N_USERGROUPS
Tag for the "usergroups" node, starts the users group data.
|
static java.lang.String |
N_USERINFO
Tag for the "userinfo" node, contains the additional user info.
|
static java.lang.String |
N_USERINFO_ENTRY
Tag for the "userinfo/entry" node, contains the additional user info entry value.
|
static java.lang.String |
N_USERLASTMODIFIED
Tag for the "userlastmodified" node, contains the name of the user who last modified the VFS resource.
|
static java.lang.String |
N_USERROLE
Tag for the "userrole" node, contains an users role name.
|
static java.lang.String |
N_USERROLES
Tag for the "userroles" node, starts the users role data.
|
static java.lang.String |
N_USERS
Tag for the "users" node, starts the list of users.
|
static java.lang.String |
N_USERSGROUP
Tag for the "usersgroup" node, contains name of the users group of the project.
|
static java.lang.String |
N_UUIDRESOURCE
Tag for the "uuidresource" node, contains a the resource UUID of a VFS resource.
|
static java.lang.String |
N_UUIDSTRUCTURE
Tag for the "uuidstructure" node, only required for backward compatibility with import version 2.
|
static java.lang.String |
N_VALUE
Tag for the "value" node, contains the value of a property.
|
static java.lang.String |
PROPERTY_ATTRIB_TYPE_SHARED
Value for the "shared" property type attribute value.
|
| Constructor and Description |
|---|
CmsImportVersion10()
Public constructor.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addAccessControlEntry()
Adds an ACE from the current xml data.
|
protected void |
addAccountsGroupRules(org.apache.commons.digester3.Digester digester,
java.lang.String xpath)
Adds the XML digester rules for groups.
|
protected void |
addAccountsOrgunitRules(org.apache.commons.digester3.Digester digester,
java.lang.String xpath)
Adds the XML digester rules for organizational units.
|
protected void |
addAccountsUserRules(org.apache.commons.digester3.Digester digester,
java.lang.String xpath)
Adds the XML digester rules for users.
|
void |
addContentFile(java.lang.String source,
java.lang.String resourceId)
Registers a file whose contents are contained in the zip file.
|
void |
addOrgUnitResource(java.lang.String resourceName)
Adds a new resource to be associated to the current organizational unit.
|
void |
addProjectResource(java.lang.String resourceName)
Adds a new resource to be associated to the current project.
|
protected void |
addProjectRules(org.apache.commons.digester3.Digester digester,
java.lang.String xpath)
Adds the XML digester rules for projects.
|
void |
addProperty()
Adds a property from the current xml data, in case the type is implicit given.
|
void |
addProperty(java.lang.String propertyType)
Adds a property from the current xml data, in case the type is explicit given.
|
void |
addRelation()
Adds a relation to be imported from the current xml data.
|
protected void |
addResourceAceRules(org.apache.commons.digester3.Digester digester,
java.lang.String xpath)
Adds the XML digester rules for resource access control entries.
|
protected void |
addResourceAttributesRules(org.apache.commons.digester3.Digester digester,
java.lang.String xpath)
Adds the XML digester rules for resource attributes.
|
protected void |
addResourcePropertyRules(org.apache.commons.digester3.Digester digester,
java.lang.String xpath)
Adds the XML digester rules for resource properties.
|
protected void |
addResourceRelationRules(org.apache.commons.digester3.Digester digester,
java.lang.String xpath)
Adds the XML digester rules for resource relations.
|
void |
addXmlDigesterRules(org.apache.commons.digester3.Digester digester)
Adds the XML digester rules for a single import file.
|
void |
addXmlPreprocessingDigesterRules(org.apache.commons.digester3.Digester digester)
Adds the XML digester rules for pre-processing a single import file.
|
void |
associateOrgUnitResources()
Associates the stored resources to the created organizational units.
|
protected boolean |
checkImmutable(java.lang.String resourceName)
Checks if the resources is in the list of immutable resources.
|
protected java.lang.String |
convertDigestEncoding(java.lang.String value)
Converts a given digest to base64 encoding.
|
protected long |
convertTimestamp(java.lang.String timestamp)
Convert a given time stamp from a String format to a long value.
|
protected CmsResource |
createResourceObjectFromFields(java.lang.String translatedName,
int size)
Create a CmsResource object from the currently set field values.
|
protected void |
findContentFiles()
This method goes through the manifest, records all files from the manifest for which the content also
exists in the zip file, and stores their resource ids in m_contentFiles.
|
int |
getAceFlags()
Returns the ace Flags.
|
int |
getAcePermissionsAllowed()
Returns the ace Permissions Allowed.
|
int |
getAcePermissionsDenied()
Returns the acePermissionsDenied.
|
CmsUUID |
getAcePrincipalId()
Returns the acePrincipalId.
|
CmsObject |
getCms()
Returns the cms object.
|
long |
getDateCreated()
Returns the dateCreated.
|
long |
getDateExpired()
Returns the dateExpired.
|
long |
getDateLastModified()
Returns the dateLastModified.
|
long |
getDateReleased()
Returns the dateReleased.
|
java.lang.String |
getDestination()
Returns the destination.
|
int |
getFlags()
Returns the flags.
|
java.lang.String |
getGroupDescription()
Returns the group Description.
|
int |
getGroupFlags()
Returns the group Flags.
|
java.lang.String |
getGroupName()
Returns the group Name.
|
java.lang.String |
getGroupParent()
Returns the group Parent.
|
protected CmsImportHelper |
getHelper()
Gets the import helper instance.
|
protected java.util.List<java.lang.String> |
getIgnoredProperties()
Returns the list of properties to ignore during import.
|
protected java.util.List<java.lang.String> |
getImmutableResources()
Returns the list of immutable resources.
|
java.lang.String |
getOrgUnitDescription()
Returns the organizational unit description.
|
int |
getOrgUnitFlags()
Returns the organizational unit flags.
|
java.lang.String |
getOrgUnitName()
Returns the organizational unit name.
|
java.lang.String |
getProjectDescription()
Returns the project Description.
|
java.lang.String |
getProjectManagers()
Returns the project Managers group name.
|
java.lang.String |
getProjectName()
Returns the project Name.
|
java.lang.String |
getProjectUsers()
Returns the project Users group name.
|
java.lang.String |
getPropertyName()
Returns the propertyName.
|
java.lang.String |
getPropertyValue()
Returns the propertyValue.
|
CmsUUID |
getRelationId()
Returns the relationId.
|
java.lang.String |
getRelationPath()
Returns the relationPath.
|
CmsRelationType |
getRelationType()
Returns the relationType.
|
I_CmsReport |
getReport()
Returns the report.
|
CmsRequestContext |
getRequestContext()
Gets the request context of the currently used CmsObject.
|
CmsUUID |
getResourceId()
Returns the resourceId.
|
java.lang.String |
getSource()
Returns the source.
|
CmsUUID |
getStructureId()
Returns the structureId.
|
java.lang.Throwable |
getThrowable()
Returns the throwable.
|
I_CmsResourceType |
getType()
Returns the type.
|
CmsUUID |
getUserCreated()
Returns the userCreated.
|
long |
getUserDateCreated()
Returns the user Date Created.
|
java.lang.String |
getUserEmail()
Returns the user Email address.
|
java.lang.String |
getUserFirstname()
Returns the user First name.
|
int |
getUserFlags()
Returns the user Flags.
|
CmsUUID |
getUserLastModified()
Returns the userLastModified.
|
java.lang.String |
getUserLastname()
Returns the user Last name.
|
java.lang.String |
getUserName()
Returns the user Name.
|
java.lang.String |
getUserPassword()
Returns the user Password.
|
int |
getVersion()
Returns the version of the import implementation.
|
void |
importAccessControlEntries()
Imports an ACE from the current xml data.
|
void |
importData(CmsObject cms,
I_CmsReport report,
CmsImportParameters parameters)
Imports the data.
|
void |
importGroup()
Import the current group from xml data.
|
void |
importOrgUnit()
Imports the current organizational unit.
|
void |
importProject()
Imports the current project.
|
void |
importRelations()
Imports all relations from the current xml data.
|
void |
importResource()
Imports a resource from the current xml data.
|
void |
importResourceAll()
Imports the resource and access control entries.
|
void |
importResources(CmsObject cms,
java.lang.String importPath,
I_CmsReport report,
java.io.File importResource,
java.util.zip.ZipFile importZip,
org.dom4j.Document docXml)
Deprecated.
|
void |
importUser()
Imports a new user from the current xml data.
|
void |
importUserGroup(java.lang.String groupName)
Sets the current user as member of the given group.
|
void |
importUserInfo(java.lang.String infoName,
java.lang.String infoType,
java.lang.String infoValue)
Creates a new additional information entry for the current user.
|
void |
importUserRole(java.lang.String roleName)
Sets the current user as member of the given role.
|
void |
increaseCounter()
Increases the file counter.
|
void |
increaseTotalFiles()
Increases the total number of files.
|
boolean |
matches(CmsImportParameters parameters)
Checks if the file given as parameter matches this import version implementation.
|
static void |
parseLinks(CmsObject cms,
java.util.List<CmsResource> parseables,
I_CmsReport report)
Parses the links.
|
void |
rewriteParseables()
Rewrites all parseable files, to assure link check.
|
void |
setAceFlags(java.lang.String aceFlags)
Sets the aceFlags.
|
void |
setAcePermissionsAllowed(java.lang.String acePermissionsAllowed)
Sets the acePermissionsAllowed.
|
void |
setAcePermissionsDenied(java.lang.String acePermissionsDenied)
Sets the acePermissionsDenied.
|
void |
setAcePrincipalId(java.lang.String acePrincipalId)
Sets the acePrincipalId.
|
void |
setDateCreated(java.lang.String dateCreated)
Sets the dateCreated.
|
void |
setDateExpired(java.lang.String dateExpired)
Sets the dateExpired.
|
void |
setDateLastModified(java.lang.String dateLastModified)
Sets the dateLastModified.
|
void |
setDateReleased(java.lang.String dateReleased)
Sets the dateReleased.
|
protected void |
setDefaultsForEmptyResourceFields()
Fills the unset fields for an imported resource with default values.
|
void |
setDestination(java.lang.String destination)
Sets the destination.
|
void |
setFlags(java.lang.String flags)
Sets the flags.
|
void |
setGroupDescription(java.lang.String groupDescription)
Sets the group Description.
|
void |
setGroupFlags(java.lang.String groupFlags)
Sets the group Flags.
|
void |
setGroupName(java.lang.String groupName)
Sets the group Name.
|
void |
setGroupParent(java.lang.String groupParent)
Sets the group Parent.
|
void |
setMembership()
Sets the membership information that could not been set immediately,
because of import order issues.
|
void |
setOrgUnitDescription(java.lang.String orgUnitDescription)
Sets the organizational unit description.
|
void |
setOrgUnitFlags(java.lang.String orgUnitFlags)
Sets the organizational unit flags.
|
void |
setOrgUnitName(java.lang.String orgUnitName)
Sets the organizational unit name.
|
void |
setProjectDescription(java.lang.String projectDescription)
Sets the project Description.
|
void |
setProjectManagers(java.lang.String projectManagers)
Sets the project Managers group name.
|
void |
setProjectName(java.lang.String projectName)
Sets the project Name.
|
void |
setProjectUsers(java.lang.String projectUsers)
Sets the project Users group name.
|
void |
setPropertyName(java.lang.String propertyName)
Sets the propertyName.
|
void |
setPropertyValue(java.lang.String propertyValue)
Sets the propertyValue.
|
void |
setRelationId(java.lang.String relationId)
Sets the relationId.
|
void |
setRelationPath(java.lang.String relationPath)
Sets the relationPath.
|
void |
setRelationType(java.lang.String relationType)
Sets the relationType.
|
void |
setResourceId(java.lang.String resourceId)
Sets the resourceId.
|
void |
setSource(java.lang.String source)
Sets the source.
|
void |
setStructureId(java.lang.String structureId)
Sets the structureId.
|
void |
setThrowable(java.lang.Throwable throwable)
Sets the throwable.
|
void |
setType(java.lang.String typeName)
Sets the type.
|
void |
setUserCreated(CmsUUID userCreated)
Sets the user Created.
|
void |
setUserCreated(java.lang.String userCreated)
Sets the userCreated.
|
void |
setUserDateCreated(java.lang.String userDateCreated)
Sets the user Date Created.
|
void |
setUserEmail(java.lang.String userEmail)
Sets the user email address.
|
void |
setUserFirstname(java.lang.String userFirstname)
Sets the user First name.
|
void |
setUserFlags(java.lang.String userFlags)
Sets the user Flags.
|
void |
setUserLastModified(CmsUUID userLastModified)
Sets the user Last Modified.
|
void |
setUserLastModified(java.lang.String userLastModified)
Sets the userLastModified.
|
void |
setUserLastname(java.lang.String userLastname)
Sets the user Last name.
|
void |
setUserName(java.lang.String userName)
Sets the user Name.
|
void |
setUserPassword(java.lang.String userPassword)
Sets the user Password.
|
void |
setVersion(java.lang.String version)
Sets the export version from the manifest file.
|
protected static void |
sortParseableResources(java.util.List<CmsResource> parseables)
Sorts the parsealble resources before we actually parse the links.
|
public static final java.lang.String A_NAME
public static final java.lang.String A_TYPE
public static final java.lang.String DTD_FILENAME
public static final java.lang.String DTD_LOCATION
public static final int IMPORT_VERSION10
public static final java.lang.String N_ACCESSCONTROL_ALLOWEDPERMISSIONS
public static final java.lang.String N_ACCESSCONTROL_DENIEDPERMISSIONS
public static final java.lang.String N_ACCESSCONTROL_ENTRIES
public static final java.lang.String N_ACCESSCONTROL_ENTRY
public static final java.lang.String N_ACCESSCONTROL_PERMISSIONSET
public static final java.lang.String N_ACCESSCONTROL_PRINCIPAL
public static final java.lang.String N_ACCOUNTS
public static final java.lang.String N_DATECREATED
public static final java.lang.String N_DATEEXPIRED
public static final java.lang.String N_DATELASTMODIFIED
public static final java.lang.String N_DATERELEASED
public static final java.lang.String N_DESCRIPTION
public static final java.lang.String N_DESTINATION
public static final java.lang.String N_EMAIL
public static final java.lang.String N_FILE
public static final java.lang.String N_FILES
public static final java.lang.String N_FIRSTNAME
public static final java.lang.String N_FLAGS
public static final java.lang.String N_GROUP
public static final java.lang.String N_GROUPS
public static final java.lang.String N_ID
public static final java.lang.String N_LASTNAME
public static final java.lang.String N_MANAGERSGROUP
public static final java.lang.String N_NAME
public static final java.lang.String N_ORGUNIT
public static final java.lang.String N_ORGUNITS
public static final java.lang.String N_PARENTGROUP
public static final java.lang.String N_PASSWORD
public static final java.lang.String N_PATH
public static final java.lang.String N_PROJECT
public static final java.lang.String N_PROJECTS
public static final java.lang.String N_PROPERTIES
public static final java.lang.String N_PROPERTY
public static final java.lang.String N_RELATION
CmsImportExportManager.EXPORT_MANIFEST for the "relation" node, starts a relation for a VFS resource.public static final java.lang.String N_RELATIONS
public static final java.lang.String N_RESOURCE
public static final java.lang.String N_RESOURCES
public static final java.lang.String N_SOURCE
public static final java.lang.String N_TYPE
public static final java.lang.String N_USER
public static final java.lang.String N_USERCREATED
public static final java.lang.String N_USERGROUP
public static final java.lang.String N_USERGROUPS
public static final java.lang.String N_USERINFO
public static final java.lang.String N_USERINFO_ENTRY
public static final java.lang.String N_USERLASTMODIFIED
public static final java.lang.String N_USERROLE
public static final java.lang.String N_USERROLES
public static final java.lang.String N_USERS
public static final java.lang.String N_USERSGROUP
public static final java.lang.String N_UUIDRESOURCE
public static final java.lang.String N_UUIDSTRUCTURE
public static final java.lang.String N_VALUE
public static final java.lang.String PROPERTY_ATTRIB_TYPE_SHARED
protected static final long DATE_CREATED_UNSPECIFIED
protected static final long DATE_LAST_MODIFICATION_FILETIME
protected static final long DATE_LAST_MODIFICATION_UNSPECIFIED
protected int m_aceFlags
protected int m_acePermissionsAllowed
protected int m_acePermissionsDenied
protected CmsUUID m_acePrincipalId
protected java.util.List<CmsAccessControlEntry> m_aces
protected java.util.Set<CmsUUID> m_contentFiles
protected java.lang.String m_destination
protected int m_fileCounter
protected java.lang.String m_groupDescription
protected int m_groupFlags
protected java.lang.String m_groupName
protected java.lang.String m_groupParent
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> m_groupParents
protected boolean m_hasDateLastModified
protected boolean m_hasStructureId
protected CmsImportHelper m_helper
protected java.util.List<java.lang.String> m_ignoredProperties
protected java.util.List<java.lang.String> m_immutables
protected boolean m_importACEs
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> m_membership
protected CmsOrganizationalUnit m_orgUnit
protected java.lang.String m_orgUnitDescription
protected int m_orgUnitFlags
protected java.lang.String m_orgUnitName
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> m_orgUnitResources
protected CmsImportParameters m_parameters
protected java.util.List<CmsResource> m_parseables
protected java.lang.String m_projectDescription
protected java.lang.String m_projectManagers
protected java.lang.String m_projectName
protected java.util.List<java.lang.String> m_projectResources
protected java.lang.String m_projectUsers
protected java.util.Map<java.lang.String,CmsProperty> m_properties
protected java.lang.String m_propertyName
protected java.lang.String m_propertyValue
protected CmsUUID m_relationId
protected java.lang.String m_relationPath
protected java.util.List<CmsImportVersion10.RelationData> m_relationsForResource
protected CmsRelationType m_relationType
protected I_CmsReport m_report
protected CmsResource m_resource
protected CmsResourceBuilder m_resourceBuilder
protected java.lang.String m_source
protected java.lang.Throwable m_throwable
protected int m_totalFiles
protected long m_userDateCreated
protected java.lang.String m_userEmail
protected java.lang.String m_userFirstname
protected int m_userFlags
protected java.util.Map<java.lang.String,java.lang.Object> m_userInfos
protected java.lang.String m_userLastname
protected java.lang.String m_userName
protected java.lang.String m_userPassword
protected int m_version
public CmsImportVersion10()
public static void parseLinks(CmsObject cms, java.util.List<CmsResource> parseables, I_CmsReport report)
cms - the CMS context to useparseables - the list of resources for which to parse the linksreport - the reportprotected static void sortParseableResources(java.util.List<CmsResource> parseables)
This is needed because we may, for example, have resources A and B such that A has a link to B, and B requires the relation corresponding to that link to be present for some functionality (e.g. the page_title macro in gallery name mappings), so we need to parse the links for A first to create the relation before B is processed.
parseables - the list of parseable resources which should be sorted in placepublic void addAccessControlEntry()
addResourceAceRules(Digester, String)public void addContentFile(java.lang.String source, java.lang.String resourceId)
source - the path in the zip fileresourceId - the resource idpublic void addOrgUnitResource(java.lang.String resourceName)
resourceName - the resource name to addpublic void addProjectResource(java.lang.String resourceName)
resourceName - the resource name to addpublic void addProperty()
public void addProperty(java.lang.String propertyType)
propertyType - the type of the property to be addedaddResourcePropertyRules(Digester, String)public void addRelation()
public void addXmlDigesterRules(org.apache.commons.digester3.Digester digester)
digester - the digester to add the rules topublic void addXmlPreprocessingDigesterRules(org.apache.commons.digester3.Digester digester)
digester - the digester to add the rules topublic void associateOrgUnitResources()
This is a global process that occurs only once at the end of the import, after all resources have been imported, to make sure that the resources of the organizational units are available.
public int getAceFlags()
N_FLAGS,
addResourceAceRules(Digester, String)public int getAcePermissionsAllowed()
N_ACCESSCONTROL_ALLOWEDPERMISSIONS,
addResourceAceRules(Digester, String)public int getAcePermissionsDenied()
N_ACCESSCONTROL_DENIEDPERMISSIONS,
addResourceAceRules(Digester, String)public CmsUUID getAcePrincipalId()
N_ACCESSCONTROL_PRINCIPAL,
addResourceAceRules(Digester, String)public long getDateCreated()
N_DATECREATED,
addResourceAttributesRules(Digester, String)public long getDateExpired()
N_DATEEXPIRED,
addResourceAttributesRules(Digester, String)public long getDateLastModified()
N_DATELASTMODIFIED,
addResourceAttributesRules(Digester, String)public long getDateReleased()
N_DATERELEASED,
addResourceAttributesRules(Digester, String)public java.lang.String getDestination()
N_DESTINATION,
addResourceAttributesRules(Digester, String)public int getFlags()
N_FLAGS,
addResourceAttributesRules(Digester, String)public java.lang.String getGroupDescription()
public int getGroupFlags()
public java.lang.String getGroupName()
public java.lang.String getGroupParent()
public java.lang.String getOrgUnitDescription()
public int getOrgUnitFlags()
public java.lang.String getOrgUnitName()
public java.lang.String getProjectDescription()
public java.lang.String getProjectManagers()
public java.lang.String getProjectName()
public java.lang.String getProjectUsers()
public java.lang.String getPropertyName()
N_NAME,
addResourcePropertyRules(Digester, String)public java.lang.String getPropertyValue()
N_VALUE,
addResourcePropertyRules(Digester, String)public CmsUUID getRelationId()
N_ID,
addResourceRelationRules(Digester, String)public java.lang.String getRelationPath()
N_PATH,
addResourceRelationRules(Digester, String)public CmsRelationType getRelationType()
N_TYPE,
addResourceRelationRules(Digester, String)public I_CmsReport getReport()
public CmsRequestContext getRequestContext()
public CmsUUID getResourceId()
N_UUIDRESOURCE,
addResourceAttributesRules(Digester, String)public java.lang.String getSource()
N_SOURCE,
addResourceAttributesRules(Digester, String)public CmsUUID getStructureId()
N_UUIDSTRUCTURE,
addResourceAttributesRules(Digester, String)public java.lang.Throwable getThrowable()
public I_CmsResourceType getType()
N_TYPE,
addResourceAttributesRules(Digester, String)public CmsUUID getUserCreated()
N_USERCREATED,
addResourceAttributesRules(Digester, String)public long getUserDateCreated()
public java.lang.String getUserEmail()
public java.lang.String getUserFirstname()
public int getUserFlags()
public CmsUUID getUserLastModified()
N_USERLASTMODIFIED,
addResourceAttributesRules(Digester, String)public java.lang.String getUserLastname()
public java.lang.String getUserName()
public java.lang.String getUserPassword()
public int getVersion()
I_CmsImport
getVersion in interface I_CmsImportI_CmsImport.getVersion()public void importAccessControlEntries()
addResourceAceRules(Digester, String)public void importData(CmsObject cms, I_CmsReport report, CmsImportParameters parameters)
I_CmsImportimportData in interface I_CmsImportcms - the current users OpenCms contextreport - a report object to output the progress information toparameters - the parameters to use during the importI_CmsImport.importData(CmsObject, I_CmsReport, CmsImportParameters)public void importGroup()
public void importOrgUnit()
public void importProject()
public void importRelations()
This is a global process that occurs only once at the end of the import, after all resources have been imported, to make sure that both resources of the relations are available.
public void importResource()
public void importResourceAll()
@Deprecated public void importResources(CmsObject cms, java.lang.String importPath, I_CmsReport report, java.io.File importResource, java.util.zip.ZipFile importZip, org.dom4j.Document docXml)
importData(CmsObject, I_CmsReport, CmsImportParameters) insteadI_CmsImportimportResources in interface I_CmsImportcms - the current users OpenCms contextimportPath - the path in the OpenCms VFS to import intoreport - a report object to output the progress information toimportResource - the import-resource (folder) to load resources fromimportZip - the import-resource (zip) to load resources fromdocXml - the manifest.xml file which contains the meta information of the imported filesI_CmsImport.importResources(org.opencms.file.CmsObject, java.lang.String, org.opencms.report.I_CmsReport, java.io.File, java.util.zip.ZipFile, org.dom4j.Document)public void importUser()
public void importUserGroup(java.lang.String groupName)
It can happen that the organizational unit has not been imported jet, in this case, the data is kept for later.
groupName - the name of the group to setsetMembership()public void importUserInfo(java.lang.String infoName, java.lang.String infoType, java.lang.String infoValue)
infoName - the name of the additional information entryinfoType - the type of the additional information entryinfoValue - the value of the additional information entrypublic void importUserRole(java.lang.String roleName)
It can happen that the organizational unit has not been imported jet, in this case, the data is kept for later.
roleName - the name of the role to setsetMembership()public void increaseCounter()
public void increaseTotalFiles()
public boolean matches(CmsImportParameters parameters) throws CmsImportExportException
I_CmsImportmatches in interface I_CmsImportparameters - the parameters to use during matchingtrue if the file can be imported by this import version implementationCmsImportExportException - if something goes wrongI_CmsImport.matches(org.opencms.importexport.CmsImportParameters)public void rewriteParseables()
This is a global process, that is executed only once at the end of the import to be sure that all link targets are available.
addXmlDigesterRules(Digester)public void setAceFlags(java.lang.String aceFlags)
aceFlags - the aceFlags to setN_FLAGS,
addResourceAceRules(Digester, String)public void setAcePermissionsAllowed(java.lang.String acePermissionsAllowed)
acePermissionsAllowed - the acePermissionsAllowed to setN_ACCESSCONTROL_ALLOWEDPERMISSIONS,
addResourceAceRules(Digester, String)public void setAcePermissionsDenied(java.lang.String acePermissionsDenied)
acePermissionsDenied - the acePermissionsDenied to setN_ACCESSCONTROL_DENIEDPERMISSIONS,
addResourceAceRules(Digester, String)public void setAcePrincipalId(java.lang.String acePrincipalId)
acePrincipalId - the acePrincipalId to setN_ACCESSCONTROL_PRINCIPAL,
addResourceAceRules(Digester, String)public void setDateCreated(java.lang.String dateCreated)
dateCreated - the dateCreated to setN_DATECREATED,
addResourceAttributesRules(Digester, String)public void setDateExpired(java.lang.String dateExpired)
dateExpired - the dateExpired to setN_DATEEXPIRED,
addResourceAttributesRules(Digester, String)public void setDateLastModified(java.lang.String dateLastModified)
dateLastModified - the dateLastModified to setN_DATELASTMODIFIED,
addResourceAttributesRules(Digester, String)public void setDateReleased(java.lang.String dateReleased)
dateReleased - the dateReleased to setN_DATERELEASED,
addResourceAttributesRules(Digester, String)public void setDestination(java.lang.String destination)
destination - the destination to setN_DESTINATION,
addResourceAttributesRules(Digester, String)public void setFlags(java.lang.String flags)
flags - the flags to setN_FLAGS,
addResourceAttributesRules(Digester, String)public void setGroupDescription(java.lang.String groupDescription)
groupDescription - the description to setpublic void setGroupFlags(java.lang.String groupFlags)
groupFlags - the flags to setpublic void setGroupName(java.lang.String groupName)
groupName - the name to setpublic void setGroupParent(java.lang.String groupParent)
groupParent - the group Parent to setpublic void setMembership()
public void setOrgUnitDescription(java.lang.String orgUnitDescription)
orgUnitDescription - the description to setpublic void setOrgUnitFlags(java.lang.String orgUnitFlags)
orgUnitFlags - the flags to setpublic void setOrgUnitName(java.lang.String orgUnitName)
orgUnitName - the name to setpublic void setProjectDescription(java.lang.String projectDescription)
projectDescription - the description to setpublic void setProjectManagers(java.lang.String projectManagers)
projectManagers - the managers group to setpublic void setProjectName(java.lang.String projectName)
projectName - the name to setpublic void setProjectUsers(java.lang.String projectUsers)
projectUsers - the Users group to setpublic void setPropertyName(java.lang.String propertyName)
propertyName - the propertyName to setN_NAME,
addResourcePropertyRules(Digester, String)public void setPropertyValue(java.lang.String propertyValue)
propertyValue - the propertyValue to setN_VALUE,
addResourcePropertyRules(Digester, String)public void setRelationId(java.lang.String relationId)
relationId - the relationId to setN_ID,
addResourceRelationRules(Digester, String)public void setRelationPath(java.lang.String relationPath)
relationPath - the relationPath to setN_PATH,
addResourceRelationRules(Digester, String)public void setRelationType(java.lang.String relationType)
relationType - the relationType to setN_TYPE,
addResourceRelationRules(Digester, String)public void setResourceId(java.lang.String resourceId)
resourceId - the resourceId to setN_UUIDRESOURCE,
addResourceAttributesRules(Digester, String)public void setSource(java.lang.String source)
source - the source to setN_SOURCE,
addResourceAttributesRules(Digester, String)public void setStructureId(java.lang.String structureId)
structureId - the structureId to setN_UUIDSTRUCTURE,
addResourceAttributesRules(Digester, String)public void setThrowable(java.lang.Throwable throwable)
throwable - the throwable to setpublic void setType(java.lang.String typeName)
typeName - the type to setN_TYPE,
addResourceAttributesRules(Digester, String)public void setUserCreated(CmsUUID userCreated)
userCreated - the user Created to setpublic void setUserCreated(java.lang.String userCreated)
userCreated - the userCreated to setN_USERCREATED,
addResourceAttributesRules(Digester, String)public void setUserDateCreated(java.lang.String userDateCreated)
userDateCreated - the date to setpublic void setUserEmail(java.lang.String userEmail)
userEmail - the email address to setpublic void setUserFirstname(java.lang.String userFirstname)
userFirstname - the first name to setpublic void setUserFlags(java.lang.String userFlags)
userFlags - the flags to setpublic void setUserLastModified(CmsUUID userLastModified)
userLastModified - the user Last Modified to setpublic void setUserLastModified(java.lang.String userLastModified)
userLastModified - the userLastModified to setN_USERLASTMODIFIED,
addResourceAttributesRules(Digester, String)public void setUserLastname(java.lang.String userLastname)
userLastname - the last name to setpublic void setUserName(java.lang.String userName)
userName - the name to setpublic void setUserPassword(java.lang.String userPassword)
userPassword - the password to setpublic void setVersion(java.lang.String version)
version - the export version to setprotected void addAccountsGroupRules(org.apache.commons.digester3.Digester digester, java.lang.String xpath)
digester - the digester to add the rules toxpath - the base xpath for the rulesprotected void addAccountsOrgunitRules(org.apache.commons.digester3.Digester digester, java.lang.String xpath)
digester - the digester to add the rules toxpath - the base xpath for the rulesprotected void addAccountsUserRules(org.apache.commons.digester3.Digester digester, java.lang.String xpath)
digester - the digester to add the rules toxpath - the base xpath for the rulesprotected void addProjectRules(org.apache.commons.digester3.Digester digester, java.lang.String xpath)
digester - the digester to add the rules toxpath - the base xpath for the rulesprotected void addResourceAceRules(org.apache.commons.digester3.Digester digester, java.lang.String xpath)
digester - the digester to add the rules toxpath - the base xpath for the rulesprotected void addResourceAttributesRules(org.apache.commons.digester3.Digester digester, java.lang.String xpath)
digester - the digester to add the rules toxpath - the base xpath for the rulesprotected void addResourcePropertyRules(org.apache.commons.digester3.Digester digester, java.lang.String xpath)
digester - the digester to add the rules toxpath - the base xpath for the rulesprotected void addResourceRelationRules(org.apache.commons.digester3.Digester digester, java.lang.String xpath)
digester - the digester to add the rules toxpath - the base xpath for the rulesprotected boolean checkImmutable(java.lang.String resourceName)
resourceName - the name of the resourcetrue or falseprotected java.lang.String convertDigestEncoding(java.lang.String value)
value - the digest value in the legacy encodingprotected long convertTimestamp(java.lang.String timestamp)
The time stamp is either the string representation of a long value (old export format) or a user-readable string format.
timestamp - time stamp to convertprotected CmsResource createResourceObjectFromFields(java.lang.String translatedName, int size)
translatedName - the resource namesize - the sizeprotected void findContentFiles() throws CmsImportExportException, java.io.IOException, org.xml.sax.SAXException
CmsImportExportException - thrown when the manifest.xml can't be opened as stream.java.io.IOException - thrown if the manifest.xml stream causes problems during parsing and/or closing.org.xml.sax.SAXException - thrown if parsing the manifest.xml failsprotected CmsImportHelper getHelper()
protected java.util.List<java.lang.String> getIgnoredProperties()
protected java.util.List<java.lang.String> getImmutableResources()
protected void setDefaultsForEmptyResourceFields() throws CmsImportExportException
CmsImportExportException - if something goes wrong