camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject [2/2] camel git commit: Added camel-coap docs to Gitbook
Date Fri, 24 Jun 2016 10:00:31 GMT
Added camel-coap 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/07d1d2ec
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/07d1d2ec
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/07d1d2ec

Branch: refs/heads/master
Commit: 07d1d2eccb1831ddaf27c6fbf538366e20089fc6
Parents: d0a4de1
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Fri Jun 24 11:59:59 2016 +0200
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Fri Jun 24 11:59:59 2016 +0200

----------------------------------------------------------------------
 components/camel-coap/src/main/docs/coap.adoc | 52 ++++++++++++++++++++++
 docs/user-manual/en/SUMMARY.md                |  1 +
 2 files changed, 53 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/07d1d2ec/components/camel-coap/src/main/docs/coap.adoc
----------------------------------------------------------------------
diff --git a/components/camel-coap/src/main/docs/coap.adoc b/components/camel-coap/src/main/docs/coap.adoc
new file mode 100644
index 0000000..dc2c92f
--- /dev/null
+++ b/components/camel-coap/src/main/docs/coap.adoc
@@ -0,0 +1,52 @@
+[[CoAP-CoAPComponent]]
+CoAP Component
+~~~~~~~~~~~~~~
+
+*Camel-CoAP* is an http://camel.apache.org/[Apache Camel] component that
+allows you to work with CoAP, a lightweight REST-type protocol for machine-to-machine operation.

+http://coap.technology/[CoAP], Constrained Application Protocol is a specialized web transfer
protocol 
+for use with constrained nodes and constrained networks and it is based on RFC 7252.
+
+*Available as of Camel 2.16*
+
+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-coap</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+---------------------------------------------------------
+
+[[CoAP-Options]]
+Options
+~~~~~~~
+
+
+// component options: START
+The CoAP component has no options.
+// component options: END
+
+
+
+// endpoint options: START
+The CoAP component supports 6 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| uri | common |  | URI | The URI for the CoAP endpoint
+| coapMethod | common | * | String | The CoAP method this endpoint binds to. Default is to
bind to all () but can be restricted to GET POST PUT DELETE
+| 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
+

http://git-wip-us.apache.org/repos/asf/camel/blob/07d1d2ec/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 7197461..1c4ef4a 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -136,6 +136,7 @@
     * [CDI](cdi.adoc)
     * [Chunk](chunk.adoc)
     * [Cmis](cmis.adoc)
+    * [CoAP](coap.adoc)
     * [Cometd](cometd.adoc)
     * [Couchdb](couchdb.adoc)
     * [Crypto](crypto.adoc)


Mime
View raw message