Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 27. FTPS Source

Receive data from an FTPS server.

27.1. Configuration Options
Copy link

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

Expand
PropertyNameDescriptionTypeDefaultExample

connectionHost *

Connection Host

The hostname of the FTPS server.

string

  

connectionPort *

Connection Port

The port of the FTPS server.

string

21

 

directoryName *

Directory Name

The starting directory.

string

  

password *

Password

The password to access the FTPS server.

string

  

username *

Username

The username to access the FTPS 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

Specifies to use passive mode connection.

boolean

False

 

recursive

Recursive

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

boolean

False

 

* = Fields marked with an asterisk are mandatory.

27.2. Dependencies
Copy link

27.2.1. Quarkus dependencies
Copy link

<dependencies>
  <dependency>
    <groupId>org.apache.camel.kamelets</groupId>
    <artifactId>camel-kamelets-utils</artifactId>
    <version>4.8.5</version>
  </dependency>
  <dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-core</artifactId>
  </dependency>
  <dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-ftp</artifactId>
  </dependency>
  <dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-kamelet</artifactId>
  </dependency>
</dependencies>
Copy to Clipboard Toggle word wrap

27.3. Usage
Copy link

27.3.1. Camel JBang usage
Copy link

27.3.1.1. Prerequisites for JBang
Copy link

  • Install JBang.

  • You have executed the following command: 

    jbang app install camel@apache/camel
    Copy to Clipboard Toggle word wrap

27.3.1.2. Running a route with JBang
Copy link

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

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"
Copy to Clipboard Toggle word wrap

You can now run it directly through the following command. 

camel run route.yaml
Copy to Clipboard Toggle word wrap

27.3.2. Knative Source
Copy link

You can use the ftps-source Kamelet as a Knative source by binding it to a Knative object.

ftps-source-binding.yaml

apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: ftps-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: ftps-source
    properties:
      connectionHost: "The Connection Host"
      directoryName: "The Directory Name"
      password: "The Password"
      username: "The Username"
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
Copy to Clipboard Toggle word wrap

27.3.3. Kafka Source
Copy link

You can use the ftps-source Kamelet as a Kafka source by binding it to a Kafka topic.

ftps-source-binding.yaml

apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: ftps-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: ftps-source
    properties:
      connectionHost: "The Connection Host"
      directoryName: "The Directory Name"
      password: "The Password"
      username: "The Username"
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
Copy to Clipboard Toggle word wrap

27.4. Kamelets source file
Copy link

https://github.com/jboss-fuse/camel-kamelets/blob/camel-kamelets-4.10.3-branch/kamelets/ftps-source.kamelet.yaml

Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red HatBack to top