ftp-source/kamelet.json

{
  "apiVersion": "camel.apache.org/v1",
  "kind": "Kamelet",
  "metadata": {
    "name": "ftp-source",
    "annotations": {
      "camel.apache.org/kamelet.support.level": "Stable",
      "camel.apache.org/catalog.version": "4.22.1",
      "camel.apache.org/kamelet.icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOS4xLjAsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAyMjEuMSAzMDAiIHN0eWxlPSJlbmFibGUtYmFja2dyb3VuZDpuZXcgMCAwIDIyMS4xIDMwMDsiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPHN0eWxlIHR5cGU9InRleHQvY3NzIj4NCgkuc3Qwe2ZpbGw6IzgzMkVBQjt9DQoJLnN0MXtmaWxsOiNCQUJBQkE7fQ0KCS5zdDJ7ZmlsbDpub25lO30NCgkuc3Qze2ZpbGw6IzhEQzYzRjt9DQoJLnN0NHtmaWxsOiMwRjlCRDc7fQ0KCS5zdDV7ZmlsbDojRkZGRkZGO30NCgkuc3Q2e2ZpbGwtcnVsZTpldmVub2RkO2NsaXAtcnVsZTpldmVub2RkO2ZpbGw6I0ZGRkZGRjt9DQoJLnN0N3tmaWxsOiMxREExRjI7fQ0KCS5zdDh7ZmlsbDojM0Q1QTk4O30NCgkuc3Q5e2ZpbGw6IzIzMUYyMDt9DQoJLnN0MTB7ZmlsbDojMDA3QkI1O30NCgkuc3QxMXtmaWxsOiNEQzRFNDE7fQ0KCS5zdDEye2ZpbGwtcnVsZTpldmVub2RkO2NsaXAtcnVsZTpldmVub2RkO2ZpbGw6IzE4MTYxNjt9DQoJLnN0MTN7ZmlsbDojMTgxNjE2O30NCgkuc3QxNHtmaWxsOiNGMkYyRjI7fQ0KCS5zdDE1e2ZpbGw6I0UzRTNFMzt9DQoJLnN0MTZ7ZmlsbDojRDU0QjNEO30NCgkuc3QxN3tmaWxsOiNENzJCMjc7fQ0KCS5zdDE4e29wYWNpdHk6MC41NjtmaWxsOnVybCgjU1ZHSURfMV8pO30NCgkuc3QxOXtmaWxsOiM5MkQ0MDA7fQ0KCS5zdDIwe2ZpbGw6IzAwQjlFNDt9DQoJLnN0MjF7Zm9udC1mYW1pbHk6J09wZW5TYW5zLUJvbGQnO30NCgkuc3QyMntmb250LXNpemU6NDUuNDExNXB4O30NCgkuc3QyM3tmaWxsOiMyQjM5OTA7fQ0KCS5zdDI0e2ZpbGw6IzNGOUMzNTt9DQoJLnN0MjV7ZmlsbDojOEZDRUQ4O30NCgkuc3QyNntmaWxsOiNEMjFGMjE7fQ0KCS5zdDI3e2ZpbGw6I0Q2RDZENjt9DQoJLnN0Mjh7ZmlsbDojRjFGMUYxO30NCgkuc3QyOXtmaWxsOiNDMzIyNjU7fQ0KCS5zdDMwe2ZpbGw6IzhDMzEyMzt9DQoJLnN0MzF7ZmlsbDojRTA1MjQzO30NCgkuc3QzMntmaWxsOiM1RTFGMTg7fQ0KCS5zdDMze2ZpbGw6I0YyQjBBOTt9DQoJLnN0MzR7ZmlsbDojQ0FDQ0NFO30NCgkuc3QzNXtmaWxsOiNBMUFGREI7fQ0KCS5zdDM2e2ZpbGw6IzAwMjA4Nzt9DQo8L3N0eWxlPg0KPGc+DQoJPGc+DQoJCTxjaXJjbGUgY2xhc3M9InN0MjAiIGN4PSIxMTEuNiIgY3k9IjE5MS43IiByPSI4OC42Ii8+DQoJCTxnPg0KCQkJPHBhdGggY2xhc3M9InN0NSIgZD0iTTExMC42LDk5LjljLTUwLjgsMC05Mi4yLDQxLjQtOTIuMiw5Mi4yYzAsNTAuOSw0MS40LDkyLjIsOTIuMiw5Mi4yaDBjNTAuOCwwLDkyLjItNDEuNCw5Mi4yLTkyLjINCgkJCQlDMjAyLjgsMTQxLjMsMTYxLjQsOTkuOSwxMTAuNiw5OS45eiBNMTgzLjIsMTQzLjljLTcsNi44LTEzLjMsMTQuNC0xOC42LDIyLjdjLTAuNS0wLjEtMC45LTAuMi0xLjQtMC4yYy0xLDAtMS45LDAuMy0yLjgsMC43DQoJCQkJYy00LjYtNi41LTguNC0xMy4xLTExLjMtMTkuNmMxLjctMS4xLDIuOC0zLDIuOC01LjJjMC0wLjYtMC4xLTEuMS0wLjMtMS43YzYuMy00LjQsMTEuNy05LjMsMTYtMTQuMw0KCQkJCUMxNzMuNiwxMzEuNCwxNzguOCwxMzcuMywxODMuMiwxNDMuOXogTTY4LjgsMTY5LjFjNC44LTAuNSw5LjYtMS4yLDE0LjUtMmMxLDIsMy4xLDMuNCw1LjUsMy40aDBjMC44LDAsMS43LTAuMiwyLjQtMC41DQoJCQkJYzYuMiw4LjksMTMuNSwxNy4xLDIxLjgsMjQuNGM4LjcsNy42LDE4LjIsMTQsMjguMSwxOS4xYy0wLjEsMC41LTAuMiwxLTAuMiwxLjVjMCwyLjQsMS40LDQuNSwzLjQsNS41DQoJCQkJYy0xLjEsNy4yLTEuNiwxNC41LTEuNSwyMS42Yy0xLjIsMC4zLTIuMywwLjgtMy4yLDEuNmMtOS4zLTYuNi0xOS40LTEyLjItMzAuMS0xNi41Yy0xMi45LTUuMi0yNi4yLTguNC0zOS41LTkuNw0KCQkJCWMtMC44LTMuNS0zLjktNi4xLTcuNi02LjJjLTEtNi4zLTEuNS0xMi43LTEuNS0xOS4yYzAtNS40LDAuNC0xMC43LDEuMS0xNS45QzY1LjUsMTc1LjcsNjguMywxNzIuOCw2OC44LDE2OS4xeiBNNjQuNywxNjEuMg0KCQkJCWMyLjMtOC43LDUuNS0xNyw5LjctMjQuN2MyLjYsNy45LDYsMTUuNywxMC4yLDIzLjFjLTEuMSwxLTEuOCwyLjMtMiwzLjhjLTQuOCwwLjgtOS41LDEuNS0xNC4zLDEuOQ0KCQkJCUM2Ny43LDE2My42LDY2LjQsMTYyLjEsNjQuNywxNjEuMnogTTE0Ni41LDIwOC45Yy0xLjgsMC4yLTMuNCwxLjEtNC40LDIuNGMtOS43LTUtMTktMTEuMi0yNy42LTE4LjdjLTguMi03LjItMTUuMy0xNS4zLTIxLjQtMjQNCgkJCQljMS0xLDEuNi0yLjQsMS43LTMuOWMxNy40LTQuMSwzMy40LTEwLjMsNDYuNy0xNy44YzEuMSwxLDIuNSwxLjYsNC4xLDEuNmgwYzAuNCwwLDAuOCwwLDEuMi0wLjFjMi45LDYuOCw2LjgsMTMuNiwxMS42LDIwLjMNCgkJCQljLTAuOSwxLjEtMS41LDIuNS0xLjUsNGMwLDEuNiwwLjYsMy4xLDEuNyw0LjJjLTMuNyw3LTYuOSwxNC40LTkuMywyMi4yQzE0OC4yLDIwMi4zLDE0Ny4zLDIwNS42LDE0Ni41LDIwOC45eiBNMTQ0LjQsMTExLjcNCgkJCQljNy40LDMuMSwxNC4yLDcuMiwyMC40LDEyLjFjLTQuMSw0LjctOS4yLDkuMy0xNS4zLDEzLjVjLTEuMS0wLjgtMi40LTEuNC0zLjgtMS40Yy0wLjIsMC0wLjMsMC0wLjUsMC4xDQoJCQkJQzE0Mi45LDEyNy4zLDE0Mi41LDExOC45LDE0NC40LDExMS43eiBNMTEwLjYsMTA0LjljMTEuMSwwLDIxLjcsMi4xLDMxLjUsNS45Yy0yLjEsNy43LTEuNywxNi42LDAuNywyNS45Yy0yLDEtMy40LDMuMS0zLjQsNS41DQoJCQkJYzAsMC41LDAuMSwwLjksMC4yLDEuNGMtMTMsNy40LTI4LjcsMTMuNS00NS42LDE3LjVjLTEuMS0xLjgtM
      "camel.apache.org/provider": "Apache Software Foundation",
      "camel.apache.org/kamelet.group": "FTP",
      "camel.apache.org/kamelet.namespace": "File"
    },
    "labels": {
      "camel.apache.org/kamelet.type": "source"
    }
  },
  "spec": {
    "definition": {
      "title": "FTP Source",
      "description": "Receive data from an FTP server.",
      "required": [
        "connectionHost",
        "connectionPort",
        "username",
        "password",
        "directoryName"
      ],
      "type": "object",
      "properties": {
        "connectionHost": {
          "title": "Connection Host",
          "description": "The hostname of the FTP server.",
          "type": "string"
        },
        "connectionPort": {
          "title": "Connection Port",
          "description": "The port of the FTP server.",
          "type": "string",
          "default": 21
        },
        "username": {
          "title": "Username",
          "description": "The username to access the FTP server.",
          "type": "string",
          "x-descriptors": [
            "urn:camel:group:credentials"
          ]
        },
        "password": {
          "title": "Password",
          "description": "The password to access the FTP server.",
          "type": "string",
          "format": "password",
          "x-descriptors": [
            "urn:camel:group:credentials"
          ]
        },
        "directoryName": {
          "title": "Directory Name",
          "description": "The starting directory",
          "type": "string"
        },
        "passiveMode": {
          "title": "Passive Mode",
          "description": "Specifes to use passive mode connection.",
          "type": "boolean",
          "default": false
        },
        "recursive": {
          "title": "Recursive",
          "description": "If a directory, look for files in all the sub-directories as well.",
          "type": "boolean",
          "default": false
        },
        "idempotent": {
          "title": "Idempotency",
          "description": "Skip already-processed files.",
          "type": "boolean",
          "default": true
        },
        "binary": {
          "title": "Binary",
          "description": "Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false).",
          "type": "boolean",
          "default": false
        },
        "autoCreate": {
          "title": "Autocreate Missing Directories",
          "description": "Automatically create starting directory.",
          "type": "boolean",
          "default": true
        },
        "delete": {
          "title": "Delete",
          "description": "If true, the file is deleted after it is processed successfully.",
          "type": "boolean",
          "default": false
        }
      }
    },
    "dependencies": [
      "camel:ftp",
      "camel:core",
      "camel:kamelet"
    ],
    "template": {
      "from": {
        "uri": "ftp:{{username}}@{{connectionHost}}:{{connectionPort}}/{{directoryName}}",
        "parameters": {
          "password": "{{password}}",
          "passiveMode": "{{passiveMode}}",
          "recursive": "{{recursive}}",
          "idempotent": "{{idempotent}}",
          "binary": "{{binary}}",
          "autoCreate": "{{autoCreate}}",
          "delete": "{{delete}}"
        },
        "steps": [
          {
            "setHeader": {
              "name": "file",
              "simple": "${header[CamelFileName]}"
            }
          },
          {
            "setHeader": {
              "name": "ce-file",
              "simple": "${header[CamelFileName]}"
            }
          },
          {
            "convertBodyTo": {
              "type": "java.io.InputStream"
            }
          },
          {
            "to": "kamelet:sink"
          }
        ]
      }
    }
  },
  "propertiesSchema": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "FTP Source",
    "description": "Receive data from an FTP server.",
    "required": [
      "connectionHost",
      "connectionPort",
      "username",
      "password",
      "directoryName"
    ],
    "properties": {
      "connectionHost": {
        "type": "string",
        "title": "Connection Host",
        "description": "The hostname of the FTP server."
      },
      "connectionPort": {
        "type": "string",
        "title": "Connection Port",
        "description": "The port of the FTP server.",
        "default": 21
      },
      "username": {
        "type": "string",
        "title": "Username",
        "description": "The username to access the FTP server."
      },
      "password": {
        "type": "string",
        "title": "Password",
        "description": "The password to access the FTP server.",
        "format": "password"
      },
      "directoryName": {
        "type": "string",
        "title": "Directory Name",
        "description": "The starting directory"
      },
      "passiveMode": {
        "type": "boolean",
        "title": "Passive Mode",
        "description": "Specifes to use passive mode connection.",
        "default": false
      },
      "recursive": {
        "type": "boolean",
        "title": "Recursive",
        "description": "If a directory, look for files in all the sub-directories as well.",
        "default": false
      },
      "idempotent": {
        "type": "boolean",
        "title": "Idempotency",
        "description": "Skip already-processed files.",
        "default": true
      },
      "binary": {
        "type": "boolean",
        "title": "Binary",
        "description": "Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false).",
        "default": false
      },
      "autoCreate": {
        "type": "boolean",
        "title": "Autocreate Missing Directories",
        "description": "Automatically create starting directory.",
        "default": true
      },
      "delete": {
        "type": "boolean",
        "title": "Delete",
        "description": "If true, the file is deleted after it is processed successfully.",
        "default": false
      }
    }
  }
}