camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject camel git commit: Added camel-eventadmin docs to gitbook
Date Thu, 10 Mar 2016 08:34:21 GMT
Repository: camel
Updated Branches:
  refs/heads/master e253b5b28 -> 69f50dad8


Added camel-eventadmin 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/69f50dad
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/69f50dad
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/69f50dad

Branch: refs/heads/master
Commit: 69f50dad8546aa7f2ba59fe9d9ae6a1a8e7aab78
Parents: e253b5b
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Thu Mar 10 09:34:00 2016 +0100
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Thu Mar 10 09:34:01 2016 +0100

----------------------------------------------------------------------
 .../src/main/docs/eventadmin.adoc               | 76 ++++++++++++++++++++
 docs/user-manual/en/SUMMARY.md                  |  1 +
 2 files changed, 77 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/69f50dad/components/camel-eventadmin/src/main/docs/eventadmin.adoc
----------------------------------------------------------------------
diff --git a/components/camel-eventadmin/src/main/docs/eventadmin.adoc b/components/camel-eventadmin/src/main/docs/eventadmin.adoc
new file mode 100644
index 0000000..4e621f3
--- /dev/null
+++ b/components/camel-eventadmin/src/main/docs/eventadmin.adoc
@@ -0,0 +1,76 @@
+[[EventAdmin-EventAdmincomponent]]
+EventAdmin component
+~~~~~~~~~~~~~~~~~~~~
+
+*Available in Camel 2.6*
+
+The `eventadmin` component can be used in an OSGi environment to receive
+OSGi EventAdmin events and process them.
+
+[[EventAdmin-Dependencies]]
+Dependencies
+^^^^^^^^^^^^
+
+Maven users need to add the following dependency to their `pom.xml`
+
+[source,xml]
+-------------------------------------------
+<dependency>
+  <groupId>org.apache.camel</groupId>
+  <artifactId>camel-eventadmin</artifactId>
+  <version>${camel-version}</version>
+</dependency>
+-------------------------------------------
+
+where `${camel-version`} must be replaced by the actual version of Camel
+(2.6.0 or higher).
+
+[[EventAdmin-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,xml]
+--------------------------
+eventadmin:topic[?options]
+--------------------------
+
+where `topic` is the name of the topic to listen too.
+
+[[EventAdmin-URIoptions]]
+URI options
+^^^^^^^^^^^
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|Name |Default value |Description
+
+|`send` |`false` |Whether to use 'send' or 'synchronous' deliver. Default false (async
+delivery)
+|=======================================================================
+
+[[EventAdmin-Messageheaders]]
+Message headers
+^^^^^^^^^^^^^^^
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|Name |Type |Message |Description
+|=======================================================================
+
+[[EventAdmin-Messagebody]]
+Message body
+^^^^^^^^^^^^
+
+The `in` message body will be set to the received Event.
+
+[[EventAdmin-Exampleusage]]
+Example usage
+^^^^^^^^^^^^^
+
+[source,xml]
+------------------------------
+<route>
+    <from uri="eventadmin:*"/>
+    <to uri="stream:out"/>
+</route>
+------------------------------

http://git-wip-us.apache.org/repos/asf/camel/blob/69f50dad/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 684f346..2dce1fe 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -124,6 +124,7 @@
     * [Eclipse](eclipse.adoc)
     * [ElasticSearch](elasticsearch.adoc)
     * [Elsql](elsql.adoc)
+    * [Eventadmin](eventadmin.adoc)
     * [Ironmq](ironmq.adoc)
     * [JMS](jms.adoc)
     * [Metrics](metrics.adoc)


Mime
View raw message