Component docs

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

Branch: refs/heads/master
Commit: 350113734a8418853d527f78845ba9e67d970ac1
Parents: d486ee8
Author: Claus Ibsen <davscl...@apache.org>
Authored: Sun Jun 14 16:08:23 2015 +0200
Committer: Claus Ibsen <davscl...@apache.org>
Committed: Sun Jun 14 16:08:23 2015 +0200

----------------------------------------------------------------------
 .../camel/component/scp/ScpConfiguration.java   | 56 +++++---------------
 .../camel/tools/apt/DocumentationHelper.java    |  2 +
 2 files changed, 16 insertions(+), 42 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/35011373/components/camel-jsch/src/main/java/org/apache/camel/component/scp/ScpConfiguration.java
----------------------------------------------------------------------
diff --git 
a/components/camel-jsch/src/main/java/org/apache/camel/component/scp/ScpConfiguration.java
 
b/components/camel-jsch/src/main/java/org/apache/camel/component/scp/ScpConfiguration.java
index d4292d0..1cfb5e9 100644
--- 
a/components/camel-jsch/src/main/java/org/apache/camel/component/scp/ScpConfiguration.java
+++ 
b/components/camel-jsch/src/main/java/org/apache/camel/component/scp/ScpConfiguration.java
@@ -32,8 +32,6 @@ public class ScpConfiguration extends RemoteFileConfiguration 
{
     public static final String DEFAULT_MOD = "664";
     @UriParam(defaultValue = "true")
     private boolean useUserKnownHostsFile = true;
-    @UriParam(defaultValue = "true")
-    private boolean verboseLogging = true;
     @UriParam
     private String knownHostsFile;
     @UriParam
@@ -42,18 +40,12 @@ public class ScpConfiguration extends 
RemoteFileConfiguration {
     private String privateKeyFilePassphrase;
     @UriParam(enums = "no,yes", defaultValue = "no")
     private String strictHostKeyChecking;
-    @UriParam
-    private int serverAliveInterval;
-    @UriParam(defaultValue = "1")
-    private int serverAliveCountMax = 1;
     @UriParam(defaultValue = DEFAULT_MOD)
     private String chmod = DEFAULT_MOD;
     // comma separated list of ciphers. 
     // null means default jsch list will be used
     @UriParam
     private String ciphers;
-    @UriParam
-    private int compression;
 
     public ScpConfiguration() {
         setProtocol("scp");
@@ -72,6 +64,9 @@ public class ScpConfiguration extends RemoteFileConfiguration 
{
         return knownHostsFile;
     }
 
+    /**
+     * Sets the known_hosts file, so that the jsch endpoint can do host key 
verification.
+     */
     public void setKnownHostsFile(String knownHostsFile) {
         this.knownHostsFile = knownHostsFile;
     }
@@ -91,6 +86,9 @@ public class ScpConfiguration extends RemoteFileConfiguration 
{
         return privateKeyFile;
     }
 
+    /**
+     * Set the private key file to that the SFTP endpoint can do private key 
verification.
+     */
     public void setPrivateKeyFile(String privateKeyFile) {
         this.privateKeyFile = privateKeyFile;
     }
@@ -99,6 +97,9 @@ public class ScpConfiguration extends RemoteFileConfiguration 
{
         return privateKeyFilePassphrase;
     }
 
+    /**
+     * Set the private key file passphrase to that the SFTP endpoint can do 
private key verification.
+     */
     public void setPrivateKeyFilePassphrase(String privateKeyFilePassphrase) {
         this.privateKeyFilePassphrase = privateKeyFilePassphrase;
     }
@@ -114,22 +115,6 @@ public class ScpConfiguration extends 
RemoteFileConfiguration {
         this.strictHostKeyChecking = strictHostKeyChecking;
     }
 
-    public void setServerAliveInterval(int serverAliveInterval) {
-        this.serverAliveInterval = serverAliveInterval;
-    }
-
-    public int getServerAliveInterval() {
-        return serverAliveInterval;
-    }
-
-    public void setServerAliveCountMax(int serverAliveCountMax) {
-        this.serverAliveCountMax = serverAliveCountMax;
-    }
-
-    public int getServerAliveCountMax() {
-        return serverAliveCountMax;
-    }
-
     /**
      * Allows you to set chmod on the stored file. For example chmod=664.
      */
@@ -152,6 +137,11 @@ public class ScpConfiguration extends 
RemoteFileConfiguration {
         return chmod;
     }
 
+    /**
+     * Set a comma separated list of ciphers that will be used in order of 
preference.
+     * Possible cipher names are defined by JCraft JSCH. Some examples 
include: 
aes128-ctr,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,aes192-cbc,aes256-cbc.
+     * If not specified the default list from JSCH will be used.
+     */
     public void setCiphers(String ciphers) {
         this.ciphers = ciphers;
     }
@@ -160,22 +150,4 @@ public class ScpConfiguration extends 
RemoteFileConfiguration {
         return ciphers;
     }
 
-    public int getCompression() {
-        return compression;
-    }
-
-    public void setCompression(int compression) {
-        this.compression = compression;
-    }
-
-    public boolean isVerboseLogging() {
-        return verboseLogging;
-    }
-
-    /**
-     * To enable verbose logging
-     */
-    public void setVerboseLogging(boolean verboseLogging) {
-        this.verboseLogging = verboseLogging;
-    }
 }

http://git-wip-us.apache.org/repos/asf/camel/blob/35011373/tooling/apt/src/main/java/org/apache/camel/tools/apt/DocumentationHelper.java
----------------------------------------------------------------------
diff --git 
a/tooling/apt/src/main/java/org/apache/camel/tools/apt/DocumentationHelper.java 
b/tooling/apt/src/main/java/org/apache/camel/tools/apt/DocumentationHelper.java
index f354f38..61daf5d 100644
--- 
a/tooling/apt/src/main/java/org/apache/camel/tools/apt/DocumentationHelper.java
+++ 
b/tooling/apt/src/main/java/org/apache/camel/tools/apt/DocumentationHelper.java
@@ -100,6 +100,8 @@ public final class DocumentationHelper {
             return new 
File("../camel-ahc/target/classes/org/apache/camel/component/ahc/ahc.json");
         } else if ("atom".equals(extendsScheme)) {
             return new 
File("../camel-atom/target/classes/org/apache/camel/component/atom/atom.json");
+        } else if ("ftp".equals(extendsScheme)) {
+            return new 
File("../camel-ftp/target/classes/org/apache/camel/component/file/remote/ftp.json");
         } else if ("jms".equals(extendsScheme)) {
             return new 
File("../camel-jms/target/classes/org/apache/camel/component/jms/jms.json");
         } else if ("http".equals(extendsScheme)) {

Reply via email to