SpringCloud/spring-functions-catalog
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify sftp-supplier docs

Browse Source 
* Highlight the `ref` mode invalid when streaming
* Use properties rather than shell options in docs

See https://github.com/spring-cloud/spring-cloud-dataflow/issues/5225
This commit is contained in:
Chris Bono
2023-02-23 08:10:17 -06:00
committed by GitHub
parent b2b3f335df
commit 86a5746f39
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
supplier/sftp-supplier/README.adoc
View File

@@ -8,17 +8,18 @@ These include:
* Stream remote file contents as a byte array directly without copying to a local directory.
* List the remote file names only.
Messages emitted by the supplier are provided as a byte array by default. However, this can be customized using the `--mode` option:
Messages emitted by the supplier are provided as a byte array by default. However, this can be customized using the `mode` option:
- *ref* Provides a `java.io.File` reference
- *lines* Will split files line-by-line and emit a new message for each line
- *contents* The default. Provides the contents of a file as a byte array
NOTE: The `ref` mode (`file.consumer.mode=ref`) is not compatible when streaming results (`sftp.stream=true`).
NOTE: When using `--mode=lines`, you can provide an additional option `--withMarkers=true`.
NOTE: When using the `lines` mode, you can provide an additional `withMarker` option (via the `file.consumer.with-marker` property).
If set to `true`, the underlying `FileSplitter` will emit additional _start-of-file_ and _end-of-file_ marker messages before and after the actual data.
The payload of these 2 additional marker messages is of type `FileSplitter.FileMarker`.
The option `withMarkers` defaults to `false` if not explicitly set.
When not explicitly set, the option defaults to `false`.
When configuring the `sftp.factory.known-hosts-expression` option, the root object of the evaluation is the application context, an example might be `sftp.factory.known-hosts-expression = @systemProperties['user.home'] + '/.ssh/known_hosts'`.
@@ -71,7 +72,7 @@ Once injected, you can use the `get` method of the `Supplier` to invoke it and t
## Configuration Options
All configuration properties are prefixed with `ftp.supplier`.
All configuration properties are prefixed with `sftp.supplier`.
There are also properties that need to be used with the prefix `file.consumer`.
For more information on the various options available, please see link:src/main/java/org/springframework/cloud/fn/supplier/sftp/SftpSupplierProperties.java[SftpSupplierProperties].
@@ -83,4 +84,4 @@ See this link:src/test/java/org/springframework/cloud/fn/supplier/sftp/SftpSuppl
## Other usage
See this link:../../../applications/source/sftp-source/README.adoc[README] where this supplier is used to create a Spring Cloud Stream application that provides an Sftp Source.
See this link:../../../applications/source/sftp-source/README.adoc[README] where this supplier is used to create a Spring Cloud Stream application that provides an Sftp Source.