You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by co...@apache.org on 2019/06/27 15:36:34 UTC

[camel] branch master updated: CAMEL-13692 - Updating docs

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

coheigea 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 174a4e1  CAMEL-13692 - Updating docs
174a4e1 is described below

commit 174a4e159e00673eea2e78d3446d03968aeb7518
Author: Colm O hEigeartaigh <co...@apache.org>
AuthorDate: Thu Jun 27 16:35:59 2019 +0100

    CAMEL-13692 - Updating docs
---
 components/camel-ssh/src/main/docs/ssh-component.adoc        |  2 +-
 .../org/apache/camel/component/ssh/SshConfiguration.java     |  5 +++--
 .../builder/endpoint/dsl/SshEndpointBuilderFactory.java      | 12 +++++++++---
 .../component/ssh/springboot/SshComponentConfiguration.java  |  4 +++-
 4 files changed, 16 insertions(+), 7 deletions(-)

diff --git a/components/camel-ssh/src/main/docs/ssh-component.adoc b/components/camel-ssh/src/main/docs/ssh-component.adoc
index 3215588..795626f 100644
--- a/components/camel-ssh/src/main/docs/ssh-component.adoc
+++ b/components/camel-ssh/src/main/docs/ssh-component.adoc
@@ -115,7 +115,7 @@ with the following path and query parameters:
 | *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
 | *certResource* (security) | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate, and depends on keyType setting. |  | String
 | *keyPairProvider* (security) | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. |  | KeyPairProvider
-| *keyType* (security) | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa. |  | String
+| *keyType* (security) | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. From Camel 3.0.0 / 2.25.0, by default Camel will select the first available KeyPair that is loaded. Prior to this, a KeyType of 'ssh-rsa' was enforced by default. |  | String
 | *password* (security) | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. |  | String
 | *username* (security) | Sets the username to use in logging into the remote SSH server. |  | String
 |===
diff --git a/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshConfiguration.java b/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshConfiguration.java
index 85c061a..9899a2d6 100644
--- a/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshConfiguration.java
+++ b/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshConfiguration.java
@@ -202,8 +202,9 @@ public class SshConfiguration implements Cloneable {
 
     /**
      * Sets the key type to pass to the KeyPairProvider as part of authentication.
-     * KeyPairProvider.loadKey(...) will be passed this value. Defaults to
-     * "ssh-rsa".
+     * KeyPairProvider.loadKey(...) will be passed this value. From Camel 3.0.0 / 2.25.0,
+     * by default Camel will select the first available KeyPair that is loaded. Prior to
+     * this, a KeyType of 'ssh-rsa' was enforced by default.
      *
      * @param keyType
      *            String defining the type of KeyPair to use for authentication.
diff --git a/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/SshEndpointBuilderFactory.java b/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/SshEndpointBuilderFactory.java
index c255557..73eabe8 100644
--- a/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/SshEndpointBuilderFactory.java
+++ b/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/SshEndpointBuilderFactory.java
@@ -525,7 +525,9 @@ public interface SshEndpointBuilderFactory {
         /**
          * Sets the key type to pass to the KeyPairProvider as part of
          * authentication. KeyPairProvider.loadKey(...) will be passed this
-         * value. Defaults to ssh-rsa.
+         * value. From Camel 3.0.0 / 2.25.0, by default Camel will select the
+         * first available KeyPair that is loaded. Prior to this, a KeyType of
+         * 'ssh-rsa' was enforced by default.
          * The option is a <code>java.lang.String</code> type.
          * @group security
          */
@@ -892,7 +894,9 @@ public interface SshEndpointBuilderFactory {
         /**
          * Sets the key type to pass to the KeyPairProvider as part of
          * authentication. KeyPairProvider.loadKey(...) will be passed this
-         * value. Defaults to ssh-rsa.
+         * value. From Camel 3.0.0 / 2.25.0, by default Camel will select the
+         * first available KeyPair that is loaded. Prior to this, a KeyType of
+         * 'ssh-rsa' was enforced by default.
          * The option is a <code>java.lang.String</code> type.
          * @group security
          */
@@ -1141,7 +1145,9 @@ public interface SshEndpointBuilderFactory {
         /**
          * Sets the key type to pass to the KeyPairProvider as part of
          * authentication. KeyPairProvider.loadKey(...) will be passed this
-         * value. Defaults to ssh-rsa.
+         * value. From Camel 3.0.0 / 2.25.0, by default Camel will select the
+         * first available KeyPair that is loaded. Prior to this, a KeyType of
+         * 'ssh-rsa' was enforced by default.
          * The option is a <code>java.lang.String</code> type.
          * @group security
          */
diff --git a/platforms/spring-boot/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java
index c0b305b..b8e6a32 100644
--- a/platforms/spring-boot/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java
@@ -273,7 +273,9 @@ public class SshComponentConfiguration
         /**
          * Sets the key type to pass to the KeyPairProvider as part of
          * authentication. KeyPairProvider.loadKey(...) will be passed this
-         * value. Defaults to "ssh-rsa".
+         * value. From Camel 3.0.0 / 2.25.0, by default Camel will select the
+         * first available KeyPair that is loaded. Prior to this, a KeyType of
+         * 'ssh-rsa' was enforced by default.
          */
         private String keyType;
         /**