SmbFetcher

Server Message Block (SMB, CIFS, Samba, Windows share) fetcher.

crawler/fsJavadoc: SmbFetcher

Notes

Fetches documents from SMB/CIFS network shares (Windows shares, Samba). Supports domain credentials, optional ACL metadata collection, and reference-level filtering.

Examples

YAML

class: SmbFetcher
credentials:
  username: joe
  password: joe's-password
domain: WORKGROUP

JSON

{
  "class": "SmbFetcher",
  "credentials": {
    "username": "joe",
    "password": "joe's-password"
  },
  "domain": "WORKGROUP"
}

XML

<class>SmbFetcher</class>
<credentials>
  <username>joe</username>
  <password>joe's-password</password>
</credentials>
<domain>WORKGROUP</domain>

Usage

Full configuration skeleton, with every option and its default

YAML

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

JSON

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

XML

<smbFetcher>
  <class>SmbFetcher</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>
</smbFetcher>

Properties

Property	Type	Required	Default
aclDisabled	boolean	No	false
credentials	Credentials	No	Credentials
domain	string	No	-
referenceFilters	ReferenceFilter[]	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 SMB/CIFS share.

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.