[camel] branch master updated: Updated javadocs for soTimeout. (#2770)

[ac...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

acosentino 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 6300cf0  Updated javadocs for soTimeout. (#2770)
6300cf0 is described below

commit 6300cf0b877f3520f9839e5e05973cb3e89e3288
Author: nshendye <ns...@users.noreply.github.com>
AuthorDate: Thu Feb 14 12:29:02 2019 +0530

    Updated javadocs for soTimeout. (#2770)
---
 .../apache/camel/component/file/remote/RemoteFileConfiguration.java  | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

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 d22e1be..cff3f4b 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
@@ -255,7 +255,10 @@ public abstract class RemoteFileConfiguration extends GenericFileConfiguration {
     /**
      * Sets the so timeout
      * <p/>
-     * Used only by FTPClient
+     * 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.
      */
     public void setSoTimeout(int soTimeout) {
         this.soTimeout = soTimeout;