ListSmb

ListSmb 2.0.0

Bundle: org.apache.nifi | nifi-smb-nar
Description: Lists concrete files shared via SMB protocol. Each listed file may result in one flowfile, the metadata being written as flowfile attributes. Or - in case the 'Record Writer' property is set - the entire result is written as records to a single flowfile. This Processor is designed to run on Primary Node only in a cluster. If the primary node changes, the new Primary Node will pick up where the previous node left off without duplicating all of the data.
Tags: list, samba, smb, cifs, files
Input Requirement: FORBIDDEN
Supports Sensitive Dynamic Properties: false

Properties

Input Directory
The network folder from which to list files. This is the remaining relative path after the share: smb://HOSTNAME:PORT/SHARE/[DIRECTORY]/sub/directories. It is also possible to add subdirectories. The given path on the remote file share must exist. This can be checked using verification. You may mix Windows and Linux-style directory separators.

Display Name

Input Directory

Description

The network folder from which to list files. This is the remaining relative path after the share: smb://HOSTNAME:PORT/SHARE/[DIRECTORY]/sub/directories. It is also possible to add subdirectories. The given path on the remote file share must exist. This can be checked using verification. You may mix Windows and Linux-style directory separators.

API Name

directory

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Entity Tracking Initial Listing Target
Specify how initial listing should be handled. Used by 'Tracking Entities' strategy.
Display Name

Entity Tracking Initial Listing Target

Description

Specify how initial listing should be handled. Used by 'Tracking Entities' strategy.

API Name

et-initial-listing-target

Default Value

all

Allowable Values
- Tracking Time Window
- All Available
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Entity Tracking State Cache
Listed entities are stored in the specified cache storage so that this processor can resume listing across NiFi restart or in case of primary node change. 'Tracking Entities' strategy require tracking information of all listed entities within the last 'Tracking Time Window'. To support large number of entities, the strategy uses DistributedMapCache instead of managed state. Cache key format is 'ListedEntities::{processorId}(::{nodeId})'. If it tracks per node listed entities, then the optional '::{nodeId}' part is added to manage state separately. E.g. cluster wide cache key = 'ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b', per node cache key = 'ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b::nifi-node3' The stored cache content is Gzipped JSON string. The cache key will be deleted when target listing configuration is changed. Used by 'Tracking Entities' strategy.

Display Name

Entity Tracking State Cache

Description

Listed entities are stored in the specified cache storage so that this processor can resume listing across NiFi restart or in case of primary node change. 'Tracking Entities' strategy require tracking information of all listed entities within the last 'Tracking Time Window'. To support large number of entities, the strategy uses DistributedMapCache instead of managed state. Cache key format is 'ListedEntities::{processorId}(::{nodeId})'. If it tracks per node listed entities, then the optional '::{nodeId}' part is added to manage state separately. E.g. cluster wide cache key = 'ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b', per node cache key = 'ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b::nifi-node3' The stored cache content is Gzipped JSON string. The cache key will be deleted when target listing configuration is changed. Used by 'Tracking Entities' strategy.

API Name

et-state-cache

Service Interface

org.apache.nifi.distributed.cache.client.DistributedMapCacheClient

Service Implementations

org.apache.nifi.hazelcast.services.cacheclient.HazelcastMapCacheClient

org.apache.nifi.distributed.cache.client.MapCacheClientService

org.apache.nifi.redis.service.RedisDistributedMapCacheClientService

org.apache.nifi.redis.service.SimpleRedisDistributedMapCacheClientService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Entity Tracking Time Window
Specify how long this processor should track already-listed entities. 'Tracking Entities' strategy can pick any entity whose timestamp is inside the specified time window. For example, if set to '30 minutes', any entity having timestamp in recent 30 minutes will be the listing target when this processor runs. A listed entity is considered 'new/updated' and a FlowFile is emitted if one of following condition meets: 1. does not exist in the already-listed entities, 2. has newer timestamp than the cached entity, 3. has different size than the cached entity. If a cached entity's timestamp becomes older than specified time window, that entity will be removed from the cached already-listed entities. Used by 'Tracking Entities' strategy.

Display Name

Entity Tracking Time Window

Description

Specify how long this processor should track already-listed entities. 'Tracking Entities' strategy can pick any entity whose timestamp is inside the specified time window. For example, if set to '30 minutes', any entity having timestamp in recent 30 minutes will be the listing target when this processor runs. A listed entity is considered 'new/updated' and a FlowFile is emitted if one of following condition meets: 1. does not exist in the already-listed entities, 2. has newer timestamp than the cached entity, 3. has different size than the cached entity. If a cached entity's timestamp becomes older than specified time window, that entity will be removed from the cached already-listed entities. Used by 'Tracking Entities' strategy.

API Name

et-time-window

Default Value

3 hours

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
File Name Suffix Filter
Files ending with the given suffix will be omitted. Can be used to make sure that files that are still uploading are not listed multiple times, by having those files have a suffix and remove the suffix once the upload finishes. This is highly recommended when using 'Tracking Entities' or 'Tracking Timestamps' listing strategies.

Display Name

File Name Suffix Filter

Description

Files ending with the given suffix will be omitted. Can be used to make sure that files that are still uploading are not listed multiple times, by having those files have a suffix and remove the suffix once the upload finishes. This is highly recommended when using 'Tracking Entities' or 'Tracking Timestamps' listing strategies.

API Name

file-name-suffix-filter

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Listing Strategy
Specify how to determine new/updated entities. See each strategy descriptions for detail.
Display Name

Listing Strategy

Description

Specify how to determine new/updated entities. See each strategy descriptions for detail.

API Name

listing-strategy

Default Value

timestamps

Allowable Values
- Tracking Entities
- No Tracking
- Tracking Timestamps
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Maximum File Age
Any file older than the given value will be omitted.

Display Name

Maximum File Age

Description

Any file older than the given value will be omitted.

API Name

max-file-age

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Maximum File Size
Any file larger than the given value will be omitted.

Display Name

Maximum File Size

Description

Any file larger than the given value will be omitted.

API Name

max-file-size

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Minimum File Age
The minimum age that a file must be in order to be listed; any file younger than this amount of time will be ignored.

Display Name

Minimum File Age

Description

The minimum age that a file must be in order to be listed; any file younger than this amount of time will be ignored.

API Name

min-file-age

Default Value

5 secs

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Minimum File Size
Any file smaller than the given value will be omitted.

Display Name

Minimum File Size

Description

Any file smaller than the given value will be omitted.

API Name

min-file-size

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Record Writer
Specifies the Record Writer to use for creating the listing. If not specified, one FlowFile will be created for each entity that is listed. If the Record Writer is specified, all entities will be written to a single FlowFile instead of adding attributes to individual FlowFiles.

Display Name

Record Writer

Description

Specifies the Record Writer to use for creating the listing. If not specified, one FlowFile will be created for each entity that is listed. If the Record Writer is specified, all entities will be written to a single FlowFile instead of adding attributes to individual FlowFiles.

API Name

record-writer

Service Interface

org.apache.nifi.serialization.RecordSetWriterFactory

Service Implementations

org.apache.nifi.avro.AvroRecordSetWriter

org.apache.nifi.csv.CSVRecordSetWriter

org.apache.nifi.text.FreeFormTextRecordSetWriter

org.apache.nifi.json.JsonRecordSetWriter

org.apache.nifi.lookup.RecordSetWriterLookup

org.apache.nifi.record.script.ScriptedRecordSetWriter

org.apache.nifi.xml.XMLRecordSetWriter

Expression Language Scope

Not Supported

Sensitive

false

Required

false
SMB Client Provider Service
Specifies the SMB client provider to use for creating SMB connections.

Display Name

SMB Client Provider Service

Description

Specifies the SMB client provider to use for creating SMB connections.

API Name

smb-client-provider-service

Service Interface

org.apache.nifi.services.smb.SmbClientProviderService

Service Implementations

org.apache.nifi.services.smb.SmbjClientProviderService

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Target System Timestamp Precision
Specify timestamp precision at the target system. Since this processor uses timestamp of entities to decide which should be listed, it is crucial to use the right timestamp precision.
Display Name

Target System Timestamp Precision

Description

Specify timestamp precision at the target system. Since this processor uses timestamp of entities to decide which should be listed, it is crucial to use the right timestamp precision.

API Name

target-system-timestamp-precision

Default Value

auto-detect

Allowable Values
- Auto Detect
- Milliseconds
- Seconds
- Minutes
Expression Language Scope

Not Supported

Sensitive

false

Required

true

State Management

Scopes	Description
CLUSTER	After performing a listing of files, the state of the previous listing can be stored in order to list files continuously without duplication.

Relationships

Name	Description
success	All FlowFiles that are received are routed to success

Writes Attributes

Name	Description
filename	The name of the file that was read from filesystem.
shortName	The short name of the file that was read from filesystem.
path	The path is set to the relative path of the file's directory on the remote filesystem compared to the Share root directory. For example, for a given remote locationsmb://HOSTNAME:PORT/SHARE/DIRECTORY, and a file is being listed from smb://HOSTNAME:PORT/SHARE/DIRECTORY/sub/folder/file then the path attribute will be set to "DIRECTORY/sub/folder".
serviceLocation	The SMB URL of the share.
lastModifiedTime	The timestamp of when the file's content changed in the filesystem as 'yyyy-MM-dd'T'HH:mm:ss'.
creationTime	The timestamp of when the file was created in the filesystem as 'yyyy-MM-dd'T'HH:mm:ss'.
lastAccessTime	The timestamp of when the file was accessed in the filesystem as 'yyyy-MM-dd'T'HH:mm:ss'.
changeTime	The timestamp of when the file's attributes was changed in the filesystem as 'yyyy-MM-dd'T'HH:mm:ss'.
size	The size of the file in bytes.
allocationSize	The number of bytes allocated for the file on the server.