Added direct 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/0a82d464 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0a82d464 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0a82d464 Branch: refs/heads/master Commit: 0a82d464a8fc6e1d7ef0353834a3f20b1cb64286 Parents: 7e2c733 Author: Andrea Cosentino <[email protected]> Authored: Mon Jun 13 11:20:29 2016 +0200 Committer: Andrea Cosentino <[email protected]> Committed: Mon Jun 13 11:20:29 2016 +0200 ---------------------------------------------------------------------- camel-core/src/main/docs/direct.adoc | 119 ++++++++++++++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 120 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/0a82d464/camel-core/src/main/docs/direct.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/direct.adoc b/camel-core/src/main/docs/direct.adoc new file mode 100644 index 0000000..7868d04 --- /dev/null +++ b/camel-core/src/main/docs/direct.adoc @@ -0,0 +1,119 @@ +[[Direct-DirectComponent]] +Direct Component +~~~~~~~~~~~~~~~~ + +The *direct:* component provides direct, synchronous invocation of any +consumers when a producer sends a message exchange. + + This endpoint can be used to connect existing routes in the *same* +camel context. + +TIP: *Asynchronous* +The link:seda.html[SEDA] component provides asynchronous invocation of +any consumers when a producer sends a message exchange. + +TIP:*Connection to other camel contexts* +The link:vm.html[VM] component provides connections between Camel +contexts as long they run in the same *JVM*. + +[[Direct-URIformat]] +URI format +^^^^^^^^^^ + +[source,text] +------------------------- +direct:someName[?options] +------------------------- + +Where *someName* can be any string to uniquely identify the endpoint + +[[Direct-Options]] +Options +^^^^^^^ + + +// component options: START +The Direct component supports 2 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. +|======================================================================= +{% endraw %} +// component options: END + + + +// endpoint options: START +The Direct component supports 8 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 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 endpoint with no active consumers. +| timeout | producer | 30000 | long | The timeout value to use if block is enabled. +| 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 + + +[[Direct-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:processOrder"); + +from("direct: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:processOrder"/> + </route> + + <route> + <from uri="direct:processOrder"/> + <to uri="bean:orderService?method=process"/> + <to uri="activemq:queue:order.out"/> + </route> +-------------------------------------------------- + +See also samples from the link:seda.html[SEDA] component, how they can +be used together. + +[[Direct-SeeAlso]] +See Also +^^^^^^^^ + +* link:configuring-camel.html[Configuring Camel] +* link:component.html[Component] +* link:endpoint.html[Endpoint] +* link:getting-started.html[Getting Started] +* link:seda.html[SEDA] +* link:vm.html[VM] + http://git-wip-us.apache.org/repos/asf/camel/blob/0a82d464/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index 1533e85..a650914 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -81,6 +81,7 @@ * [Controlbus](controlbus.adoc) * [Dataformat](dataformat.adoc) * [Dataset](dataset.adoc) + * [Direct](direct.adoc) * [Mock](mock.adoc) * [Properties](properties.adoc)
