FTPS Source
Provided by: "Apache Software Foundation"
Support Level for this Kamelet is: "Stable"
Receive data from an FTPS server.
Configuration Options
The following table summarizes the configuration options available for the ftps-source
Kamelet:
Property | Name | Description | Type | Default | Example |
---|---|---|---|---|---|
Connection Host | Required The hostname of the FTPS server. | string | |||
Connection Port | Required The port of the FTPS server. | string | 21 | ||
Directory Name | Required The starting directory. | string | |||
Password | Required The password to access the FTPS server. | string | |||
Username | Required The username to access the FTPS server. | string | |||
Autocreate Missing Directories | Automatically create starting directory. | boolean | true | ||
Binary | Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). | boolean | false | ||
Delete | If true, the file is deleted after it is processed successfully. | boolean | false | ||
Idempotency | Skip already-processed files. | boolean | true | ||
Passive Mode | Specifies to use passive mode connection. | boolean | false | ||
Recursive | If a directory, look for files in all sub-directories as well. | boolean | false |
Dependencies
At runtime, the ftps-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:ftps-source"
parameters:
.
.
.
steps:
- to:
uri: "kamelet:log-sink"
You can now run it directly through the following command
camel run route.yaml
FTPS Source Kamelet Description
Authentication
This Kamelet requires username and password authentication to access the FTPS server. FTPS provides FTP with SSL/TLS encryption for secure file transfer. The credentials are configured through the username
and password
properties.
Configuration
The FTPS Source Kamelet supports the following configurations:
-
Connection Host: The hostname or IP address of the FTPS server (required)
-
Connection Port: The port number of the FTPS server (default: 21)
-
Username: Username for FTPS authentication (required)
-
Password: Password for FTPS authentication (required)
-
Directory Name: The starting directory path on the FTPS server (required)
-
Passive Mode: Use passive mode for FTPS connections (default: false)
-
Recursive: Process files in subdirectories (default: false)
-
Idempotent: Skip already-processed files (default: true)
-
Binary: Use binary transfer mode instead of ASCII (default: false)
-
Auto Create: Automatically create the starting directory if it doesn’t exist (default: true)
-
Delete: Delete files after successful processing (default: false)
Output Format
The Kamelet outputs file content as an InputStream
and sets headers with file information: - file
: The name of the processed file - ce-file
: Cloud Events compatible file name header
Security
FTPS provides enhanced security over standard FTP by encrypting the connection using SSL/TLS. This ensures that credentials and data are transmitted securely.
Usage Example
- route:
from:
uri: "kamelet:ftps-source"
parameters:
connectionHost: "ftps.example.com"
connectionPort: "21"
username: "ftpsuser"
password: "ftpspass"
directoryName: "/secure-incoming"
steps:
- to:
uri: "kamelet:log-sink"
Example with Passive Mode and Binary Transfer
- route:
from:
uri: "kamelet:ftps-source"
parameters:
connectionHost: "ftps.example.com"
connectionPort: "990"
username: "ftpsuser"
password: "ftpspass"
directoryName: "/data"
passiveMode: true
binary: true
recursive: true
steps:
- to:
uri: "kamelet:log-sink"
This example uses port 990 (common for implicit FTPS), enables passive mode, binary transfer, and recursive directory processing.