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 76ca47f Improvements to Docs for FTP components, Javadoc for
GenericFileEndpoint (#2746)
76ca47f is described below
commit 76ca47f817168c22e589be3d38d729f6d895519a
Author: RickJWagner <[email protected]>
AuthorDate: Mon Feb 4 23:44:07 2019 -0600
Improvements to Docs for FTP components, Javadoc for GenericFileEndpoint
(#2746)
* update description of TempFileName
* add javadoc
---
.../main/java/org/apache/camel/component/file/GenericFileEndpoint.java | 2 ++
docs/components/modules/ROOT/pages/ftp-component.adoc | 2 +-
docs/components/modules/ROOT/pages/ftps-component.adoc | 2 +-
docs/components/modules/ROOT/pages/sftp-component.adoc | 2 +-
4 files changed, 5 insertions(+), 3 deletions(-)
diff --git
a/components/camel-file/src/main/java/org/apache/camel/component/file/GenericFileEndpoint.java
b/components/camel-file/src/main/java/org/apache/camel/component/file/GenericFileEndpoint.java
index 9d66b2c..024e761 100644
---
a/components/camel-file/src/main/java/org/apache/camel/component/file/GenericFileEndpoint.java
+++
b/components/camel-file/src/main/java/org/apache/camel/component/file/GenericFileEndpoint.java
@@ -779,6 +779,8 @@ public abstract class GenericFileEndpoint<T> extends
ScheduledPollEndpoint imple
/**
* The same as tempPrefix option but offering a more fine grained control
on the naming of the temporary filename as it uses the File Language.
+ * The location for tempFilename is relative to the final file location in
the option 'fileName', not the target directory in the base uri. i.e. if
option fileName includes a directory prefix,
+ * <dir><finalFilename>, tempFileName is relative to that subdirectory
<dir>
*/
public void setTempFileName(Expression tempFileName) {
this.tempFileName = tempFileName;
diff --git a/docs/components/modules/ROOT/pages/ftp-component.adoc
b/docs/components/modules/ROOT/pages/ftp-component.adoc
index 0521546..c46e004 100644
--- a/docs/components/modules/ROOT/pages/ftp-component.adoc
+++ b/docs/components/modules/ROOT/pages/ftp-component.adoc
@@ -145,7 +145,7 @@ with the following path and query parameters:
| *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
| *jailStartingDirectory* (producer) | Used for jailing (restricting) writing
files to the starting directory (and sub) only. This is enabled by default to
not allow Camel to write files to outside directories (to be more secured out
of the box). You can turn this off to allow writing files to directories
outside the starting directory, such as parent or root folders. | true | 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 d [...]
-| *tempFileName* (producer) | The same as tempPrefix option but offering a
more fine grained control on the naming of the temporary filename as it uses
the File Language. | | String
+| *tempFileName* (producer) | The same as tempPrefix option but offering a
more fine grained control on the naming of the temporary filename as it uses
the File Language. The location for tempFilename is relative to the final file
location in the option 'fileName', not the target directory in the base uri.
i.e. if option fileName includes a directory prefix, <dir>/<finalFilename>,
tempFileName is relative to that subdirectory <dir> | | String
| *tempPrefix* (producer) | This option is used to write the file using a
temporary name and then, after the write is complete, rename it to the real
name. Can be used to identify files being written and also avoid consumers (not
using exclusive read locks) reading in progress files. Is often used by FTP
when uploading big files. | | String
| *allowNullBody* (producer) | Used to specify if a null body is allowed
during file writing. If set to true then an empty file will be created, when
set to false, and attempting to send a null body to the file component, a
GenericFileWriteException of 'Cannot write null body to file.' will be thrown.
If the fileExist option is set to 'Override', then the file will be truncated,
and if set to append the file will remain unchanged. | false | boolean
| *chmod* (producer) | Allows you to set chmod on the stored file. For example
chmod=640. | | String
diff --git a/docs/components/modules/ROOT/pages/ftps-component.adoc
b/docs/components/modules/ROOT/pages/ftps-component.adoc
index d45af94..c0a61df 100644
--- a/docs/components/modules/ROOT/pages/ftps-component.adoc
+++ b/docs/components/modules/ROOT/pages/ftps-component.adoc
@@ -105,7 +105,7 @@ with the following path and query parameters:
| *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
| *jailStartingDirectory* (producer) | Used for jailing (restricting) writing
files to the starting directory (and sub) only. This is enabled by default to
not allow Camel to write files to outside directories (to be more secured out
of the box). You can turn this off to allow writing files to directories
outside the starting directory, such as parent or root folders. | true | 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 d [...]
-| *tempFileName* (producer) | The same as tempPrefix option but offering a
more fine grained control on the naming of the temporary filename as it uses
the File Language. | | String
+| *tempFileName* (producer) | The same as tempPrefix option but offering a
more fine grained control on the naming of the temporary filename as it uses
the File Language. The location for tempFilename is relative to the final file
location in the option 'fileName', not the target directory in the base uri.
i.e. if option fileName includes a directory prefix, <dir>/<finalFilename>,
tempFileName is relative to that subdirectory <dir> | | String
| *tempPrefix* (producer) | This option is used to write the file using a
temporary name and then, after the write is complete, rename it to the real
name. Can be used to identify files being written and also avoid consumers (not
using exclusive read locks) reading in progress files. Is often used by FTP
when uploading big files. | | String
| *allowNullBody* (producer) | Used to specify if a null body is allowed
during file writing. If set to true then an empty file will be created, when
set to false, and attempting to send a null body to the file component, a
GenericFileWriteException of 'Cannot write null body to file.' will be thrown.
If the fileExist option is set to 'Override', then the file will be truncated,
and if set to append the file will remain unchanged. | false | boolean
| *chmod* (producer) | Allows you to set chmod on the stored file. For example
chmod=640. | | String
diff --git a/docs/components/modules/ROOT/pages/sftp-component.adoc
b/docs/components/modules/ROOT/pages/sftp-component.adoc
index 104856e..f93ed2a 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:
| *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
| *jailStartingDirectory* (producer) | Used for jailing (restricting) writing
files to the starting directory (and sub) only. This is enabled by default to
not allow Camel to write files to outside directories (to be more secured out
of the box). You can turn this off to allow writing files to directories
outside the starting directory, such as parent or root folders. | true | 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 d [...]
-| *tempFileName* (producer) | The same as tempPrefix option but offering a
more fine grained control on the naming of the temporary filename as it uses
the File Language. | | String
+| *tempFileName* (producer) | The same as tempPrefix option but offering a
more fine grained control on the naming of the temporary filename as it uses
the File Language. The location for tempFilename is relative to the final file
location in the option 'fileName', not the target directory in the base uri.
i.e. if option fileName includes a directory prefix, <dir>/<finalFilename>,
tempFileName is relative to that subdirectory <dir> | | String
| *tempPrefix* (producer) | This option is used to write the file using a
temporary name and then, after the write is complete, rename it to the real
name. Can be used to identify files being written and also avoid consumers (not
using exclusive read locks) reading in progress files. Is often used by FTP
when uploading big files. | | String
| *allowNullBody* (producer) | Used to specify if a null body is allowed
during file writing. If set to true then an empty file will be created, when
set to false, and attempting to send a null body to the file component, a
GenericFileWriteException of 'Cannot write null body to file.' will be thrown.
If the fileExist option is set to 'Override', then the file will be truncated,
and if set to append the file will remain unchanged. | false | boolean
| *chmod* (producer) | Allows you to set chmod on the stored file. For example
chmod=640. | | String
