You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2016/06/08 12:56:41 UTC
camel git commit: Added camel-ssh docs to Gitbook
Repository: camel
Updated Branches:
refs/heads/master 8e6091b43 -> 48e5785be
Added camel-ssh docs to Gitbook
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/48e5785b
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/48e5785b
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/48e5785b
Branch: refs/heads/master
Commit: 48e5785bec845847a8ddc6203225e5b10fc77047
Parents: 8e6091b
Author: Andrea Cosentino <an...@gmail.com>
Authored: Wed Jun 8 14:55:56 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Wed Jun 8 14:56:28 2016 +0200
----------------------------------------------------------------------
components/camel-ssh/src/main/docs/ssh.adoc | 209 +++++++++++++++++++++++
docs/user-manual/en/SUMMARY.md | 1 +
2 files changed, 210 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/48e5785b/components/camel-ssh/src/main/docs/ssh.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ssh/src/main/docs/ssh.adoc b/components/camel-ssh/src/main/docs/ssh.adoc
new file mode 100644
index 0000000..bdccfd8
--- /dev/null
+++ b/components/camel-ssh/src/main/docs/ssh.adoc
@@ -0,0 +1,209 @@
+[[SSH-SSH]]
+SSH
+~~~
+
+*Available as of Camel 2.10*
+
+The SSH component enables access to SSH servers such that you can send
+an SSH command, and process the response.
+
+Maven users will need to add the following dependency to their `pom.xml`
+for this component:
+
+[source,xml]
+------------------------------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-ssh</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[SSH-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+-----------------------------------------------
+ssh:[username[:password]@]host[:port][?options]
+-----------------------------------------------
+
+[[SSH-Options]]
+Options
+^^^^^^^
+
+
+// component options: START
+The SSH component supports 11 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| configuration | SshConfiguration | To use the shared SSH configuration
+| host | String | Sets the hostname of the remote SSH server.
+| port | int | Sets the port number for the remote SSH server.
+| username | String | Sets the username to use in logging into the remote SSH server.
+| password | String | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null.
+| pollCommand | String | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...). You may need to end your command with a newline and that must be URL encoded 0A
+| keyPairProvider | KeyPairProvider | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server.
+| keyType | String | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa.
+| timeout | long | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds.
+| certFilename | String | Sets the resource path of the certificate to use for Authentication.
+| certResource | String | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting.
+|=======================================================================
+{% endraw %}
+// component options: END
+
+
+
+// endpoint options: START
+The SSH component supports 27 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| host | common | | String | *Required* Sets the hostname of the remote SSH server.
+| port | common | 22 | int | Sets the port number for the remote SSH server.
+| certResource | common | | String | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting.
+| keyType | common | ssh-rsa | String | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa.
+| password | common | | String | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null.
+| timeout | common | 30000 | long | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds.
+| username | common | | String | Sets the username to use in logging into the remote SSH server.
+| 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.
+| pollCommand | consumer | | String | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...) You may need to end your command with a newline and that must be URL encoded 0A
+| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
+| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
+| backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
+| delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
+| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
+| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
+| runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
+| scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
+| scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
+| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
+| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started.
+| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
+| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+[[SSH-UsageasaProducerendpoint]]
+Usage as a Producer endpoint
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When the SSH Component is used as a Producer (`.to("ssh://...")`), it
+will send the message body as the command to execute on the remote SSH
+server.
+
+Here is an example of this within the XML DSL. Note that the command has
+an XML encoded newline (` `).
+
+[source,xml]
+----------------------------------------------
+<route id="camel-example-ssh-producer">
+ <from uri="direct:exampleSshProducer"/>
+ <setBody>
+ <constant>features:list </constant>
+ </setBody>
+ <to uri="ssh://karaf:karaf@localhost:8101"/>
+ <log message="${body}"/>
+</route>
+----------------------------------------------
+
+[[SSH-Authentication]]
+Authentication
+^^^^^^^^^^^^^^
+
+The SSH Component can authenticate against the remote SSH server using
+one of two mechanisms: Public Key certificate or username/password.
+Configuring how the SSH Component does authentication is based on how
+and which options are set.
+
+1. First, it will look to see if the `certResource` option has been
+set, and if so, use it to locate the referenced Public Key certificate
+and use that for authentication.
+2. If `certResource` is not set, it will look to see if a
+`keyPairProvider` has been set, and if so, it will use that to for
+certificate based authentication.
+3. If neither `certResource` nor `keyPairProvider` are set, it will use
+the `username` and `password` options for authentication.
+
+The following route fragment shows an SSH polling consumer using a
+certificate from the classpath.
+
+In the XML DSL,
+
+[source,xml]
+-------------------------------------------------------------------------------------------------------------------------------------------------
+<route>
+ <from uri="ssh://scott@localhost:8101?certResource=classpath:test_rsa&useFixedDelay=true&delay=5000&pollCommand=features:list%0A"/>
+ <log message="${body}"/>
+</route>
+-------------------------------------------------------------------------------------------------------------------------------------------------
+
+In the Java DSL,
+
+[source,java]
+-----------------------------------------------------------------------------------------------------------------------------
+from("ssh://scott@localhost:8101?certResource=classpath:test_rsa&useFixedDelay=true&delay=5000&pollCommand=features:list%0A")
+ .log("${body}");
+-----------------------------------------------------------------------------------------------------------------------------
+
+An example of using Public Key authentication is provided in
+`examples/camel-example-ssh-security`.
+
+[[SSH-CertificateDependencies]]
+Certificate Dependencies
+
+You will need to add some additional runtime dependencies if you use
+certificate based authentication. The dependency versions shown are as
+of Camel 2.11, you may need to use later versions depending what version
+of Camel you are using.
+
+[source,xml]
+-----------------------------------------
+<dependency>
+ <groupId>org.apache.sshd</groupId>
+ <artifactId>sshd-core</artifactId>
+ <version>0.8.0</version>
+</dependency>
+<dependency>
+ <groupId>org.bouncycastle</groupId>
+ <artifactId>bcpg-jdk15on</artifactId>
+ <version>1.47</version>
+</dependency>
+<dependency>
+ <groupId>org.bouncycastle</groupId>
+ <artifactId>bcpkix-jdk15on</artifactId>
+ <version>1.47</version>
+</dependency>
+-----------------------------------------
+
+[[SSH-Example]]
+Example
+^^^^^^^
+
+See the `examples/camel-example-ssh` and
+`examples/camel-example-ssh-security` in the Camel distribution.
+
+[[SSH-SeeAlso]]
+See Also
+^^^^^^^^
+
+* link:configuring-camel.html[Configuring Camel]
+* link:component.html[Component]
+* link:endpoint.html[Endpoint]
+* link:getting-started.html[Getting Started]
+
http://git-wip-us.apache.org/repos/asf/camel/blob/48e5785b/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 6a3d607..6f2d196 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -257,6 +257,7 @@
* [Spring-Web-Services](spring-ws.adoc)
* [SQL](sql.adoc)
* [SQL-Stored](sql-stored.adoc)
+ * [SSH](ssh.adoc)
* [Telegram](telegram.adoc)
* [Twitter](twitter.adoc)
* [Websocket](websocket.adoc)