Added camel-atmos 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/aed36c18 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/aed36c18 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/aed36c18 Branch: refs/heads/master Commit: aed36c18e0f21b4c7036bef6f7cc582b13eab5be Parents: ff51cff Author: Andrea Cosentino <[email protected]> Authored: Thu Jun 30 09:19:23 2016 +0200 Committer: Andrea Cosentino <[email protected]> Committed: Thu Jun 30 09:20:53 2016 +0200 ---------------------------------------------------------------------- components/camel-atmos/src/main/docs/atmos.adoc | 72 ++++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 73 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/aed36c18/components/camel-atmos/src/main/docs/atmos.adoc ---------------------------------------------------------------------- diff --git a/components/camel-atmos/src/main/docs/atmos.adoc b/components/camel-atmos/src/main/docs/atmos.adoc new file mode 100644 index 0000000..1618dba --- /dev/null +++ b/components/camel-atmos/src/main/docs/atmos.adoc @@ -0,0 +1,72 @@ +[[Atmos-Atmos]] +Atmos Component +~~~~~~~~~~~~~~~ + +*Available as of Camel 2.15* + +*Camel-Gora* is an http://camel.apache.org/[Apache Camel] component that +allows you to work with ViPR object data services using the +https://github.com/emcvipr/dataservices-sdk-java[Atmos Client]. + +[source,java] +------------------------------- +from("atmos:foo/get?remotePath=/path").to("mock:test"); +------------------------------- + +[[Atmos-Options]] +Options +~~~~~~~ + + +// component options: START +The Atmos component has no options. +// component options: END + + + +// endpoint options: START +The Atmos component supports 14 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| name | common | | String | Atmos name +| operation | common | | AtmosOperation | *Required* Operation to perform +| enableSslValidation | common | false | boolean | Atmos SSL validation +| fullTokenId | common | | String | Atmos client fullTokenId +| localPath | common | | String | Local path to put files +| newRemotePath | common | | String | New path on Atmos when moving files +| query | common | | String | Search query on Atmos +| remotePath | common | | String | Where to put files on Atmos +| secretKey | common | | String | Atmos shared secret +| uri | common | | String | Atomos server uri +| 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. +| 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. +| 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). +|======================================================================= +{% endraw %} +// endpoint options: END + + +[[Atmos-Dependencies]] +Dependencies +^^^^^^^^^^^^ + +To use Atmos in your camel routes you need to add the dependency +on *camel-atmos* which implements this data format. + +If you use maven you could just add the following to your pom.xml, +substituting the version number for the latest & greatest release (see +link:download.html[the download page for the latest versions]). + +[source,xml] +---------------------------------------------------------- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-atmos</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +---------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/aed36c18/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index bfce4c7..91d1fd1 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -106,6 +106,7 @@ * [Amqp](amqp.adoc) * [Apns](apns.adoc) * [Atmosphere Websocket](atmosphere-websocket.adoc) + * [Atmos](atmos.adoc) * [Atom](atom.adoc) * [Avro](avro.adoc) * [AWS](aws.adoc)
