Added binding 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/053ff759 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/053ff759 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/053ff759 Branch: refs/heads/master Commit: 053ff759a7d50faebef99244d37bc756d314d7da Parents: b40a5b8 Author: Andrea Cosentino <anco...@gmail.com> Authored: Thu Jun 9 16:32:31 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Thu Jun 9 16:32:31 2016 +0200 ---------------------------------------------------------------------- camel-core/src/main/docs/binding.adoc | 124 +++++++++++++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 125 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/053ff759/camel-core/src/main/docs/binding.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/binding.adoc b/camel-core/src/main/docs/binding.adoc new file mode 100644 index 0000000..bb45104 --- /dev/null +++ b/camel-core/src/main/docs/binding.adoc @@ -0,0 +1,124 @@ +[[Binding-Binding]] +Binding +------- + +In Camel terms a _binding_ is a way of wrapping an +link:endpoint.html[Endpoint] in a contract; such as a +link:data-format.html[Data Format], a link:content-enricher.html[Content +Enricher] or validation step. Bindings are completely optional and you +can choose to use them on any link:components.html[camel endpoint]. + +Bindings are inspired by the work of +http://www.jboss.org/switchyard[SwitchYard project] adding service +contracts to various technologies like Camel and many others. But rather +than the SwitchYard approach of wrapping Camel in SCA, _Camel Bindings_ +provide a way of wrapping Camel endpoints with contracts inside the +Camel framework itself; so you can use them easily inside any Camel +route. + +[[Binding-Options]] +Options +^^^^^^^ + + +// component options: START +The Binding component has no options. +// component options: END + + + +// endpoint options: START +The Binding 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 +| bindingName | common | | String | *Required* Name of the binding to lookup in the Camel registry. +| delegateUri | common | | String | *Required* Uri of the delegate 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 + + +[[Binding-UsingBindings]] +Using Bindings +~~~~~~~~~~~~~~ + +A Binding is currently a bean which defines the contract (though we'll +hopefully add bindings to the Camel DSL). + +There are a few approaches to defining a bound endpoint (i.e. an +endpoint bound with a Binding). + +[[Binding-UsingthebindingURI]] +Using the binding URI +^^^^^^^^^^^^^^^^^^^^^ + +You can prefix any endpoint URI with *binding:nameOfBinding:* where +_nameOfBinding_ is the name of the Binding bean in your registry. + +[source,java] +------------------------------------------------------------------------------ +from("binding:jaxb:activemq:myQueue").to("binding:jaxb:activemq:anotherQueue") +------------------------------------------------------------------------------ + +Here we are using the "jaxb" binding which may, for example, use the +JAXB link:data-format.html[Data Format] to marshal and unmarshal +messages. + +[[Binding-UsingaBindingComponent]] +Using a BindingComponent +^^^^^^^^^^^^^^^^^^^^^^^^ + +There is a link:component.html[Component] called BindingComponent which +can be configured in your link:registry.html[Registry] by dependency +injection which allows the creation of endpoints which are already bound +to some binding. + +For example if you registered a new component called "jsonmq" in your +registry using code like this + +[source,java] +----------------------------------------------------------------------------------------------------- + JacksonDataFormat format = new JacksonDataFormat(MyBean.class); + context.bind("jsonmq", new BindingComponent(new DataFormatBinding(format), "activemq:foo.")); +----------------------------------------------------------------------------------------------------- + +Then you could use the endpoint as if it were any other endpoint. + +[source,java] +------------------------------------------------ +from("jsonmq:myQueue").to("jsonmq:anotherQueue") +------------------------------------------------ + +which would be using the queueus "foo.myQueue" and "foo.anotherQueue" +and would use the given Jackson link:data-format.html[Data Format] to +marshal on and off the queue. + +[[Binding-WhentouseBindings]] +When to use Bindings +~~~~~~~~~~~~~~~~~~~~ + +If you only use an endpoint once in a single route; a binding may +actually be more complex and more work than just using the 'raw' +endpoint directly and using explicit marshalling and validation in the +camel route as normal. + +However bindings can help when you are composing many routes together; +or using a single route as a 'template' that is configured input and +output endpoints; bindings then provide a nice way to wrap up a contract +and endpoint together. + +Another good use case for bindings is when you are using many endpoints +which use the same binding; rather than always having to mention a +specific data format or validation rule, you can just use the +BindingComponent to wrap the endpoints in the binding of your choice. + +So bindings are a composition tool really; only use them when they make +sense - the extra complexity may not be worth it unless you have lots of +routes or endpoints. http://git-wip-us.apache.org/repos/asf/camel/blob/053ff759/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index e4430fc..0a842c4 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -99,6 +99,7 @@ * [Bean](bean.adoc) * [Beanstalk](beanstalk.adoc) * [Bean-validator](bean-validator.adoc) + * [Binding](binding.adoc) * [Bindy](bindy.adoc) * [Blueprint](blueprint-testing.adoc) * [Boon](boon.adoc)
