FTP Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Receive data from an FTP server.

Configuration Options

The following table summarizes the configuration options available for the ftp-source Kamelet:

Property	Name	Description	Type	Default
connectionHost	Connection Host	Required The hostname of the FTP server.	string
connectionPort	Connection Port	Required The port of the FTP server.	string	21
directoryName	Directory Name	Required The starting directory.	string
password	Password	Required The password to access the FTP server.	string
username	Username	Required The username to access the FTP server.	string
autoCreate	Autocreate Missing Directories	Automatically create starting directory.	boolean	true
binary	Binary	Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false).	boolean	false
delete	Delete	If true, the file is deleted after it is processed successfully.	boolean	false
idempotent	Idempotency	Skip already-processed files.	boolean	true
passiveMode	Passive Mode	Specifes to use passive mode connection.	boolean	false
recursive	Recursive	If a directory, look for files in all the sub-directories as well.	boolean	false

Property

Name

Description

Type

Default

Example

connectionHost

Connection Host

Required The hostname of the FTP server.

string

connectionPort

Connection Port

Required The port of the FTP server.

string

directoryName

Directory Name

Required The starting directory.

string

password

Password

Required The password to access the FTP server.

string

username

Username

Required The username to access the FTP server.

string

autoCreate

Autocreate Missing Directories

Automatically create starting directory.

boolean

true

binary

Binary

Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false).

boolean

false

delete

Delete

If true, the file is deleted after it is processed successfully.

boolean

false

idempotent

Idempotency

Skip already-processed files.

boolean

true

passiveMode

Passive Mode

Specifes to use passive mode connection.

boolean

false

recursive

Recursive

If a directory, look for files in all the sub-directories as well.

boolean

false

Dependencies

At runtime, the ftp-source Kamelet relies upon the presence of the following dependencies:

camel:ftp
camel:core
camel:kamelet

Camel JBang usage

Prerequisites

You’ve installed JBang.
You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:ftp-source"
      parameters:
        .
        .
        .
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/ftp-source.kamelet.yaml