camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject [3/3] camel git commit: Added direct-vm component docs to Gitbook
Date Mon, 13 Jun 2016 09:29:07 GMT
Added direct-vm component 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/6a42b022
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/6a42b022
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/6a42b022

Branch: refs/heads/master
Commit: 6a42b022079bed686dca529c9aa9b84e6dd49001
Parents: 0a82d46
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Mon Jun 13 11:28:29 2016 +0200
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Mon Jun 13 11:28:29 2016 +0200

----------------------------------------------------------------------
 camel-core/src/main/docs/direct-vm.adoc         | 140 +++++++++++++++++++
 docs/user-manual/en/SUMMARY.md                  |   1 +
 .../en/direct-vm.data/camel-direct-vm.png       | Bin 0 -> 129236 bytes
 3 files changed, 141 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/6a42b022/camel-core/src/main/docs/direct-vm.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/direct-vm.adoc b/camel-core/src/main/docs/direct-vm.adoc
new file mode 100644
index 0000000..24202a6
--- /dev/null
+++ b/camel-core/src/main/docs/direct-vm.adoc
@@ -0,0 +1,140 @@
+[[Direct-VM-DirectVMComponent]]
+Direct VM Component
+~~~~~~~~~~~~~~~~~~~
+
+*Available as of Camel 2.10*
+
+The *direct-vm:* component provides direct, synchronous invocation of
+any consumers in the JVM when a producer sends a message exchange. +
+ This endpoint can be used to connect existing routes in the same camel
+context, as well from other camel contexts in the *same* JVM.
+
+This component differs from the link:direct.html[Direct] component in
+that link:direct-vm.html[Direct-VM] supports communication across
+CamelContext instances - so you can use this mechanism to communicate
+across web applications (provided that camel-core.jar is on the
+system/boot classpath).
+
+At runtime you can swap in new consumers, by stopping the existing
+consumer(s) and start new consumers. +
+ But at any given time there can be at most only one active consumer for
+a given endpoint.
+
+This component allows also to connect routes deployed in different OSGI
+Bundles as you can see here after. Even if they are running in different
+bundles, the camel routes will use +
+ the same thread. That autorises to develop applications using
+Transactions - Tx.
+
+image:direct-vm.data/camel-direct-vm.png[image]
+
+[[Direct-VM-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+------------------
+direct-vm:someName
+------------------
+
+Where *someName* can be any string to uniquely identify the endpoint
+
+[[Direct-VM-Options]]
+Options
+^^^^^^^
+
+
+// component options: START
+The Direct VM component supports 4 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| block | boolean | If sending a message to a direct endpoint which has no active consumer
then we can tell the producer to block and wait for the consumer to become active.
+| timeout | long | The timeout value to use if block is enabled.
+| headerFilterStrategy | HeaderFilterStrategy | Sets a HeaderFilterStrategy that will only
be applied on producer endpoints (on both directions: request and response). Default value:
none.
+| propagateProperties | boolean | Whether to propagate or not properties from the producer
side to the consumer side and viceversa. Default value: true.
+|=======================================================================
+{% endraw %}
+// component options: END
+
+
+
+// endpoint options: START
+The Direct VM component supports 10 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* Name of direct-vm 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.
+| block | producer | false | boolean | If sending a message to a direct endpoint which has
no active consumer then we can tell the producer to block and wait for the consumer to become
active.
+| failIfNoConsumers | producer | false | boolean | Whether the producer should fail by throwing
an exception when sending to a Direct-VM endpoint with no active consumers.
+| timeout | producer | 30000 | long | The timeout value to use if block is enabled.
+| headerFilterStrategy | producer (advanced) |  | HeaderFilterStrategy | Sets a HeaderFilterStrategy
that will only be applied on producer endpoints (on both directions: request and response).
Default value: none.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern
when creating an exchange.
+| propagateProperties | advanced | false | Boolean | Whether to propagate or not properties
from the producer side to the consumer side and viceversa. Default value: true.
+| 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
+
+
+[[Direct-VM-Samples]]
+Samples
+^^^^^^^
+
+In the route below we use the direct component to link the two routes
+together:
+
+[source,java]
+-------------------------------------------
+from("activemq:queue:order.in")
+    .to("bean:orderServer?method=validate")
+    .to("direct-vm:processOrder");
+-------------------------------------------
+
+And now in another CamelContext, such as another OSGi bundle
+
+[source,java]
+-------------------------------------------
+from("direct-vm:processOrder")
+    .to("bean:orderService?method=process")
+    .to("activemq:queue:order.out");
+-------------------------------------------
+
+And the sample using spring DSL:
+
+[source,xml]
+--------------------------------------------------
+   <route>
+     <from uri="activemq:queue:order.in"/>
+     <to uri="bean:orderService?method=validate"/>
+     <to uri="direct-vm:processOrder"/>
+  </route>
+
+  <route>
+     <from uri="direct-vm:processOrder"/>
+     <to uri="bean:orderService?method=process"/>
+     <to uri="activemq:queue:order.out"/>
+  </route>    
+--------------------------------------------------
+
+[[Direct-VM-SeeAlso]]
+See Also
+^^^^^^^^
+
+* link:configuring-camel.html[Configuring Camel]
+* link:component.html[Component]
+* link:endpoint.html[Endpoint]
+* link:getting-started.html[Getting Started]
+
+* link:direct.html[Direct]
+* link:seda.html[SEDA]
+* link:vm.html[VM]
+

http://git-wip-us.apache.org/repos/asf/camel/blob/6a42b022/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index a650914..31f8688 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -82,6 +82,7 @@
     * [Dataformat](dataformat.adoc)
     * [Dataset](dataset.adoc)
     * [Direct](direct.adoc)
+    * [Direct-vm](direct-vm.adoc)
     * [Mock](mock.adoc)
     * [Properties](properties.adoc)
 

http://git-wip-us.apache.org/repos/asf/camel/blob/6a42b022/docs/user-manual/en/direct-vm.data/camel-direct-vm.png
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/direct-vm.data/camel-direct-vm.png b/docs/user-manual/en/direct-vm.data/camel-direct-vm.png
new file mode 100644
index 0000000..d15f185
Binary files /dev/null and b/docs/user-manual/en/direct-vm.data/camel-direct-vm.png differ


Mime
View raw message