All Downloads are FREE. Search and download functionalities are using the official Maven repository.

META-INF.syndesis.connector.ftp.json Maven / Gradle / Ivy

The newest version!
{
  "actions": [
    {
      "actionType": "connector",
      "description": "Upload a file to the FTP server",
      "descriptor": {
        "configuredProperties": {},
        "inputDataShape": {
          "kind": "any"
        },
        "outputDataShape": {
          "kind": "none"
        },
        "propertyDefinitionSteps": [
          {
            "description": "Upload to FTP server",
            "name": "Upload to FTP server",
            "properties": {
              "directoryName": {
                "deprecated": false,
                "displayName": "FTP directory",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "path",
                "labelHint": "FTP directory name in which to upload file",
                "required": true,
                "secret": false,
                "type": "string"
              },
              "fileExist": {
                "defaultValue": "Override",
                "deprecated": false,
                "displayName": "If file exists",
                "enum": [
                  {
                    "label": "Override",
                    "value": "Override"
                  },
                  {
                    "label": "Append",
                    "value": "Append"
                  },
                  {
                    "label": "Fail",
                    "value": "Fail"
                  },
                  {
                    "label": "Ignore",
                    "value": "Ignore"
                  },
                  {
                    "label": "Move",
                    "value": "Move"
                  },
                  {
                    "label": "TryRename",
                    "value": "TryRename"
                  }
                ],
                "group": "producer",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "Desired behavior when the file being uploaded is already on the server",
                "required": false,
                "secret": false,
                "type": "string"
              },
              "fileName": {
                "deprecated": false,
                "displayName": "File name expression",
                "group": "producer",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "Simple file language expression that resolves to a file name, examples are '${file:name}', '${file:onlyname.noext}.txt' (files with extension *.txt)",
                "required": false,
                "secret": false,
                "type": "string"
              },
              "tempFileName": {
                "deprecated": false,
                "displayName": "Temporary file name while copying",
                "group": "producer",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "label": "producer",
                "labelHint": "Temporary file name while copying",
                "required": false,
                "secret": false,
                "type": "string"
              },
              "tempPrefix": {
                "deprecated": false,
                "displayName": "Temporary file prefix while copying",
                "group": "producer",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "label": "producer",
                "labelHint": "Temporary file prefix while copying",
                "required": false,
                "secret": false,
                "type": "string"
              }
            }
          }
        ]
      },
      "id": "io.syndesis:ftp-upload-connector",
      "name": "Upload",
      "pattern": "To"
    },
    {
      "actionType": "connector",
      "description": "Upload a named file to the FTP server",
      "descriptor": {
        "configuredProperties": {},
        "standardizedErrors": [
          {
            "name": "DATA_ACCESS_ERROR",
            "displayName": "DataAccessError"
          },
          {
            "name": "DUPLICATE_KEY_ERROR",
            "displayName": "DuplicateKeyError"
          },
          {
            "name": "CONNECTOR_ERROR",
            "displayName": "ConnectorError"
          }
        ],
        "connectorCustomizers": [
          "io.syndesis.connector.ftp.FtpConnectorCustomizer"
        ],
        "inputDataShape": {
          "description": "FTP upload payload",
          "kind": "json-schema",
          "name": "FtpPayload",
          "specification": "{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"type\": \"object\", \"properties\": { \"fileName\": { \"type\": \"string\" }, \"fileContent\": { \"type\": \"string\" } }, \"required\": [ \"fileName\", \"fileContent\" ] }"
        },
        "outputDataShape": {
          "kind": "none"
        },
        "propertyDefinitionSteps": [
          {
            "description": "Upload to FTP server",
            "name": "Upload to FTP server",
            "properties": {
              "directoryName": {
                "deprecated": false,
                "displayName": "FTP directory",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "path",
                "labelHint": "FTP directory name in which to upload file",
                "required": true,
                "secret": false,
                "type": "string"
              },
              "fileExist": {
                "defaultValue": "Override",
                "deprecated": false,
                "displayName": "If file exists",
                "enum": [
                  {
                    "label": "Override",
                    "value": "Override"
                  },
                  {
                    "label": "Append",
                    "value": "Append"
                  },
                  {
                    "label": "Fail",
                    "value": "Fail"
                  },
                  {
                    "label": "Ignore",
                    "value": "Ignore"
                  },
                  {
                    "label": "Move",
                    "value": "Move"
                  },
                  {
                    "label": "TryRename",
                    "value": "TryRename"
                  }
                ],
                "group": "producer",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "Desired behavior when the file being uploaded is already on the server",
                "required": false,
                "secret": false,
                "type": "string"
              },
              "tempFileName": {
                "deprecated": false,
                "displayName": "Temporary file name while copying",
                "group": "producer",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "label": "producer",
                "labelHint": "Temporary file name while copying",
                "required": false,
                "secret": false,
                "type": "string"
              },
              "tempPrefix": {
                "deprecated": false,
                "displayName": "Temporary file prefix while copying",
                "group": "producer",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "label": "producer",
                "labelHint": "Temporary file prefix while copying",
                "required": false,
                "secret": false,
                "type": "string"
              }
            }
          }
        ]
      },
      "id": "io.syndesis:ftp-upload-named-file-connector",
      "name": "UploadNamedFile",
      "pattern": "To"
    },
    {
      "actionType": "connector",
      "description": "Download a named file from the FTP server",
      "descriptor": {
        "configuredProperties": {},
        "standardizedErrors": [
          {
            "name": "DATA_ACCESS_ERROR",
            "displayName": "DataAccessError"
          },
          {
            "name": "ENTITY_NOT_FOUND_ERROR",
            "displayName": "EntityNotFoundError"
          },
          {
            "name": "CONNECTOR_ERROR",
            "displayName": "ConnectorError"
          }
        ],
        "connectorCustomizers": [
          "io.syndesis.connector.ftp.FtpConnectorCustomizer"
        ],
        "inputDataShape": {
          "description": "FTP Header",
          "kind": "json-schema",
          "name": "FtpPayloadHeader",
          "specification": "{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"type\": \"object\", \"properties\": { \"fileName\": { \"type\": \"string\" } }, \"required\": [ \"fileName\" ] }"
        },
        "outputDataShape": {
          "description": "FTP download payload",
          "kind": "json-schema",
          "name": "FtpPayloadFromServer",
          "specification": "{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"type\": \"object\", \"properties\": { \"fileName\": { \"type\": \"string\" }, \"fileContent\": { \"type\": \"string\" } }, \"required\": [ \"fileName\", \"fileContent\" ] }"
        },
        "propertyDefinitionSteps": [
          {
            "description": "Download a named file from FTP server",
            "name": "Download named file from FTP server",
            "properties": {
              "delete": {
                "defaultValue": "false",
                "deprecated": false,
                "displayName": "Delete file after download",
                "enum": [
                  {
                    "label": "No",
                    "value": "false"
                  },
                  {
                    "label": "Yes",
                    "value": "true"
                  }
                ],
                "group": "consumer",
                "javaType": "boolean",
                "kind": "parameter",
                "labelHint": "Delete the file from the server after downloading it",
                "required": false,
                "secret": false,
                "type": "string"
              },
              "directoryName": {
                "deprecated": false,
                "displayName": "FTP directory",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "path",
                "labelHint": "FTP directory name from which to download file",
                "required": true,
                "secret": false,
                "type": "string"
              },
              "fileName" : {
                "defaultValue": "${header.CamelFileName}",
                "deprecated": false,
                "displayName": "File name expression",
                "group": "producer",
                "javaType": "java.lang.String",
                "kind": "proxyParameter",
                "labelHint": "Simple language expression that resolves to a file name",
                "required": false,
                "secret": false,
                "type": "hidden"
              }
            }
          }
        ]
      },
      "id": "io.syndesis:ftp-download-named-file-connector",
      "name": "DownloadNamedFile",
      "pattern": "PollEnrich"
    },
    {
      "actionType": "connector",
      "description": "Download files from the FTP server",
      "descriptor": {
        "configuredProperties": {},
        "inputDataShape": {
          "kind": "none"
        },
        "outputDataShape": {
          "kind": "any"
        },
        "propertyDefinitionSteps": [
          {
            "description": "Download from FTP server",
            "name": "Download from FTP server",
            "properties": {
              "delay": {
                "defaultValue": "5000",
                "deprecated": false,
                "displayName": "Time interval before the next poll",
                "group": "consumer",
                "javaType": "java.lang.Integer",
                "kind": "parameter",
                "labelHint": "Wait this amount of time between polls",
                "required": false,
                "secret": false,
                "type": "duration"
              },
              "delete": {
                "defaultValue": "false",
                "deprecated": false,
                "displayName": "Delete file after download",
                "enum": [
                  {
                    "label": "No",
                    "value": "false"
                  },
                  {
                    "label": "Yes",
                    "value": "true"
                  }
                ],
                "group": "consumer",
                "javaType": "boolean",
                "kind": "parameter",
                "labelHint": "Delete the file from the server after downloading it",
                "required": false,
                "secret": false,
                "type": "string"
              },
              "directoryName": {
                "deprecated": false,
                "displayName": "FTP directory",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "path",
                "labelHint": "FTP directory name from which to download file",
                "required": true,
                "secret": false,
                "type": "string"
              },
              "fileName": {
                "deprecated": false,
                "displayName": "File name expression",
                "group": "producer",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "Simple file language expression that resolves to a file name, examples are '${file:name}', '${file:onlyname.noext}.txt' (files with extension *.txt)",
                "required": false,
                "secret": false,
                "type": "string"
              },
              "initialDelay": {
                "defaultValue": "1000",
                "deprecated": false,
                "displayName": "Interval before polling starts",
                "group": "consumer",
                "javaType": "java.lang.Integer",
                "kind": "parameter",
                "labelHint": "Wait amount of time before starting to poll",
                "required": false,
                "secret": false,
                "type": "duration"
              }
            }
          }
        ]
      },
      "id": "io.syndesis:ftp-download-connector",
      "name": "Download",
      "pattern": "From"
    }
  ],
  "componentScheme": "ftp",
  "configuredProperties": {},
  "dependencies": [
    {
      "id": "@project.groupId@:@project.artifactId@:@project.version@",
      "type": "MAVEN"
    }
  ],
  "description": "Download and upload files.",
  "icon": "assets:ftp.svg",
  "id": "ftp",
  "name": "FTP",
  "properties": {
    "binary": {
      "defaultValue": "true",
      "deprecated": false,
      "displayName": "Binary file transfer mode",
      "enum": [
        {
          "label": "No",
          "value": "false"
        },
        {
          "label": "Yes",
          "value": "true"
        }
      ],
      "group": "common",
      "javaType": "java.lang.String",
      "kind": "parameter",
      "labelHint": "Indicate whether file transfer mode is binary",
      "order": "8",
      "required": false,
      "secret": false,
      "type": "string"
    },
    "connectTimeout": {
      "defaultValue": "10000",
      "deprecated": false,
      "displayName": "Connect timeout",
      "group": "common",
      "javaType": "java.lang.Integer",
      "kind": "parameter",
      "labelHint": "Maximum number of milliseconds to wait for a connection to be established",
      "order": "5",
      "required": false,
      "secret": false,
      "type": "integer"
    },
    "disconnect": {
      "defaultValue": "false",
      "deprecated": false,
      "displayName": "Disconnect from server after use",
      "enum": [
        {
          "label": "No",
          "value": "false"
        },
        {
          "label": "Yes",
          "value": "true"
        }
      ],
      "group": "common",
      "javaType": "java.lang.String",
      "kind": "parameter",
      "labelHint": "Disconnect from the server after performing the action",
      "order": "10",
      "required": false,
      "secret": false,
      "type": "string"
    },
    "host": {
      "deprecated": false,
      "displayName": "Host",
      "group": "common",
      "javaType": "java.lang.String",
      "kind": "path",
      "labelHint": "Host name of the FTP server to connect to",
      "order": "1",
      "required": true,
      "secret": false,
      "type": "string"
    },
    "maximumReconnectAttempts": {
      "defaultValue": "3",
      "deprecated": false,
      "displayName": "Maximum reconnect attempts",
      "group": "common",
      "javaType": "java.lang.Integer",
      "kind": "parameter",
      "labelHint": "Try to reconnect no more than this many times",
      "order": "7",
      "required": false,
      "secret": false,
      "type": "integer"
    },
    "passiveMode": {
      "defaultValue": "true",
      "deprecated": false,
      "displayName": "Passive connection mode",
      "enum": [
        {
          "label": "No",
          "value": "false"
        },
        {
          "label": "Yes",
          "value": "true"
        }
      ],
      "group": "common",
      "javaType": "java.lang.String",
      "kind": "parameter",
      "labelHint": "Indicates whether passive connection mode is being used",
      "order": "9",
      "required": false,
      "secret": false,
      "type": "string"
    },
    "password": {
      "deprecated": false,
      "displayName": "Password",
      "group": "common,security",
      "javaType": "java.lang.String",
      "kind": "parameter",
      "labelHint": "Password for connecting to the FTP server",
      "order": "3",
      "raw": true,
      "required": false,
      "secret": true,
      "type": "string"
    },
    "port": {
      "defaultValue": "21",
      "deprecated": false,
      "displayName": "Port",
      "group": "common",
      "javaType": "java.lang.Integer",
      "kind": "path",
      "labelHint": "FTP port",
      "order": "4",
      "required": true,
      "secret": false,
      "type": "integer"
    },
    "reconnectDelay": {
      "defaultValue": "1000",
      "deprecated": false,
      "displayName": "Reconnect delay",
      "group": "common",
      "javaType": "java.lang.Integer",
      "kind": "parameter",
      "labelHint": "Number of milliseconds to wait before trying to reconnect",
      "order": "6",
      "required": false,
      "secret": false,
      "type": "integer"
    },
    "timeout": {
      "defaultValue": "30000",
      "deprecated": false,
      "displayName": "Data timeout",
      "group": "common",
      "javaType": "java.lang.Integer",
      "kind": "parameter",
      "labelHint": "Maximum number of milliseconds to wait for a reply",
      "order": "11",
      "required": false,
      "secret": false,
      "type": "integer"
    },
    "username": {
      "deprecated": false,
      "displayName": "User name",
      "group": "common,security",
      "javaType": "java.lang.String",
      "kind": "parameter",
      "labelHint": "User name for connecting to the FTP server",
      "order": "2",
      "required": false,
      "secret": false,
      "type": "string"
    }
  },
  "tags": [
    "verifier"
  ]
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy