This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new 67682e4 CAMEL-14506: Update docs
67682e4 is described below
commit 67682e4bd21262e5bbaf4e7322461e494f1eb8c5
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Mon Feb 10 18:38:55 2020 +0100
CAMEL-14506: Update docs
---
.../resources/org/apache/camel/component/file/remote/ftp.json | 4 ++--
.../resources/org/apache/camel/component/file/remote/ftps.json | 4 ++--
.../resources/org/apache/camel/component/file/remote/sftp.json | 4 ++--
components/camel-ftp/src/main/docs/ftp-component.adoc | 4 ++--
components/camel-ftp/src/main/docs/ftps-component.adoc | 4 ++--
components/camel-ftp/src/main/docs/sftp-component.adoc | 4 ++--
.../apache/camel/component/file/remote/RemoteFileConfiguration.java | 6 ++++--
docs/components/modules/ROOT/pages/ftp-component.adoc | 6 ++----
docs/components/modules/ROOT/pages/ftps-component.adoc | 4 ++--
docs/components/modules/ROOT/pages/sftp-component.adoc | 4 ++--
10 files changed, 22 insertions(+), 22 deletions(-)
diff --git
a/components/camel-ftp/src/generated/resources/org/apache/camel/component/file/remote/ftp.json
b/components/camel-ftp/src/generated/resources/org/apache/camel/component/file/remote/ftp.json
index ece0897..8d79a32 100644
---
a/components/camel-ftp/src/generated/resources/org/apache/camel/component/file/remote/ftp.json
+++
b/components/camel-ftp/src/generated/resources/org/apache/camel/component/file/remote/ftp.json
@@ -48,7 +48,7 @@
"recursive": { "kind": "parameter", "displayName": "Recursive", "group":
"consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "description": "If a directory, will look for files in all the
sub-directories as well." },
"resumeDownload": { "kind": "parameter", "displayName": "Resume Download",
"group": "consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "description": "Configures whether resume download is enabled. This must
be supported by the FTP server (almost all FTP servers support it). In addition
the options localWorkDirectory must be configured so downloaded files are
stored in a local dire [...]
"sendEmptyMessageWhenIdle": { "kind": "parameter", "displayName": "Send
Empty Message When Idle", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret":
false, "defaultValue": false, "description": "If the polling consumer did not
poll any files, you can enable this option to send an empty message (no body)
instead." },
- "streamDownload": { "kind": "parameter", "displayName": "Stream Download",
"group": "consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "configurationClass":
"org.apache.camel.component.file.remote.FtpConfiguration",
"configurationField": "configuration", "description": "Sets the download method
to use when not using a local working directory. If set to true, the remote
files are st [...]
+ "streamDownload": { "kind": "parameter", "displayName": "Stream Download",
"group": "consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "configurationClass":
"org.apache.camel.component.file.remote.FtpConfiguration",
"configurationField": "configuration", "description": "Sets the download method
to use when not using a local working directory. If set to true, the remote
files are st [...]
"download": { "kind": "parameter", "displayName": "Download", "group":
"consumer (advanced)", "label": "consumer,advanced", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": false, "description": "Whether the FTP consumer should download
the file. If this option is set to false, then the message body will be null,
but the consumer will still trigger a Camel Exchange that has details about the
file such as file name, fil [...]
"exceptionHandler": { "kind": "parameter", "displayName": "Exception
Handler", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "secret": false, "description": "To let the consumer use a
custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled
then this option is not in use. By default the consumer will deal with [...]
"exchangePattern": { "kind": "parameter", "displayName": "Exchange
Pattern", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut",
"InOptionalOut" ], "deprecated": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
@@ -87,7 +87,7 @@
"reconnectDelay": { "kind": "parameter", "displayName": "Reconnect Delay",
"group": "advanced", "label": "advanced", "required": false, "type": "integer",
"javaType": "long", "deprecated": false, "secret": false, "description": "Delay
in millis Camel will wait before performing a reconnect attempt." },
"siteCommand": { "kind": "parameter", "displayName": "Site Command",
"group": "advanced", "label": "advanced", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "secret": false,
"configurationClass":
"org.apache.camel.component.file.remote.FtpConfiguration",
"configurationField": "configuration", "description": "Sets optional site
command(s) to be executed after successful login. Multiple site commands can be
separated using a new line character." },
"soTimeout": { "kind": "parameter", "displayName": "So Timeout", "group":
"advanced", "label": "advanced", "required": false, "type": "integer",
"javaType": "int", "deprecated": false, "secret": false, "defaultValue":
"300000", "configurationClass":
"org.apache.camel.component.file.remote.FtpConfiguration",
"configurationField": "configuration", "description": "Sets the so timeout FTP
and FTPS Only for Camel 2.4. SFTP for Camel 2.14.3\/2.15.3\/2.16 onwards. Is
the SocketOptions.SO_TI [...]
- "stepwise": { "kind": "parameter", "displayName": "Stepwise", "group":
"advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"true", "configurationClass":
"org.apache.camel.component.file.remote.FtpConfiguration",
"configurationField": "configuration", "description": "Sets whether we should
stepwise change directories while traversing file structures when downloading
files, or as well when u [...]
+ "stepwise": { "kind": "parameter", "displayName": "Stepwise", "group":
"advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"true", "configurationClass":
"org.apache.camel.component.file.remote.FtpConfiguration",
"configurationField": "configuration", "description": "Sets whether we should
stepwise change directories while traversing file structures when downloading
files, or as well when u [...]
"synchronous": { "kind": "parameter", "displayName": "Synchronous",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"false", "description": "Sets whether synchronous processing should be strictly
used, or Camel is allowed to use asynchronous processing (if supported)." },
"throwExceptionOnConnectFailed": { "kind": "parameter", "displayName":
"Throw Exception On Connect Failed", "group": "advanced", "label": "advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.file.remote.FtpConfiguration",
"configurationField": "configuration", "description": "Should an exception be
thrown if connection failed (exhausted) By default except [...]
"timeout": { "kind": "parameter", "displayName": "Timeout", "group":
"advanced", "label": "advanced", "required": false, "type": "integer",
"javaType": "int", "deprecated": false, "secret": false, "defaultValue":
"30000", "configurationClass":
"org.apache.camel.component.file.remote.FtpConfiguration",
"configurationField": "configuration", "description": "Sets the data timeout
for waiting for reply Used only by FTPClient" },
diff --git
a/components/camel-ftp/src/generated/resources/org/apache/camel/component/file/remote/ftps.json
b/components/camel-ftp/src/generated/resources/org/apache/camel/component/file/remote/ftps.json
index 4d540e1..9e217f2 100644
---
a/components/camel-ftp/src/generated/resources/org/apache/camel/component/file/remote/ftps.json
+++
b/components/camel-ftp/src/generated/resources/org/apache/camel/component/file/remote/ftps.json
@@ -49,7 +49,7 @@
"recursive": { "kind": "parameter", "displayName": "Recursive", "group":
"consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "description": "If a directory, will look for files in all the
sub-directories as well." },
"resumeDownload": { "kind": "parameter", "displayName": "Resume Download",
"group": "consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "description": "Configures whether resume download is enabled. This must
be supported by the FTP server (almost all FTP servers support it). In addition
the options localWorkDirectory must be configured so downloaded files are
stored in a local dire [...]
"sendEmptyMessageWhenIdle": { "kind": "parameter", "displayName": "Send
Empty Message When Idle", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret":
false, "defaultValue": false, "description": "If the polling consumer did not
poll any files, you can enable this option to send an empty message (no body)
instead." },
- "streamDownload": { "kind": "parameter", "displayName": "Stream Download",
"group": "consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "configurationClass":
"org.apache.camel.component.file.remote.FtpsConfiguration",
"configurationField": "configuration", "description": "Sets the download method
to use when not using a local working directory. If set to true, the remote
files are s [...]
+ "streamDownload": { "kind": "parameter", "displayName": "Stream Download",
"group": "consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "configurationClass":
"org.apache.camel.component.file.remote.FtpsConfiguration",
"configurationField": "configuration", "description": "Sets the download method
to use when not using a local working directory. If set to true, the remote
files are s [...]
"download": { "kind": "parameter", "displayName": "Download", "group":
"consumer (advanced)", "label": "consumer,advanced", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": false, "description": "Whether the FTP consumer should download
the file. If this option is set to false, then the message body will be null,
but the consumer will still trigger a Camel Exchange that has details about the
file such as file name, fil [...]
"exceptionHandler": { "kind": "parameter", "displayName": "Exception
Handler", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "secret": false, "description": "To let the consumer use a
custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled
then this option is not in use. By default the consumer will deal with [...]
"exchangePattern": { "kind": "parameter", "displayName": "Exchange
Pattern", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut",
"InOptionalOut" ], "deprecated": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
@@ -88,7 +88,7 @@
"reconnectDelay": { "kind": "parameter", "displayName": "Reconnect Delay",
"group": "advanced", "label": "advanced", "required": false, "type": "integer",
"javaType": "long", "deprecated": false, "secret": false, "description": "Delay
in millis Camel will wait before performing a reconnect attempt." },
"siteCommand": { "kind": "parameter", "displayName": "Site Command",
"group": "advanced", "label": "advanced", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "secret": false,
"configurationClass":
"org.apache.camel.component.file.remote.FtpsConfiguration",
"configurationField": "configuration", "description": "Sets optional site
command(s) to be executed after successful login. Multiple site commands can be
separated using a new line character." },
"soTimeout": { "kind": "parameter", "displayName": "So Timeout", "group":
"advanced", "label": "advanced", "required": false, "type": "integer",
"javaType": "int", "deprecated": false, "secret": false, "defaultValue":
"300000", "configurationClass":
"org.apache.camel.component.file.remote.FtpsConfiguration",
"configurationField": "configuration", "description": "Sets the so timeout FTP
and FTPS Only for Camel 2.4. SFTP for Camel 2.14.3\/2.15.3\/2.16 onwards. Is
the SocketOptions.SO_T [...]
- "stepwise": { "kind": "parameter", "displayName": "Stepwise", "group":
"advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"true", "configurationClass":
"org.apache.camel.component.file.remote.FtpsConfiguration",
"configurationField": "configuration", "description": "Sets whether we should
stepwise change directories while traversing file structures when downloading
files, or as well when [...]
+ "stepwise": { "kind": "parameter", "displayName": "Stepwise", "group":
"advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"true", "configurationClass":
"org.apache.camel.component.file.remote.FtpsConfiguration",
"configurationField": "configuration", "description": "Sets whether we should
stepwise change directories while traversing file structures when downloading
files, or as well when [...]
"synchronous": { "kind": "parameter", "displayName": "Synchronous",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"false", "description": "Sets whether synchronous processing should be strictly
used, or Camel is allowed to use asynchronous processing (if supported)." },
"throwExceptionOnConnectFailed": { "kind": "parameter", "displayName":
"Throw Exception On Connect Failed", "group": "advanced", "label": "advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.file.remote.FtpsConfiguration",
"configurationField": "configuration", "description": "Should an exception be
thrown if connection failed (exhausted) By default excep [...]
"timeout": { "kind": "parameter", "displayName": "Timeout", "group":
"advanced", "label": "advanced", "required": false, "type": "integer",
"javaType": "int", "deprecated": false, "secret": false, "defaultValue":
"30000", "configurationClass":
"org.apache.camel.component.file.remote.FtpsConfiguration",
"configurationField": "configuration", "description": "Sets the data timeout
for waiting for reply Used only by FTPClient" },
diff --git
a/components/camel-ftp/src/generated/resources/org/apache/camel/component/file/remote/sftp.json
b/components/camel-ftp/src/generated/resources/org/apache/camel/component/file/remote/sftp.json
index 92c8d3e..a9eb7a7 100644
---
a/components/camel-ftp/src/generated/resources/org/apache/camel/component/file/remote/sftp.json
+++
b/components/camel-ftp/src/generated/resources/org/apache/camel/component/file/remote/sftp.json
@@ -44,7 +44,7 @@
"preSort": { "kind": "parameter", "displayName": "Pre Sort", "group":
"consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "description": "When pre-sort is enabled then the consumer will sort the
file and directory names during polling, that was retrieved from the file
system. You may want to do this in case you need to operate on the files in a
sorted order. The pre-sort is executed [...]
"recursive": { "kind": "parameter", "displayName": "Recursive", "group":
"consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "description": "If a directory, will look for files in all the
sub-directories as well." },
"sendEmptyMessageWhenIdle": { "kind": "parameter", "displayName": "Send
Empty Message When Idle", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret":
false, "defaultValue": false, "description": "If the polling consumer did not
poll any files, you can enable this option to send an empty message (no body)
instead." },
- "streamDownload": { "kind": "parameter", "displayName": "Stream Download",
"group": "consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "configurationClass":
"org.apache.camel.component.file.remote.SftpConfiguration",
"configurationField": "configuration", "description": "Sets the download method
to use when not using a local working directory. If set to true, the remote
files are s [...]
+ "streamDownload": { "kind": "parameter", "displayName": "Stream Download",
"group": "consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "configurationClass":
"org.apache.camel.component.file.remote.SftpConfiguration",
"configurationField": "configuration", "description": "Sets the download method
to use when not using a local working directory. If set to true, the remote
files are s [...]
"download": { "kind": "parameter", "displayName": "Download", "group":
"consumer (advanced)", "label": "consumer,advanced", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": false, "description": "Whether the FTP consumer should download
the file. If this option is set to false, then the message body will be null,
but the consumer will still trigger a Camel Exchange that has details about the
file such as file name, fil [...]
"exceptionHandler": { "kind": "parameter", "displayName": "Exception
Handler", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "secret": false, "description": "To let the consumer use a
custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled
then this option is not in use. By default the consumer will deal with [...]
"exchangePattern": { "kind": "parameter", "displayName": "Exchange
Pattern", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut",
"InOptionalOut" ], "deprecated": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
@@ -81,7 +81,7 @@
"serverAliveCountMax": { "kind": "parameter", "displayName": "Server Alive
Count Max", "group": "advanced", "label": "advanced", "required": false,
"type": "integer", "javaType": "int", "deprecated": false, "secret": false,
"defaultValue": "1", "configurationClass":
"org.apache.camel.component.file.remote.SftpConfiguration",
"configurationField": "configuration", "description": "Sets the number of
keep-alive messages which may be sent without receiving any messages back from
the serv [...]
"serverAliveInterval": { "kind": "parameter", "displayName": "Server Alive
Interval", "group": "advanced", "label": "advanced", "required": false, "type":
"integer", "javaType": "int", "deprecated": false, "secret": false,
"configurationClass":
"org.apache.camel.component.file.remote.SftpConfiguration",
"configurationField": "configuration", "description": "Sets the interval
(millis) to send a keep-alive message. If zero is specified, any keep-alive
message must not be sent. The defa [...]
"soTimeout": { "kind": "parameter", "displayName": "So Timeout", "group":
"advanced", "label": "advanced", "required": false, "type": "integer",
"javaType": "int", "deprecated": false, "secret": false, "defaultValue":
"300000", "configurationClass":
"org.apache.camel.component.file.remote.SftpConfiguration",
"configurationField": "configuration", "description": "Sets the so timeout FTP
and FTPS Only for Camel 2.4. SFTP for Camel 2.14.3\/2.15.3\/2.16 onwards. Is
the SocketOptions.SO_T [...]
- "stepwise": { "kind": "parameter", "displayName": "Stepwise", "group":
"advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"true", "configurationClass":
"org.apache.camel.component.file.remote.SftpConfiguration",
"configurationField": "configuration", "description": "Sets whether we should
stepwise change directories while traversing file structures when downloading
files, or as well when [...]
+ "stepwise": { "kind": "parameter", "displayName": "Stepwise", "group":
"advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"true", "configurationClass":
"org.apache.camel.component.file.remote.SftpConfiguration",
"configurationField": "configuration", "description": "Sets whether we should
stepwise change directories while traversing file structures when downloading
files, or as well when [...]
"synchronous": { "kind": "parameter", "displayName": "Synchronous",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"false", "description": "Sets whether synchronous processing should be strictly
used, or Camel is allowed to use asynchronous processing (if supported)." },
"throwExceptionOnConnectFailed": { "kind": "parameter", "displayName":
"Throw Exception On Connect Failed", "group": "advanced", "label": "advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.file.remote.SftpConfiguration",
"configurationField": "configuration", "description": "Should an exception be
thrown if connection failed (exhausted) By default excep [...]
"timeout": { "kind": "parameter", "displayName": "Timeout", "group":
"advanced", "label": "advanced", "required": false, "type": "integer",
"javaType": "int", "deprecated": false, "secret": false, "defaultValue":
"30000", "configurationClass":
"org.apache.camel.component.file.remote.SftpConfiguration",
"configurationField": "configuration", "description": "Sets the data timeout
for waiting for reply Used only by FTPClient" },
diff --git a/components/camel-ftp/src/main/docs/ftp-component.adoc
b/components/camel-ftp/src/main/docs/ftp-component.adoc
index 00122df..c6d6b76 100644
--- a/components/camel-ftp/src/main/docs/ftp-component.adoc
+++ b/components/camel-ftp/src/main/docs/ftp-component.adoc
@@ -133,7 +133,7 @@ with the following path and query parameters:
| *recursive* (consumer) | If a directory, will look for files in all the
sub-directories as well. | false | boolean
| *resumeDownload* (consumer) | Configures whether resume download is enabled.
This must be supported by the FTP server (almost all FTP servers support it).
In addition the options localWorkDirectory must be configured so downloaded
files are stored in a local directory, and the option binary must be enabled,
which is required to support resuming of downloads. | false | boolean
| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll
any files, you can enable this option to send an empty message (no body)
instead. | false | boolean
-| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. | false | boolean
+| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. If enabling this option then you must
set stepwise=false as both cannot be enabled at the same time. | false | boolean
| *download* (consumer) | Whether the FTP consumer should download the file.
If this option is set to false, then the message body will be null, but the
consumer will still trigger a Camel Exchange that has details about the file
such as file name, file size, etc. It's just that the file will not be
downloaded. | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | |
ExchangePattern
@@ -172,7 +172,7 @@ with the following path and query parameters:
| *reconnectDelay* (advanced) | Delay in millis Camel will wait before
performing a reconnect attempt. | | long
| *siteCommand* (advanced) | Sets optional site command(s) to be executed
after successful login. Multiple site commands can be separated using a new
line character. | | String
| *soTimeout* (advanced) | Sets the so timeout FTP and FTPS Only for Camel
2.4. SFTP for Camel 2.14.3/2.15.3/2.16 onwards. Is the SocketOptions.SO_TIMEOUT
value in millis. Recommended option is to set this to 300000 so as not have a
hanged connection. On SFTP this option is set as timeout on the JSCH Session
instance. | 300000 | int
-| *stepwise* (advanced) | Sets whether we should stepwise change directories
while traversing file structures when downloading files, or as well when
uploading a file to a directory. You can disable this if you for example are in
a situation where you cannot change directory on the FTP server due security
reasons. | true | boolean
+| *stepwise* (advanced) | Sets whether we should stepwise change directories
while traversing file structures when downloading files, or as well when
uploading a file to a directory. You can disable this if you for example are in
a situation where you cannot change directory on the FTP server due security
reasons. Stepwise cannot be used together with streamDownload. | true | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
| *throwExceptionOnConnectFailed* (advanced) | Should an exception be thrown
if connection failed (exhausted) By default exception is not thrown and a WARN
is logged. You can use this to enable exception being thrown and handle the
thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy
rollback method. | false | boolean
| *timeout* (advanced) | Sets the data timeout for waiting for reply Used only
by FTPClient | 30000 | int
diff --git a/components/camel-ftp/src/main/docs/ftps-component.adoc
b/components/camel-ftp/src/main/docs/ftps-component.adoc
index c290241..e45d271 100644
--- a/components/camel-ftp/src/main/docs/ftps-component.adoc
+++ b/components/camel-ftp/src/main/docs/ftps-component.adoc
@@ -92,7 +92,7 @@ with the following path and query parameters:
| *recursive* (consumer) | If a directory, will look for files in all the
sub-directories as well. | false | boolean
| *resumeDownload* (consumer) | Configures whether resume download is enabled.
This must be supported by the FTP server (almost all FTP servers support it).
In addition the options localWorkDirectory must be configured so downloaded
files are stored in a local directory, and the option binary must be enabled,
which is required to support resuming of downloads. | false | boolean
| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll
any files, you can enable this option to send an empty message (no body)
instead. | false | boolean
-| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. | false | boolean
+| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. If enabling this option then you must
set stepwise=false as both cannot be enabled at the same time. | false | boolean
| *download* (consumer) | Whether the FTP consumer should download the file.
If this option is set to false, then the message body will be null, but the
consumer will still trigger a Camel Exchange that has details about the file
such as file name, file size, etc. It's just that the file will not be
downloaded. | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | |
ExchangePattern
@@ -131,7 +131,7 @@ with the following path and query parameters:
| *reconnectDelay* (advanced) | Delay in millis Camel will wait before
performing a reconnect attempt. | | long
| *siteCommand* (advanced) | Sets optional site command(s) to be executed
after successful login. Multiple site commands can be separated using a new
line character. | | String
| *soTimeout* (advanced) | Sets the so timeout FTP and FTPS Only for Camel
2.4. SFTP for Camel 2.14.3/2.15.3/2.16 onwards. Is the SocketOptions.SO_TIMEOUT
value in millis. Recommended option is to set this to 300000 so as not have a
hanged connection. On SFTP this option is set as timeout on the JSCH Session
instance. | 300000 | int
-| *stepwise* (advanced) | Sets whether we should stepwise change directories
while traversing file structures when downloading files, or as well when
uploading a file to a directory. You can disable this if you for example are in
a situation where you cannot change directory on the FTP server due security
reasons. | true | boolean
+| *stepwise* (advanced) | Sets whether we should stepwise change directories
while traversing file structures when downloading files, or as well when
uploading a file to a directory. You can disable this if you for example are in
a situation where you cannot change directory on the FTP server due security
reasons. Stepwise cannot be used together with streamDownload. | true | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
| *throwExceptionOnConnectFailed* (advanced) | Should an exception be thrown
if connection failed (exhausted) By default exception is not thrown and a WARN
is logged. You can use this to enable exception being thrown and handle the
thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy
rollback method. | false | boolean
| *timeout* (advanced) | Sets the data timeout for waiting for reply Used only
by FTPClient | 30000 | int
diff --git a/components/camel-ftp/src/main/docs/sftp-component.adoc
b/components/camel-ftp/src/main/docs/sftp-component.adoc
index ea61cfd..b198040 100644
--- a/components/camel-ftp/src/main/docs/sftp-component.adoc
+++ b/components/camel-ftp/src/main/docs/sftp-component.adoc
@@ -88,7 +88,7 @@ with the following path and query parameters:
| *preSort* (consumer) | When pre-sort is enabled then the consumer will sort
the file and directory names during polling, that was retrieved from the file
system. You may want to do this in case you need to operate on the files in a
sorted order. The pre-sort is executed before the consumer starts to filter,
and accept files to process by Camel. This option is default=false meaning
disabled. | false | boolean
| *recursive* (consumer) | If a directory, will look for files in all the
sub-directories as well. | false | boolean
| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll
any files, you can enable this option to send an empty message (no body)
instead. | false | boolean
-| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. | false | boolean
+| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. If enabling this option then you must
set stepwise=false as both cannot be enabled at the same time. | false | boolean
| *download* (consumer) | Whether the FTP consumer should download the file.
If this option is set to false, then the message body will be null, but the
consumer will still trigger a Camel Exchange that has details about the file
such as file name, file size, etc. It's just that the file will not be
downloaded. | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | |
ExchangePattern
@@ -125,7 +125,7 @@ with the following path and query parameters:
| *serverAliveCountMax* (advanced) | Sets the number of keep-alive messages
which may be sent without receiving any messages back from the server. If this
threshold is reached while keep-alive messages are being sent, the connection
will be disconnected. The default value is one. | 1 | int
| *serverAliveInterval* (advanced) | Sets the interval (millis) to send a
keep-alive message. If zero is specified, any keep-alive message must not be
sent. The default interval is zero. | | int
| *soTimeout* (advanced) | Sets the so timeout FTP and FTPS Only for Camel
2.4. SFTP for Camel 2.14.3/2.15.3/2.16 onwards. Is the SocketOptions.SO_TIMEOUT
value in millis. Recommended option is to set this to 300000 so as not have a
hanged connection. On SFTP this option is set as timeout on the JSCH Session
instance. | 300000 | int
-| *stepwise* (advanced) | Sets whether we should stepwise change directories
while traversing file structures when downloading files, or as well when
uploading a file to a directory. You can disable this if you for example are in
a situation where you cannot change directory on the FTP server due security
reasons. | true | boolean
+| *stepwise* (advanced) | Sets whether we should stepwise change directories
while traversing file structures when downloading files, or as well when
uploading a file to a directory. You can disable this if you for example are in
a situation where you cannot change directory on the FTP server due security
reasons. Stepwise cannot be used together with streamDownload. | true | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
| *throwExceptionOnConnectFailed* (advanced) | Should an exception be thrown
if connection failed (exhausted) By default exception is not thrown and a WARN
is logged. You can use this to enable exception being thrown and handle the
thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy
rollback method. | false | boolean
| *timeout* (advanced) | Sets the data timeout for waiting for reply Used only
by FTPClient | 30000 | int
diff --git
a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/RemoteFileConfiguration.java
b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/RemoteFileConfiguration.java
index 43a5d24..06538f4 100644
---
a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/RemoteFileConfiguration.java
+++
b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/RemoteFileConfiguration.java
@@ -78,14 +78,16 @@ public abstract class RemoteFileConfiguration extends
GenericFileConfiguration {
@UriParam(defaultValue = "true", label = "advanced", description = "Sets
whether we should stepwise change "
+
"directories while traversing file structures when downloading files, or as
well when uploading a file "
+ "to a
directory. <p/> You can disable this if you for example are in a situation
where you cannot change "
- +
"directory on the FTP server due security reasons.")
+ +
"directory on the FTP server due security reasons. "
+ +
"Stepwise cannot be used together with streamDownload.")
private boolean stepwise = true;
@UriParam(defaultValue = "UNIX", description = "Sets the path separator to
be used. <p/> UNIX = Uses unix style "
+ "path separator Windows =
Uses windows style path separator Auto = (is default) Use existing path " +
"separator in file name")
private PathSeparator separator = PathSeparator.UNIX;
@UriParam(label = "consumer", description = "Sets the download method to
use when not using a local working "
+ "directory. If set to true,
the remote files are streamed to the route as they are read. When set to "
- + "false, the remote files are
loaded into memory before being sent into the route.")
+ + "false, the remote files are
loaded into memory before being sent into the route. "
+ + "If enabling this option
then you must set stepwise=false as both cannot be enabled at the same time.")
private boolean streamDownload;
@UriParam(defaultValue = "true", label = "consumer,advanced", description
= "Whether to allow using LIST "
+ "command when downloading a file. <p/> Default is <tt>true</tt>. In some use
cases you may want to "
diff --git a/docs/components/modules/ROOT/pages/ftp-component.adoc
b/docs/components/modules/ROOT/pages/ftp-component.adoc
index 92f1d37..6377e90 100644
--- a/docs/components/modules/ROOT/pages/ftp-component.adoc
+++ b/docs/components/modules/ROOT/pages/ftp-component.adoc
@@ -134,7 +134,7 @@ with the following path and query parameters:
| *recursive* (consumer) | If a directory, will look for files in all the
sub-directories as well. | false | boolean
| *resumeDownload* (consumer) | Configures whether resume download is enabled.
This must be supported by the FTP server (almost all FTP servers support it).
In addition the options localWorkDirectory must be configured so downloaded
files are stored in a local directory, and the option binary must be enabled,
which is required to support resuming of downloads. | false | boolean
| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll
any files, you can enable this option to send an empty message (no body)
instead. | false | boolean
-| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. | false | boolean
+| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. If enabling this option then you must
set stepwise=false as both cannot be enabled at the same time. | false | boolean
| *download* (consumer) | Whether the FTP consumer should download the file.
If this option is set to false, then the message body will be null, but the
consumer will still trigger a Camel Exchange that has details about the file
such as file name, file size, etc. It's just that the file will not be
downloaded. | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | |
ExchangePattern
@@ -173,7 +173,7 @@ with the following path and query parameters:
| *reconnectDelay* (advanced) | Delay in millis Camel will wait before
performing a reconnect attempt. | | long
| *siteCommand* (advanced) | Sets optional site command(s) to be executed
after successful login. Multiple site commands can be separated using a new
line character. | | String
| *soTimeout* (advanced) | Sets the so timeout FTP and FTPS Only for Camel
2.4. SFTP for Camel 2.14.3/2.15.3/2.16 onwards. Is the SocketOptions.SO_TIMEOUT
value in millis. Recommended option is to set this to 300000 so as not have a
hanged connection. On SFTP this option is set as timeout on the JSCH Session
instance. | 300000 | int
-| *stepwise* (advanced) | Sets whether we should stepwise change directories
while traversing file structures when downloading files, or as well when
uploading a file to a directory. You can disable this if you for example are in
a situation where you cannot change directory on the FTP server due security
reasons. | true | boolean
+| *stepwise* (advanced) | Sets whether we should stepwise change directories
while traversing file structures when downloading files, or as well when
uploading a file to a directory. You can disable this if you for example are in
a situation where you cannot change directory on the FTP server due security
reasons. Stepwise cannot be used together with streamDownload. | true | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
| *throwExceptionOnConnectFailed* (advanced) | Should an exception be thrown
if connection failed (exhausted) By default exception is not thrown and a WARN
is logged. You can use this to enable exception being thrown and handle the
thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy
rollback method. | false | boolean
| *timeout* (advanced) | Sets the data timeout for waiting for reply Used only
by FTPClient | 30000 | int
@@ -443,8 +443,6 @@ stepwise, while others can only download if they do not.
You can use the `stepwise` option to control the behavior.
-*Important*: Stepwise=true is not supported for stream download.
-
Note that stepwise changing of directory will in most cases only work
when the user is confined to it's home directory and when the home
directory is reported as `"/"`.
diff --git a/docs/components/modules/ROOT/pages/ftps-component.adoc
b/docs/components/modules/ROOT/pages/ftps-component.adoc
index 40b78f5..3fb1bc1 100644
--- a/docs/components/modules/ROOT/pages/ftps-component.adoc
+++ b/docs/components/modules/ROOT/pages/ftps-component.adoc
@@ -93,7 +93,7 @@ with the following path and query parameters:
| *recursive* (consumer) | If a directory, will look for files in all the
sub-directories as well. | false | boolean
| *resumeDownload* (consumer) | Configures whether resume download is enabled.
This must be supported by the FTP server (almost all FTP servers support it).
In addition the options localWorkDirectory must be configured so downloaded
files are stored in a local directory, and the option binary must be enabled,
which is required to support resuming of downloads. | false | boolean
| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll
any files, you can enable this option to send an empty message (no body)
instead. | false | boolean
-| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. | false | boolean
+| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. If enabling this option then you must
set stepwise=false as both cannot be enabled at the same time. | false | boolean
| *download* (consumer) | Whether the FTP consumer should download the file.
If this option is set to false, then the message body will be null, but the
consumer will still trigger a Camel Exchange that has details about the file
such as file name, file size, etc. It's just that the file will not be
downloaded. | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | |
ExchangePattern
@@ -132,7 +132,7 @@ with the following path and query parameters:
| *reconnectDelay* (advanced) | Delay in millis Camel will wait before
performing a reconnect attempt. | | long
| *siteCommand* (advanced) | Sets optional site command(s) to be executed
after successful login. Multiple site commands can be separated using a new
line character. | | String
| *soTimeout* (advanced) | Sets the so timeout FTP and FTPS Only for Camel
2.4. SFTP for Camel 2.14.3/2.15.3/2.16 onwards. Is the SocketOptions.SO_TIMEOUT
value in millis. Recommended option is to set this to 300000 so as not have a
hanged connection. On SFTP this option is set as timeout on the JSCH Session
instance. | 300000 | int
-| *stepwise* (advanced) | Sets whether we should stepwise change directories
while traversing file structures when downloading files, or as well when
uploading a file to a directory. You can disable this if you for example are in
a situation where you cannot change directory on the FTP server due security
reasons. | true | boolean
+| *stepwise* (advanced) | Sets whether we should stepwise change directories
while traversing file structures when downloading files, or as well when
uploading a file to a directory. You can disable this if you for example are in
a situation where you cannot change directory on the FTP server due security
reasons. Stepwise cannot be used together with streamDownload. | true | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
| *throwExceptionOnConnectFailed* (advanced) | Should an exception be thrown
if connection failed (exhausted) By default exception is not thrown and a WARN
is logged. You can use this to enable exception being thrown and handle the
thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy
rollback method. | false | boolean
| *timeout* (advanced) | Sets the data timeout for waiting for reply Used only
by FTPClient | 30000 | int
diff --git a/docs/components/modules/ROOT/pages/sftp-component.adoc
b/docs/components/modules/ROOT/pages/sftp-component.adoc
index 1450391..13f6cbf 100644
--- a/docs/components/modules/ROOT/pages/sftp-component.adoc
+++ b/docs/components/modules/ROOT/pages/sftp-component.adoc
@@ -89,7 +89,7 @@ with the following path and query parameters:
| *preSort* (consumer) | When pre-sort is enabled then the consumer will sort
the file and directory names during polling, that was retrieved from the file
system. You may want to do this in case you need to operate on the files in a
sorted order. The pre-sort is executed before the consumer starts to filter,
and accept files to process by Camel. This option is default=false meaning
disabled. | false | boolean
| *recursive* (consumer) | If a directory, will look for files in all the
sub-directories as well. | false | boolean
| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll
any files, you can enable this option to send an empty message (no body)
instead. | false | boolean
-| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. | false | boolean
+| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. If enabling this option then you must
set stepwise=false as both cannot be enabled at the same time. | false | boolean
| *download* (consumer) | Whether the FTP consumer should download the file.
If this option is set to false, then the message body will be null, but the
consumer will still trigger a Camel Exchange that has details about the file
such as file name, file size, etc. It's just that the file will not be
downloaded. | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | |
ExchangePattern
@@ -126,7 +126,7 @@ with the following path and query parameters:
| *serverAliveCountMax* (advanced) | Sets the number of keep-alive messages
which may be sent without receiving any messages back from the server. If this
threshold is reached while keep-alive messages are being sent, the connection
will be disconnected. The default value is one. | 1 | int
| *serverAliveInterval* (advanced) | Sets the interval (millis) to send a
keep-alive message. If zero is specified, any keep-alive message must not be
sent. The default interval is zero. | | int
| *soTimeout* (advanced) | Sets the so timeout FTP and FTPS Only for Camel
2.4. SFTP for Camel 2.14.3/2.15.3/2.16 onwards. Is the SocketOptions.SO_TIMEOUT
value in millis. Recommended option is to set this to 300000 so as not have a
hanged connection. On SFTP this option is set as timeout on the JSCH Session
instance. | 300000 | int
-| *stepwise* (advanced) | Sets whether we should stepwise change directories
while traversing file structures when downloading files, or as well when
uploading a file to a directory. You can disable this if you for example are in
a situation where you cannot change directory on the FTP server due security
reasons. | true | boolean
+| *stepwise* (advanced) | Sets whether we should stepwise change directories
while traversing file structures when downloading files, or as well when
uploading a file to a directory. You can disable this if you for example are in
a situation where you cannot change directory on the FTP server due security
reasons. Stepwise cannot be used together with streamDownload. | true | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
| *throwExceptionOnConnectFailed* (advanced) | Should an exception be thrown
if connection failed (exhausted) By default exception is not thrown and a WARN
is logged. You can use this to enable exception being thrown and handle the
thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy
rollback method. | false | boolean
| *timeout* (advanced) | Sets the data timeout for waiting for reply Used only
by FTPClient | 30000 | int
