camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davscl...@apache.org
Subject [camel] 03/03: CAMEL-11971: SFTP consumer to support useList
Date Wed, 01 Nov 2017 09:19:30 GMT
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

commit c79c36fba1cb9027d634d03a4432eed3a0269d06
Author: Claus Ibsen <claus.ibsen@gmail.com>
AuthorDate: Wed Nov 1 10:19:02 2017 +0100

    CAMEL-11971: SFTP consumer to support useList
---
 components/camel-ftp/src/main/docs/ftp-component.adoc                  | 2 +-
 components/camel-ftp/src/main/docs/ftps-component.adoc                 | 2 +-
 components/camel-ftp/src/main/docs/sftp-component.adoc                 | 3 ++-
 .../main/java/org/apache/camel/component/file/remote/SftpEndpoint.java | 2 +-
 4 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/components/camel-ftp/src/main/docs/ftp-component.adoc b/components/camel-ftp/src/main/docs/ftp-component.adoc
index 66c986d..3c9de24 100644
--- a/components/camel-ftp/src/main/docs/ftp-component.adoc
+++ b/components/camel-ftp/src/main/docs/ftp-component.adoc
@@ -131,7 +131,7 @@ with the following path and query parameters:
 | *processStrategy* (consumer) | A pluggable org.apache.camel.component.file.GenericFileProcessStrategy
allowing you to implement your own readLock option or similar. Can also be used when special
conditions must be met before a file can be consumed such as a special ready file exists.
If this option is set then the readLock option does not apply. |  | GenericFileProcess Strategy<T>
 | *receiveBufferSize* (consumer) | The receive (download) buffer size Used only by FTPClient
| 32768 | int
 | *startingDirectoryMustExist* (consumer) | Whether the starting directory must exist. Mind
that the autoCreate option is default enabled which means the starting directory is normally
auto created if it doesn't exist. You can disable autoCreate and enable this to ensure the
starting directory must exist. Will thrown an exception if the directory doesn't exist. |
false | boolean
-| *useList* (consumer) | Whether to allow using LIST command when downloading a file. Default
is true. In some use cases you may want to download a specific file and are not allowed to
use the LIST command and therefore you can set this option to false. Notice when using this
option then the specific file to download does not include meta-data information such as file
size timestamp permissions etc because those information is only possible to retrieve when
LIST command is in use. This o [...]
+| *useList* (consumer) | Whether to allow using LIST command when downloading a file. Default
is true. In some use cases you may want to download a specific file and are not allowed to
use the LIST command and therefore you can set this option to false. Notice when using this
option then the specific file to download does not include meta-data information such as file
size timestamp permissions etc because those information is only possible to retrieve when
LIST command is in use. | true [...]
 | *fileExist* (producer) | What to do if a file already exists with the same name. Override
which is the default replaces the existing file. Append - adds content to the existing file.
Fail - throws a GenericFileOperationException indicating that there is already an existing
file. Ignore - silently ignores the problem and does not override the existing file but assumes
everything is okay. Move - option requires to use the moveExisting option to be configured
as well. The option eagerDele [...]
 | *flatten* (producer) | Flatten is used to flatten the file name path to strip any leading
paths so it's just the file name. This allows you to consume recursively into sub-directories
but when you eg write the files to another directory they will be written in a single directory.
Setting this to true on the producer enforces that any file name in CamelFileName header will
be stripped for any leading paths. | false | boolean
 | *moveExisting* (producer) | Expression (such as File Language) used to compute file name
to use when fileExist=Move is configured. To move files into a backup subdirectory just enter
backup. This option only supports the following File Language tokens: file:name file:name.ext
file:name.noext file:onlyname file:onlyname.noext file:ext and file:parent. Notice the file:parent
is not supported by the FTP component as the FTP component can only move any existing files
to a relative director [...]
diff --git a/components/camel-ftp/src/main/docs/ftps-component.adoc b/components/camel-ftp/src/main/docs/ftps-component.adoc
index 4d283e2..3c6260e 100644
--- a/components/camel-ftp/src/main/docs/ftps-component.adoc
+++ b/components/camel-ftp/src/main/docs/ftps-component.adoc
@@ -91,7 +91,7 @@ with the following path and query parameters:
 | *processStrategy* (consumer) | A pluggable org.apache.camel.component.file.GenericFileProcessStrategy
allowing you to implement your own readLock option or similar. Can also be used when special
conditions must be met before a file can be consumed such as a special ready file exists.
If this option is set then the readLock option does not apply. |  | GenericFileProcess Strategy<T>
 | *receiveBufferSize* (consumer) | The receive (download) buffer size Used only by FTPClient
| 32768 | int
 | *startingDirectoryMustExist* (consumer) | Whether the starting directory must exist. Mind
that the autoCreate option is default enabled which means the starting directory is normally
auto created if it doesn't exist. You can disable autoCreate and enable this to ensure the
starting directory must exist. Will thrown an exception if the directory doesn't exist. |
false | boolean
-| *useList* (consumer) | Whether to allow using LIST command when downloading a file. Default
is true. In some use cases you may want to download a specific file and are not allowed to
use the LIST command and therefore you can set this option to false. Notice when using this
option then the specific file to download does not include meta-data information such as file
size timestamp permissions etc because those information is only possible to retrieve when
LIST command is in use. This o [...]
+| *useList* (consumer) | Whether to allow using LIST command when downloading a file. Default
is true. In some use cases you may want to download a specific file and are not allowed to
use the LIST command and therefore you can set this option to false. Notice when using this
option then the specific file to download does not include meta-data information such as file
size timestamp permissions etc because those information is only possible to retrieve when
LIST command is in use. | true [...]
 | *fileExist* (producer) | What to do if a file already exists with the same name. Override
which is the default replaces the existing file. Append - adds content to the existing file.
Fail - throws a GenericFileOperationException indicating that there is already an existing
file. Ignore - silently ignores the problem and does not override the existing file but assumes
everything is okay. Move - option requires to use the moveExisting option to be configured
as well. The option eagerDele [...]
 | *flatten* (producer) | Flatten is used to flatten the file name path to strip any leading
paths so it's just the file name. This allows you to consume recursively into sub-directories
but when you eg write the files to another directory they will be written in a single directory.
Setting this to true on the producer enforces that any file name in CamelFileName header will
be stripped for any leading paths. | false | boolean
 | *moveExisting* (producer) | Expression (such as File Language) used to compute file name
to use when fileExist=Move is configured. To move files into a backup subdirectory just enter
backup. This option only supports the following File Language tokens: file:name file:name.ext
file:name.noext file:onlyname file:onlyname.noext file:ext and file:parent. Notice the file:parent
is not supported by the FTP component as the FTP component can only move any existing files
to a relative director [...]
diff --git a/components/camel-ftp/src/main/docs/sftp-component.adoc b/components/camel-ftp/src/main/docs/sftp-component.adoc
index 9c22896..d00e65a 100644
--- a/components/camel-ftp/src/main/docs/sftp-component.adoc
+++ b/components/camel-ftp/src/main/docs/sftp-component.adoc
@@ -48,7 +48,7 @@ with the following path and query parameters:
 | *directoryName* | The starting directory |  | String
 |===
 
-==== Query Parameters (109 parameters):
+==== Query Parameters (110 parameters):
 
 [width="100%",cols="2,5,^1,2",options="header"]
 |===
@@ -79,6 +79,7 @@ with the following path and query parameters:
 | *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy
allowing you to provide your custom implementation to control error handling usually occurred
during the poll operation before an Exchange have been created and being routed in Camel.
|  | PollingConsumerPoll Strategy
 | *processStrategy* (consumer) | A pluggable org.apache.camel.component.file.GenericFileProcessStrategy
allowing you to implement your own readLock option or similar. Can also be used when special
conditions must be met before a file can be consumed such as a special ready file exists.
If this option is set then the readLock option does not apply. |  | GenericFileProcess Strategy<T>
 | *startingDirectoryMustExist* (consumer) | Whether the starting directory must exist. Mind
that the autoCreate option is default enabled which means the starting directory is normally
auto created if it doesn't exist. You can disable autoCreate and enable this to ensure the
starting directory must exist. Will thrown an exception if the directory doesn't exist. |
false | boolean
+| *useList* (consumer) | Whether to allow using LIST command when downloading a file. Default
is true. In some use cases you may want to download a specific file and are not allowed to
use the LIST command and therefore you can set this option to false. Notice when using this
option then the specific file to download does not include meta-data information such as file
size timestamp permissions etc because those information is only possible to retrieve when
LIST command is in use. | true [...]
 | *fileExist* (producer) | What to do if a file already exists with the same name. Override
which is the default replaces the existing file. Append - adds content to the existing file.
Fail - throws a GenericFileOperationException indicating that there is already an existing
file. Ignore - silently ignores the problem and does not override the existing file but assumes
everything is okay. Move - option requires to use the moveExisting option to be configured
as well. The option eagerDele [...]
 | *flatten* (producer) | Flatten is used to flatten the file name path to strip any leading
paths so it's just the file name. This allows you to consume recursively into sub-directories
but when you eg write the files to another directory they will be written in a single directory.
Setting this to true on the producer enforces that any file name in CamelFileName header will
be stripped for any leading paths. | false | boolean
 | *moveExisting* (producer) | Expression (such as File Language) used to compute file name
to use when fileExist=Move is configured. To move files into a backup subdirectory just enter
backup. This option only supports the following File Language tokens: file:name file:name.ext
file:name.noext file:onlyname file:onlyname.noext file:ext and file:parent. Notice the file:parent
is not supported by the FTP component as the FTP component can only move any existing files
to a relative director [...]
diff --git a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/SftpEndpoint.java
b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/SftpEndpoint.java
index 1ee23e8..8bfeb4f 100644
--- a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/SftpEndpoint.java
+++ b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/SftpEndpoint.java
@@ -29,7 +29,7 @@ import org.apache.camel.spi.UriParam;
  */
 @UriEndpoint(firstVersion = "1.1.0", scheme = "sftp", extendsScheme = "file", title = "SFTP",
         syntax = "sftp:host:port/directoryName", consumerClass = SftpConsumer.class, label
= "file",
-        excludeProperties = "binary,passiveMode,receiveBufferSize,siteCommand,useList")
+        excludeProperties = "binary,passiveMode,receiveBufferSize,siteCommand")
 public class SftpEndpoint extends RemoteFileEndpoint<SftpRemoteFile> {
 
     @UriParam

-- 
To stop receiving notification emails like this one, please contact
"commits@camel.apache.org" <commits@camel.apache.org>.

Mime
View raw message