This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push: new 40ac62e CAMEL-16861: Cleanup docs 40ac62e is described below commit 40ac62ecd07fbba93c875422e1077659695633eb Author: Claus Ibsen <claus.ib...@gmail.com> AuthorDate: Tue Nov 2 10:26:01 2021 +0100 CAMEL-16861: Cleanup docs --- .../modules/ROOT/pages/defaulterrorhandler.adoc | 16 +++++++------- .../modules/ROOT/pages/delay-interceptor.adoc | 10 +++++---- docs/user-manual/modules/ROOT/pages/dsl.adoc | 25 ++++++++++------------ 3 files changed, 25 insertions(+), 26 deletions(-) diff --git a/docs/user-manual/modules/ROOT/pages/defaulterrorhandler.adoc b/docs/user-manual/modules/ROOT/pages/defaulterrorhandler.adoc index fe7c3dd..1c309de 100644 --- a/docs/user-manual/modules/ROOT/pages/defaulterrorhandler.adoc +++ b/docs/user-manual/modules/ROOT/pages/defaulterrorhandler.adoc @@ -25,9 +25,9 @@ xref:exception-clause.adoc[Exception Clause] documentation. == Example -In this route below, any exception thrown in, eg the `validateOrder` -bean, will be propagated back to the caller via the jetty endpoint. It -will return an HTTP error message back to the client. +In this route below, any exception thrown in, such as the `validateOrder` +bean, will be propagated back to the caller via the jetty endpoint, which +then returns an HTTP error message back to the client. [source,java] ---- @@ -36,9 +36,9 @@ from("jetty:http://localhost/myservice/order") .to("jms:queue:order"); ---- -We can add an *onException* in case we want to catch certain exceptions +We can add an `onException` in case we want to catch certain exceptions and route them differently, for instance to catch a -*ValidationException* and return a fixed response to the caller. +`ValidationException` and return a fixed response to the caller. [source,java] ---- @@ -52,9 +52,9 @@ from("jetty:http://localhost/myservice/order") ---- When the `ValidationException` is thrown from the `validateOrder` bean, -it is intercepted by the DefaultErrorHandler that lets the -`onException(ValidationException.class)` handle it, so the -xref:exchange.adoc[Exchange] is routed to this onException route, and +it is intercepted by Camel error handler which lets the +`onException(ValidationException.class)` handle the exception. +The xref:exchange.adoc[Exchange] is routed to this onException route, and since we use `handled(true)`, then the original exception is cleared, and we transform the message into a fixed response that is returned to jetty endpoint that returns it to the original caller. diff --git a/docs/user-manual/modules/ROOT/pages/delay-interceptor.adoc b/docs/user-manual/modules/ROOT/pages/delay-interceptor.adoc index 1166fdb..82c964a 100644 --- a/docs/user-manual/modules/ROOT/pages/delay-interceptor.adoc +++ b/docs/user-manual/modules/ROOT/pages/delay-interceptor.adoc @@ -1,17 +1,19 @@ = Delayer -The Delayer is used for slowing processing of messages down. +The Delayer is used for slowing processing of messages. This allows you to set a fixed amount of delay between each step a message passes in -the route path, to show how things is happening nice and slowly, so you +the route, to better show how things is happening nice and slowly, so you are not bombarded with a zillion lines of logging output. +== Using Delayer + The delayer can be configured on two levels: - CamelContext - _Globally_ - Route - _Individually per route_ -== Configuring using XML DSL +=== Configuring using XML DSL Just set the `delayer` attribute of the `<camelContext>` tag as shown below: @@ -25,7 +27,7 @@ Just set the `delayer` attribute of the `<camelContext>` tag as shown below: </camelContext> -------------------------------------------------------------------------------------------------- -== Configuring using Java +=== Configuring using Java You can enable delaying messages by setting the delay value on the `CamelContext` as shown: diff --git a/docs/user-manual/modules/ROOT/pages/dsl.adoc b/docs/user-manual/modules/ROOT/pages/dsl.adoc index 0033355..860284f 100644 --- a/docs/user-manual/modules/ROOT/pages/dsl.adoc +++ b/docs/user-manual/modules/ROOT/pages/dsl.adoc @@ -2,24 +2,21 @@ Camel uses a Java _Domain Specific Language_ or DSL for creating xref:components:eips:enterprise-integration-patterns.adoc[Enterprise Integration -Patterns] or Routes in a variety of domain-specific -languages (DSL) as listed below. +Patterns] or xref:routes.adoc[Routes] in a variety of domain-specific +languages (DSL) as listed below: -* xref:java-dsl.adoc[Java DSL] - A Java based DSL using the fluent -builder style. -* xref:components::spring-summary.adoc[Spring XML] - A XML based DSL in Spring XML files -* xref:rest-dsl.adoc[Rest DSL] - A DSL to define REST services using a -REST style in either Java or XML. -* xref:bean-integration.adoc[Annotation DSL] - Use annotations in Java -beans. +* xref:java-dsl.adoc[Java DSL] - A Java based DSL using the fluent builder style. +* xref:components:others:java-xml-io-dsl.adoc[XML DSL] A XML based DSL in Camel XML files only. +* xref:components::spring-summary.adoc[Spring XML] - A XML based DSL in classic Spring XML files. * xref:components:others:yaml-dsl.adoc[Yaml DSL] for creating routes using YAML format. +* xref:rest-dsl.adoc[Rest DSL] - A DSL to define REST services using REST verbs. +* xref:bean-integration.adoc[Annotation DSL] - Use annotations in Java beans. +== See Also -The main entry points for the DSL are: - -* xref:camelcontext.adoc[CamelContext] for creating a Camel routing -rulebase +* xref:camelcontext.adoc[CamelContext] the main entry for Camel is the `CamelContext` +* xref:routes.adoc[Routes] for general information about a Camel route * xref:route-builder.adoc[RouteBuilder] for creating routes using the Java DSL style. * xref:lambda-route-builder.adoc[LambdaRouteBuilder] for creating routes using Java lambda style. -* xref:Endpoint-dsl.adoc[Endpoint DSL] for creating routes using type-safe Camel endpoints. +* xref:Endpoint-dsl.adoc[Endpoint DSL] for creating routes using type-safe Camel endpoints in Java. * xref:route-template.adoc[Route Template] for creating reusable route templates.