camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davscl...@apache.org
Subject camel git commit: CAMEL-10900: Improved docs about big files and charset
Date Mon, 27 Feb 2017 08:54:06 GMT
Repository: camel
Updated Branches:
  refs/heads/master 18e48a1fc -> 89f6979fd


CAMEL-10900: Improved docs about big files and charset


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/89f6979f
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/89f6979f
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/89f6979f

Branch: refs/heads/master
Commit: 89f6979fd3050a2fdd2be7bc5788afc5345d6661
Parents: 18e48a1
Author: Claus Ibsen <davsclaus@apache.org>
Authored: Mon Feb 27 09:53:59 2017 +0100
Committer: Claus Ibsen <davsclaus@apache.org>
Committed: Mon Feb 27 09:53:59 2017 +0100

----------------------------------------------------------------------
 camel-core/src/main/docs/file-component.adoc                     | 4 ++--
 .../org/apache/camel/component/file/GenericFileEndpoint.java     | 2 ++
 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 ++--
 5 files changed, 10 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/89f6979f/camel-core/src/main/docs/file-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/file-component.adoc b/camel-core/src/main/docs/file-component.adoc
index 49fb842..651a102 100644
--- a/camel-core/src/main/docs/file-component.adoc
+++ b/camel-core/src/main/docs/file-component.adoc
@@ -67,7 +67,7 @@ The File component supports 81 endpoint options which are listed below:
 |=======================================================================
 | Name | Group | Default | Java Type | Description
 | directoryName | common |  | File | *Required* The starting directory
-| charset | common |  | String | This option is used to specify the encoding of the file.
You can use this on the consumer to specify the encodings of the files which allow Camel to
know the charset it should load the file content in case the file content is being accessed.
Likewise when writing a file you can use this option to specify which charset to write the
file as well.
+| charset | common |  | String | This option is used to specify the encoding of the file.
You can use this on the consumer to specify the encodings of the files which allow Camel to
know the charset it should load the file content in case the file content is being accessed.
Likewise when writing a file you can use this option to specify which charset to write the
file as well. Do mind that when writing the file Camel may have to read the message content
into memory to be able to convert the data into the configured charset so do not use this
if you have big messages.
 | doneFileName | common |  | String | Producer: If provided then Camel will write a 2nd done
file when the original file has been written. The done file will be empty. This option configures
what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.
The done file will always be written in the same folder as the original file. Consumer: If
provided Camel will only consume files if a done file exists. This option configures what
file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The
done file is always expected in the same folder as the original file. Only $file.name and
$file.name.noext is supported as dynamic placeholders.
 | fileName | common |  | String | Use Expression such as File Language to dynamically set
the filename. For consumers it's used as a filename filter. For producers it's used to evaluate
the filename to write. If an expression is set it take precedence over the CamelFileName header.
(Note: The header itself can also be an Expression). The expression options support both String
and Expression types. If the expression is a String type it is always evaluated using the
File Language. If the expression is an Expression type the specified Expression type is used
- this allows you for instance to use OGNL expressions. For the consumer you can use it to
filter filenames so you can for instance consume today's file using the File Language syntax:
mydata-$date:now:yyyyMMdd.txt. The producers support the CamelOverruleFileName header which
takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header
that is used only once and makes it easier as this avoids to te
 mporary store CamelFileName and have to restore it afterwards.
 | bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the
Camel routing Error Handler which mean any exceptions occurred while the consumer is trying
to pickup incoming messages or the likes will now be processed as a message and handled by
the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler
to deal with exceptions that will be logged at WARN/ERROR level and ignored.
@@ -1165,4 +1165,4 @@ problems.
 
 * link:file-language.html[File Language]
 * link:ftp2.html[FTP]
-* link:polling-consumer.html[Polling Consumer]
\ No newline at end of file
+* link:polling-consumer.html[Polling Consumer]

http://git-wip-us.apache.org/repos/asf/camel/blob/89f6979f/camel-core/src/main/java/org/apache/camel/component/file/GenericFileEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/file/GenericFileEndpoint.java
b/camel-core/src/main/java/org/apache/camel/component/file/GenericFileEndpoint.java
index c9807b1..0bea0ba 100644
--- a/camel-core/src/main/java/org/apache/camel/component/file/GenericFileEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/file/GenericFileEndpoint.java
@@ -617,6 +617,8 @@ public abstract class GenericFileEndpoint<T> extends ScheduledPollEndpoint
imple
      * You can use this on the consumer, to specify the encodings of the files, which allow
Camel to know the charset
      * it should load the file content in case the file content is being accessed.
      * Likewise when writing a file, you can use this option to specify which charset to
write the file as well.
+     * Do mind that when writing the file Camel may have to read the message content into
memory to be able to
+     * convert the data into the configured charset, so do not use this if you have big messages.
      */
     public void setCharset(String charset) {
         IOHelper.validateCharset(charset);

http://git-wip-us.apache.org/repos/asf/camel/blob/89f6979f/components/camel-ftp/src/main/docs/ftp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ftp/src/main/docs/ftp-component.adoc b/components/camel-ftp/src/main/docs/ftp-component.adoc
index 9c2d2f9..a46285b 100644
--- a/components/camel-ftp/src/main/docs/ftp-component.adoc
+++ b/components/camel-ftp/src/main/docs/ftp-component.adoc
@@ -89,7 +89,7 @@ The FTP component supports 105 endpoint options which are listed below:
 | port | common |  | int | Port of the FTP server
 | directoryName | common |  | String | The starting directory
 | binary | common | false | boolean | Specifies the file transfer mode BINARY or ASCII. Default
is ASCII (false).
-| charset | common |  | String | This option is used to specify the encoding of the file.
You can use this on the consumer to specify the encodings of the files which allow Camel to
know the charset it should load the file content in case the file content is being accessed.
Likewise when writing a file you can use this option to specify which charset to write the
file as well.
+| charset | common |  | String | This option is used to specify the encoding of the file.
You can use this on the consumer to specify the encodings of the files which allow Camel to
know the charset it should load the file content in case the file content is being accessed.
Likewise when writing a file you can use this option to specify which charset to write the
file as well. Do mind that when writing the file Camel may have to read the message content
into memory to be able to convert the data into the configured charset so do not use this
if you have big messages.
 | disconnect | common | false | boolean | Whether or not to disconnect from remote FTP server
right after use. Disconnect will only disconnect the current connection to the FTP server.
If you have a consumer which you want to stop then you need to stop the consumer/route instead.
 | doneFileName | common |  | String | Producer: If provided then Camel will write a 2nd done
file when the original file has been written. The done file will be empty. This option configures
what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.
The done file will always be written in the same folder as the original file. Consumer: If
provided Camel will only consume files if a done file exists. This option configures what
file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The
done file is always expected in the same folder as the original file. Only $file.name and
$file.name.noext is supported as dynamic placeholders.
 | fileName | common |  | String | Use Expression such as File Language to dynamically set
the filename. For consumers it's used as a filename filter. For producers it's used to evaluate
the filename to write. If an expression is set it take precedence over the CamelFileName header.
(Note: The header itself can also be an Expression). The expression options support both String
and Expression types. If the expression is a String type it is always evaluated using the
File Language. If the expression is an Expression type the specified Expression type is used
- this allows you for instance to use OGNL expressions. For the consumer you can use it to
filter filenames so you can for instance consume today's file using the File Language syntax:
mydata-$date:now:yyyyMMdd.txt. The producers support the CamelOverruleFileName header which
takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header
that is used only once and makes it easier as this avoids to te
 mporary store CamelFileName and have to restore it afterwards.
@@ -739,4 +739,4 @@ problems.
 * link:endpoint.html[Endpoint]
 * link:getting-started.html[Getting Started]
 
-* link:file2.html[File2]
\ No newline at end of file
+* link:file2.html[File2]

http://git-wip-us.apache.org/repos/asf/camel/blob/89f6979f/components/camel-ftp/src/main/docs/ftps-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ftp/src/main/docs/ftps-component.adoc b/components/camel-ftp/src/main/docs/ftps-component.adoc
index 62cf224..b6fd5cd 100644
--- a/components/camel-ftp/src/main/docs/ftps-component.adoc
+++ b/components/camel-ftp/src/main/docs/ftps-component.adoc
@@ -40,7 +40,7 @@ The FTPS component supports 113 endpoint options which are listed below:
 | port | common |  | int | Port of the FTP server
 | directoryName | common |  | String | The starting directory
 | binary | common | false | boolean | Specifies the file transfer mode BINARY or ASCII. Default
is ASCII (false).
-| charset | common |  | String | This option is used to specify the encoding of the file.
You can use this on the consumer to specify the encodings of the files which allow Camel to
know the charset it should load the file content in case the file content is being accessed.
Likewise when writing a file you can use this option to specify which charset to write the
file as well.
+| charset | common |  | String | This option is used to specify the encoding of the file.
You can use this on the consumer to specify the encodings of the files which allow Camel to
know the charset it should load the file content in case the file content is being accessed.
Likewise when writing a file you can use this option to specify which charset to write the
file as well. Do mind that when writing the file Camel may have to read the message content
into memory to be able to convert the data into the configured charset so do not use this
if you have big messages.
 | disconnect | common | false | boolean | Whether or not to disconnect from remote FTP server
right after use. Disconnect will only disconnect the current connection to the FTP server.
If you have a consumer which you want to stop then you need to stop the consumer/route instead.
 | doneFileName | common |  | String | Producer: If provided then Camel will write a 2nd done
file when the original file has been written. The done file will be empty. This option configures
what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.
The done file will always be written in the same folder as the original file. Consumer: If
provided Camel will only consume files if a done file exists. This option configures what
file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The
done file is always expected in the same folder as the original file. Only $file.name and
$file.name.noext is supported as dynamic placeholders.
 | fileName | common |  | String | Use Expression such as File Language to dynamically set
the filename. For consumers it's used as a filename filter. For producers it's used to evaluate
the filename to write. If an expression is set it take precedence over the CamelFileName header.
(Note: The header itself can also be an Expression). The expression options support both String
and Expression types. If the expression is a String type it is always evaluated using the
File Language. If the expression is an Expression type the specified Expression type is used
- this allows you for instance to use OGNL expressions. For the consumer you can use it to
filter filenames so you can for instance consume today's file using the File Language syntax:
mydata-$date:now:yyyyMMdd.txt. The producers support the CamelOverruleFileName header which
takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header
that is used only once and makes it easier as this avoids to te
 mporary store CamelFileName and have to restore it afterwards.
@@ -151,4 +151,4 @@ The FTPS component supports 113 endpoint options which are listed below:
 | username | security |  | String | Username to use for login
 |=======================================================================
 {% endraw %}
-// endpoint options: END
\ No newline at end of file
+// endpoint options: END

http://git-wip-us.apache.org/repos/asf/camel/blob/89f6979f/components/camel-ftp/src/main/docs/sftp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ftp/src/main/docs/sftp-component.adoc b/components/camel-ftp/src/main/docs/sftp-component.adoc
index 07d6644..757ac18 100644
--- a/components/camel-ftp/src/main/docs/sftp-component.adoc
+++ b/components/camel-ftp/src/main/docs/sftp-component.adoc
@@ -39,7 +39,7 @@ The SFTP component supports 112 endpoint options which are listed below:
 | host | common |  | String | *Required* Hostname of the FTP server
 | port | common |  | int | Port of the FTP server
 | directoryName | common |  | String | The starting directory
-| charset | common |  | String | This option is used to specify the encoding of the file.
You can use this on the consumer to specify the encodings of the files which allow Camel to
know the charset it should load the file content in case the file content is being accessed.
Likewise when writing a file you can use this option to specify which charset to write the
file as well.
+| charset | common |  | String | This option is used to specify the encoding of the file.
You can use this on the consumer to specify the encodings of the files which allow Camel to
know the charset it should load the file content in case the file content is being accessed.
Likewise when writing a file you can use this option to specify which charset to write the
file as well. Do mind that when writing the file Camel may have to read the message content
into memory to be able to convert the data into the configured charset so do not use this
if you have big messages.
 | disconnect | common | false | boolean | Whether or not to disconnect from remote FTP server
right after use. Disconnect will only disconnect the current connection to the FTP server.
If you have a consumer which you want to stop then you need to stop the consumer/route instead.
 | doneFileName | common |  | String | Producer: If provided then Camel will write a 2nd done
file when the original file has been written. The done file will be empty. This option configures
what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.
The done file will always be written in the same folder as the original file. Consumer: If
provided Camel will only consume files if a done file exists. This option configures what
file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The
done file is always expected in the same folder as the original file. Only $file.name and
$file.name.noext is supported as dynamic placeholders.
 | fileName | common |  | String | Use Expression such as File Language to dynamically set
the filename. For consumers it's used as a filename filter. For producers it's used to evaluate
the filename to write. If an expression is set it take precedence over the CamelFileName header.
(Note: The header itself can also be an Expression). The expression options support both String
and Expression types. If the expression is a String type it is always evaluated using the
File Language. If the expression is an Expression type the specified Expression type is used
- this allows you for instance to use OGNL expressions. For the consumer you can use it to
filter filenames so you can for instance consume today's file using the File Language syntax:
mydata-$date:now:yyyyMMdd.txt. The producers support the CamelOverruleFileName header which
takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header
that is used only once and makes it easier as this avoids to te
 mporary store CamelFileName and have to restore it afterwards.
@@ -150,4 +150,4 @@ The SFTP component supports 112 endpoint options which are listed below:
 | useUserKnownHostsFile | security | true | boolean | If knownHostFile has not been explicit
configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts
 |=======================================================================
 {% endraw %}
-// endpoint options: END
\ No newline at end of file
+// endpoint options: END


Mime
View raw message