Repository: camel Updated Branches: refs/heads/master ea7f06167 -> 97d0805fb
Added camel-vertx 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/e1a65fc6 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/e1a65fc6 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/e1a65fc6 Branch: refs/heads/master Commit: e1a65fc69e1f4040bdf5725e7b1025eb2208af9d Parents: ea7f061 Author: Andrea Cosentino <anco...@gmail.com> Authored: Thu Jun 9 11:42:50 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Thu Jun 9 11:42:50 2016 +0200 ---------------------------------------------------------------------- components/camel-vertx/src/main/docs/vertx.adoc | 112 +++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 113 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/e1a65fc6/components/camel-vertx/src/main/docs/vertx.adoc ---------------------------------------------------------------------- diff --git a/components/camel-vertx/src/main/docs/vertx.adoc b/components/camel-vertx/src/main/docs/vertx.adoc new file mode 100644 index 0000000..734343b --- /dev/null +++ b/components/camel-vertx/src/main/docs/vertx.adoc @@ -0,0 +1,112 @@ +[[Vertx-VertxComponent]] +Vertx Component +~~~~~~~~~~~~~~~ + +*Available as of Camel 2.12* + +The *vertx* component is for working with the http://vertx.io/[Vertx] +http://vertx.io/core_manual_js.html#the-event-bus[EventBus]. + +The vertx http://vertx.io/core_manual_js.html#the-event-bus[EventBus] +sends and receives JSON events. + +INFO:From *Camel 2.16* onwards vertx 3 is in use which requires Java 1.8 at +runtime. + +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-vertx</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +------------------------------------------------------------ + +[[Vertx-URIformat]] +URI format +^^^^^^^^^^ + +[source,java] +--------------------------- +vertx:channelName[?options] +--------------------------- + +[[Vertx-Options]] +Options +^^^^^^^ + + +// component options: START +The Vert.x component supports 6 options which are listed below. + + + +{% raw %} +[width="100%",cols="2s,1m,8",options="header"] +|======================================================================= +| Name | Java Type | Description +| vertxFactory | VertxFactory | To use a custom VertxFactory implementation +| host | String | Hostname for creating an embedded clustered EventBus +| port | int | Port for creating an embedded clustered EventBus +| vertxOptions | VertxOptions | Options to use for creating vertx +| vertx | Vertx | To use the given vertx EventBus instead of creating a new embedded EventBus +| timeout | int | Timeout in seconds to wait for clustered Vertx EventBus to be ready. The default value is 60. +|======================================================================= +{% endraw %} +// component options: END + + + +// endpoint options: START +The Vert.x 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 +| address | common | | String | *Required* Sets the event bus address used to communicate +| pubSub | common | | Boolean | Whether to use publish/subscribe instead of point to point when sending to a vertx 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 + + +*Camel 2.12.3:* Whether to use publish/subscribe instead of point to +point when sending to a vertx endpoint. + +----------------------------------------------------------------------------------------------- +You can append query options to the URI in the following format, ?option=value&option=value&... +----------------------------------------------------------------------------------------------- + +[[Vertx-ConnectingtotheexistingVert.xinstance]] +Connecting to the existing Vert.x instance +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you would like to connect to the Vert.x instance already existing in +your JVM, you can set the instance on the component level: + +[source,java] +----------------------------------------------------- +Vertx vertx = ...; +VertxComponent vertxComponent = new VertxComponent(); +vertxComponent.setVertx(vertx); +camelContext.addComponent("vertx", vertxComponent); +----------------------------------------------------- + +[[Vertx-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/e1a65fc6/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index 6c72af6..3e1ce21 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -269,6 +269,7 @@ * [Undertow](undertow.adoc) * [URLRewrite](urlrewrite.adoc) * [Velocity](velocity.adoc) + * [Vertx](vertx.adoc) * [Websocket](websocket.adoc) * [XML Security](xmlsecurity.adoc) * [Yammer](yammer.adoc)
