Package org.opencms.cmis

Class CmsCmisRelationHelper

  • All Implemented Interfaces:
    I_CmsCmisObjectHelper
    public class CmsCmisRelationHelper
extends java.lang.Object
implements I_CmsCmisObjectHelper
    Helper class for CMIS CRUD operations on relation objects.

    Since CMIS requires any object to have an ID by which it is accessed, but OpenCms relations are not addressable by ids, we invent an artificial relation id string of the form REL_(SOURCE_ID)_(TARGET_ID)_(TYPE).

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CmsCmisRelationHelper.RelationKey
      A class which contains the necessary information to identify a relation object.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String RELATION_ID_PREFIX
      The prefix used to identify relation ids.
      static java.util.regex.Pattern RELATION_PATTERN
      The pattern which relation ids should match.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.apache.chemistry.opencmis.commons.data.Acl collectAcl​(CmsObject cms, CmsResource resource, boolean onlyBasic)
      Compiles the ACL for a relation.
      protected org.apache.chemistry.opencmis.commons.data.AllowableActions collectAllowableActions​(CmsObject cms, CmsResource file, CmsRelation relation)
      Collects the allowable actions for a relation.
      protected org.apache.chemistry.opencmis.commons.data.ObjectData collectObjectData​(CmsCmisCallContext context, CmsObject cms, CmsResource resource, CmsRelation relation, java.util.Set<java.lang.String> filter, boolean includeAllowableActions, boolean includeAcl)
      Fills in an ObjectData record.
      protected org.apache.chemistry.opencmis.commons.data.Properties collectProperties​(CmsObject cms, CmsResource resource, CmsRelation relation, java.util.Set<java.lang.String> orgfilter, org.apache.chemistry.opencmis.commons.impl.server.ObjectInfoImpl objectInfo)
      Gathers all base properties of a file or folder.
      protected static java.lang.String createKey​(CmsUUID source, CmsUUID target, java.lang.String relType)
      Creates a relation id string from the source and target ids and a relation type.
      protected java.lang.String createReadableName​(CmsRelation relation)
      Creates a user-readable name from the given relation object.
      void deleteObject​(CmsCmisCallContext context, java.lang.String objectId, boolean allVersions)
      Deletes a CMIS object.
      org.apache.chemistry.opencmis.commons.data.Acl getAcl​(CmsCmisCallContext context, java.lang.String objectId, boolean onlyBasicPermissions)
      Gets the ACL for an object.
      org.apache.chemistry.opencmis.commons.data.AllowableActions getAllowableActions​(CmsCmisCallContext context, java.lang.String objectId)
      Gets the allowable actions for an object.
      org.apache.chemistry.opencmis.commons.data.ObjectData getObject​(CmsCmisCallContext context, java.lang.String objectId, java.lang.String filter, boolean includeAllowableActions, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships, java.lang.String renditionFilter, boolean includePolicyIds, boolean includeAcl)
      Gets the data for a CMIS object.
      protected static CmsRelationType getRelationType​(java.lang.String typeName)
      Gets a relation type by name.
      protected CmsCmisRelationHelper.RelationKey parseRelationKey​(java.lang.String id)
      Extracts the source/target ids and the type from a relation id.

      • Methods inherited from class java.lang.Object

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