Package org.apache.manifoldcf.crawler.connectors.DCTM

Class DCTM.SpecInfo

  • Enclosing class:
    DCTM
    protected class DCTM.SpecInfo
extends java.lang.Object
    This class digests specifications and allows easy access to the data within.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.Set<java.lang.String> aclSet
      A set of forced acls
      protected MatchMap matchMap
      The path name map
      protected java.util.Set<java.lang.String> mimeTypeSet
      Set of allowed mime types; null if all are allowed
      protected java.lang.String pathAttributeName
      The path attribute name
      protected java.util.Map<java.lang.String,​java.lang.String[]> pathMap
      The folder ID to path name mapping (which acts like a cache).
      protected java.util.Set<java.lang.String> pathSet
      Set of allowed paths
      protected boolean securityOn
      Security on/off
      protected java.util.Map<java.lang.String,​java.util.List<java.lang.String>> typeMap
      Map of type to selected attributes

    • Constructor Summary

      Constructors 
      Constructor Description
      SpecInfo​(org.apache.manifoldcf.core.interfaces.Specification spec)
      Constructor

    • Field Detail

      • pathAttributeName

        protected final java.lang.String pathAttributeName
        The path attribute name

      • pathMap

        protected final java.util.Map<java.lang.String,​java.lang.String[]> pathMap
        The folder ID to path name mapping (which acts like a cache). The key is the folder ID, and the value is an array of Strings.

      • matchMap

        protected final MatchMap matchMap
        The path name map

      • aclSet

        protected final java.util.Set<java.lang.String> aclSet
        A set of forced acls

      • securityOn

        protected final boolean securityOn
        Security on/off

      • typeMap

        protected final java.util.Map<java.lang.String,​java.util.List<java.lang.String>> typeMap
        Map of type to selected attributes

      • pathSet

        protected final java.util.Set<java.lang.String> pathSet
        Set of allowed paths

      • mimeTypeSet

        protected final java.util.Set<java.lang.String> mimeTypeSet
        Set of allowed mime types; null if all are allowed

    • Constructor Detail

      • SpecInfo

        public SpecInfo​(org.apache.manifoldcf.core.interfaces.Specification spec)
         throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        Constructor
        Throws:
        org.apache.manifoldcf.core.interfaces.ManifoldCFException
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption

    • Method Detail

      • getPathAttributeName

        public java.lang.String getPathAttributeName()
        Get the path attribute name.
        Returns:
        the path attribute name, or null if none specified.

      • getPathAttributeValue

        public java.lang.String[] getPathAttributeValue​(IDocumentumObject object)
                                         throws DocumentumException,
                                                java.rmi.RemoteException,
                                                org.apache.manifoldcf.core.interfaces.ManifoldCFException
        Given an identifier, get the array of translated strings that goes into the metadata.
        Throws:
        DocumentumException
        java.rmi.RemoteException
        org.apache.manifoldcf.core.interfaces.ManifoldCFException

      • pathMatches

        public boolean pathMatches​(java.lang.String[] documentPaths)
        Check if a set of paths contains one that matches the spec.
        Parameters:
        documentPaths - is the set of paths the document has.
        Returns:
        true if it does, false if not.

      • contentTypeMatches

        public boolean contentTypeMatches​(java.lang.String contentType)
        Check if a document content type matches the spec.
        Parameters:
        contentType - is the mime type that the document has.
        Returns:
        true if it does, false if not.

      • getAcls

        public java.lang.String[] getAcls()
        Grab forced acl out of document specification.
        Returns:
        the acls.

      • getForcedAclString

        public java.lang.String getForcedAclString()

      • getMetadataFields

        public java.util.List<java.lang.String> getMetadataFields​(java.lang.String typeName)

      • getMetadataVersionAddendum

        public java.lang.String getMetadataVersionAddendum​(java.lang.String typeName)

      • getPathNameAttributeAddendum

        public java.lang.String getPathNameAttributeAddendum()