redb.Route.Ftp 2.0.2

redb.Route.Ftp

FTP/FTPS transport for the redb.Route ESB framework.
Polling consumer and atomic producer powered by FluentFTP — passive/active mode, FTPS (TLS), glob filtering, idempotency, temp-file upload, recursive directories, and jail-path protection.

Quick Start

// Poll remote FTP directory
.From(Ftp.Directory("/inbox")
    .Host("ftp.example.com")
    .Username("user").Password("secret")
    .Include("*.csv")
    .Delay(30000)
    .MoveTo("/inbox/archive")
    .Recursive()
    .Idempotent())

// Upload files atomically
.To(Ftp.Directory("/outbox")
    .Host("ftp.example.com")
    .Username("user").Password("secret")
    .TempPrefix(".uploading-")
    .AutoCreate())

// FTPS with passive mode
.From(Ftp.Directory("/secure")
    .Host("ftp.example.com")
    .UseFtps()
    .ValidateCertificate(false)
    .PassiveMode())

URI Format

ftp:///remote/path?host=server&port=21&username=admin&password=secret&param=value

The path part of the URI is the remote base directory. All other parameters go in the query string.

Consumer

The consumer polls a remote FTP directory at a configurable interval, delivers each file as an exchange, and then applies post-processing (delete / move / noop).

Polling Pipeline

1. Connect to FTP server
2. List files in the remote directory (optionally recursive)
3. Apply filters: glob include/exclude, min/max age, idempotency, done-file check
4. Sort results (by name, date, or size)
5. For each file: pre-move → read body → invoke processor → post-process
6. On failure: move file to moveFailed directory (if configured)

Consumer Headers

Post-Processing Modes

Only one mode can be active at a time.

Idempotency

Prevents re-processing the same file. Default key: "{fullPath}|{lastModifiedUtc}|{length}".

.From(Ftp.Directory("/inbox")
    .Host("ftp.example.com")
    .Idempotent()                          // default key
    .Idempotent(Constant("${file.name}"))) // custom key expression

Done Files

Only process a file when a companion "done" marker exists:

.From(Ftp.Directory("/inbox")
    .DoneFileName(Constant("${file:name}.done")))

Supports ${file:name} and ${file:name.noext} substitutions.

Producer

The producer uploads files to the FTP server using an atomic temp-file-then-rename strategy.

Write Pipeline

1. Resolve target file name (from options, header, or auto-generated GUID)
2. Validate path against jail directory
3. Create parent directories if autoCreate=true
4. Write body to a temp file (configurable prefix/name)
5. Handle existing file (Override / Append / Fail / Ignore / Move / TryRename)
6. Atomically rename temp file to target

File Name Resolution

Priority order:

1. FileName option (dynamic expression)
2. redbFtp.Name header
3. redbFile.Name header (generic file header)
4. Auto-generated: redb-{GUID}

File Exist Strategies

Move Existing Strategies

When FileExist=Move, the existing file is renamed with a suffix:

Jail Path Protection

By default (jailStartingDirectory=true), the producer rejects any path that resolves outside the base directory via .. traversal. Set JailStartingDirectory(false) to disable.

Flatten

When flatten=true, directory components in the file name are stripped — only the base name is used for the target path.

Producer Header

FTPS (FTP over TLS)

.From(Ftp.Directory("/secure")
    .Host("ftp.example.com")
    .UseFtps()                      // Explicit TLS
    .ValidateCertificate(false))    // Skip certificate validation

Uses FtpEncryptionMode.Explicit. Certificate validation is enabled by default.

Data Connection Mode

.From(Ftp.Directory("/data")
    .PassiveMode())   // default — AutoPassive

.From(Ftp.Directory("/data")
    .ActiveMode())    // AutoActive

Fluent Builder API

Most builder methods accept both constant values and IExpression for runtime resolution.

Configuration Reference

Connection

Reconnection

Consumer / Polling

Consumer / Post-Processing

Consumer / Idempotency

Consumer / Body

Producer

DI Registration

services.AddRedbRouteFtp();

Requirements

• .NET 8.0 / 9.0 / 10.0
• FluentFTP 54.1.0
• redb.Route.GenericFile (shared file transport abstractions)