CmisFetcher

CMIS-enabled Content Management Systems (CMS) fetcher (Atom).

crawler/fsJavadoc: CmisFetcher

Notes

Fetches documents from CMIS-enabled Content Management Systems (CMS) using the CMIS Atom binding protocol. Supports credentials, optional repository selection, and storing the raw XML response in a document field.

Compatible repositories:

• Any repository exposing CMIS 1.0 or 1.1 over its Atom binding — Alfresco, Nuxeo, OpenText Content Server, Documentum, IBM FileNet and others. See Content Sources.

Current limitations:

• SOURCE_DELTA source-native change feed behavior is not implemented for CMIS in this v1 hardening slice.
• Incremental behavior for CMIS currently relies on crawler scan semantics.

Examples

Basic CMIS Atom endpoint:

YAML

class: CmisFetcher
credentials:
  username: cmis-user
  password: <password>

JSON

{
  "class": "CmisFetcher",
  "credentials": {
    "username": "cmis-user",
    "password": "<password>"
  }
}

XML

<class>CmisFetcher</class>
<credentials>
  <username>cmis-user</username>
  <password>&lt;password&gt;</password>
</credentials>

Use a start reference such as:

cmis:http://your-host:8080/cmis/atom

CMIS Atom endpoint with non-root start path:

YAML

class: CmisFetcher
repositoryId: my-repo
aclDisabled: false

JSON

{
  "class": "CmisFetcher",
  "repositoryId": "my-repo",
  "aclDisabled": false
}

XML

<class>CmisFetcher</class>
<repositoryId>my-repo</repositoryId>
<aclDisabled>false</aclDisabled>

Use a start reference such as:

cmis:http://your-host:8080/cmis/atom!/Sites/Finance

Usage

Full configuration skeleton, with every option and its default

YAML

class: CmisFetcher
aclDisabled: false
credentials:
  password: string
  passwordKey:
    size: 0
    source: KEY
    value: string
  username: string
domain: string
referenceFilters: []
repositoryId: string
xmlTargetField: string

JSON

{
  "class": "CmisFetcher",
  "aclDisabled": false,
  "credentials": {
    "password": "string",
    "passwordKey": {
      "size": 0,
      "source": "KEY",
      "value": "string"
    },
    "username": "string"
  },
  "domain": "string",
  "referenceFilters": [],
  "repositoryId": "string",
  "xmlTargetField": "string"
}

XML

<cmisFetcher>
  <class>CmisFetcher</class>
  <aclDisabled>false</aclDisabled>
  <credentials>
    <password>string</password>
    <passwordKey>
      <size>0</size>
      <source>KEY</source>
      <value>string</value>
    </passwordKey>
    <username>string</username>
  </credentials>
  <domain>string</domain>
  <referenceFilters>
    <referenceFilter/>
  </referenceFilters>
  <repositoryId>string</repositoryId>
  <xmlTargetField>string</xmlTargetField>
</cmisFetcher>

Properties

Property	Type	Required	Default
aclDisabled	boolean	No	false
credentials	Credentials	No	Credentials
domain	string	No	-
referenceFilters	ReferenceFilter[]	No	-
repositoryId	string	No	-
xmlTargetField	string	No	-

Property Details

aclDisabled

When enabled, Access Control List (ACL) permissions are not applied or forwarded to the target system.

credentials

Username and password used to authenticate with the CMIS endpoint.

domain

The domain name for authentication when accessing the remote resource.

referenceFilters

Filters applied to document references (URLs or file paths) to control which ones are fetched. Documents whose references do not pass the filters are skipped.

repositoryId

The CMIS repository ID. Defaults to first one found.

xmlTargetField

The name of the field where the raw XML obtained from the CMIS REST API will be stored. Default: does not store the raw XML in a field.