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 browse docs to Gitbook
Date Fri, 10 Jun 2016 11:19:12 GMT
Repository: camel
Updated Branches:
  refs/heads/master d76f047d6 -> 2331f7c7f


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

Branch: refs/heads/master
Commit: 2331f7c7ff92d0e9a63baaf41d79bfe2a0c0812d
Parents: d76f047
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Fri Jun 10 13:18:37 2016 +0200
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Fri Jun 10 13:18:57 2016 +0200

----------------------------------------------------------------------
 camel-core/src/main/docs/browse.adoc | 88 +++++++++++++++++++++++++++++++
 docs/user-manual/en/SUMMARY.md       |  1 +
 2 files changed, 89 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/2331f7c7/camel-core/src/main/docs/browse.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/browse.adoc b/camel-core/src/main/docs/browse.adoc
new file mode 100644
index 0000000..d2c3e6a
--- /dev/null
+++ b/camel-core/src/main/docs/browse.adoc
@@ -0,0 +1,88 @@
+[[Browse-BrowseComponent]]
+Browse Component
+~~~~~~~~~~~~~~~~
+
+The Browse component provides a simple
+link:browsableendpoint.html[BrowsableEndpoint] which can be useful for
+testing, visualisation tools or debugging. The exchanges sent to the
+endpoint are all available to be browsed.
+
+[[Browse-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+-------------------------
+browse:someName[?options]
+-------------------------
+
+Where *someName* can be any string to uniquely identify the endpoint.
+
+
+[[Gora-Options]]
+Options
+~~~~~~~
+
+
+// component options: START
+The Browse component has no options.
+// component options: END
+
+
+
+// endpoint options: START
+The Browse component supports 5 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 | *Required* A name which can be any string to uniquely identify
the endpoint
+| 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
+
+
+[[Browse-Sample]]
+Sample
+^^^^^^
+
+In the route below, we insert a `browse:` component to be able to browse
+the Exchanges that are passing through:
+
+[source,java]
+-------------------------------------------------------------------------------
+  from("activemq:order.in").to("browse:orderReceived").to("bean:processOrder");
+-------------------------------------------------------------------------------
+
+We can now inspect the received exchanges from within the Java code:
+
+[source,java]
+--------------------------------------------------------------------------------------------------------
+    private CamelContext context;
+
+    public void inspectRecievedOrders() {
+        BrowsableEndpoint browse = context.getEndpoint("browse:orderReceived", BrowsableEndpoint.class);
+        List<Exchange> exchanges = browse.getExchanges();
+        ...
+        // then we can inspect the list of received exchanges from Java
+        for (Exchange exchange : exchanges) {
+            String payload = exchange.getIn().getBody();
+            ...
+        }
+   }
+--------------------------------------------------------------------------------------------------------
+
+[[Browse-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/2331f7c7/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 1db5433..cff73f1 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -76,6 +76,7 @@
 * Core Components
     * [Bean](bean.adoc)
     * [Binding](binding.adoc)
+    * [Browse](browse.adoc)
     * [Mock](mock.adoc)
     * [Properties](properties.adoc)
 


Mime
View raw message