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 5e8b66e Polish and cleanup documentation
5e8b66e is described below
commit 5e8b66ee3a398e9a8bff6428e97536e2df9c8e14
Author: Claus Ibsen <[email protected]>
AuthorDate: Tue Aug 10 12:59:09 2021 +0200
Polish and cleanup documentation
---
docs/user-manual/modules/ROOT/nav.adoc | 2 +-
...configuration-of-camelcontext-using-spring.adoc | 7 ++-
.../modules/ROOT/pages/delay-interceptor.adoc | 65 +++++++++++-----------
docs/user-manual/modules/ROOT/pages/index.adoc | 2 +-
4 files changed, 39 insertions(+), 37 deletions(-)
diff --git a/docs/user-manual/modules/ROOT/nav.adoc
b/docs/user-manual/modules/ROOT/nav.adoc
index e06e0ad..7bf5e51 100644
--- a/docs/user-manual/modules/ROOT/nav.adoc
+++ b/docs/user-manual/modules/ROOT/nav.adoc
@@ -43,7 +43,7 @@
** xref:component.adoc[Component]
** xref:data-format.adoc[Data Format]
** xref:debugger.adoc[Debugger]
-** xref:delay-interceptor.adoc[Delay interceptor]
+** xref:delay-interceptor.adoc[Delayer]
** xref:dependency-injection.adoc[Dependency Injection]
** xref:dozer-type-conversion.adoc[Dozer Type Conversion]
** xref:endpoint.adoc[Endpoints]
diff --git
a/docs/user-manual/modules/ROOT/pages/advanced-configuration-of-camelcontext-using-spring.adoc
b/docs/user-manual/modules/ROOT/pages/advanced-configuration-of-camelcontext-using-spring.adoc
index 44ddc28..4e1672b 100644
---
a/docs/user-manual/modules/ROOT/pages/advanced-configuration-of-camelcontext-using-spring.adoc
+++
b/docs/user-manual/modules/ROOT/pages/advanced-configuration-of-camelcontext-using-spring.adoc
@@ -10,9 +10,10 @@ The following functions such as can be configured:
* xref:pluggable-class-resolvers.adoc[Class resolvers]
* xref:lifecycle.adoc[Lifecycle factories]
* xref:registry.adoc[Registry for lookup]
-* xref:debugger.adoc[Debugger], xref:tracer.adoc[Tracer],
-xref:delay-interceptor.adoc[Delay] and
-xref:uuidgenerator.adoc[UuidGenerator]
+* xref:debugger.adoc[Debugger]
+* xref:tracer.adoc[Tracer]
+* xref:delay-interceptor.adoc[Delayer]
+* xref:uuidgenerator.adoc[UuidGenerator]
* xref:{eip-vc}:eips:intercept.adoc[Intercept]
* xref:graceful-shutdown.adoc[Graceful Shutdown]
* xref:stream-caching.adoc[Stream caching]
diff --git a/docs/user-manual/modules/ROOT/pages/delay-interceptor.adoc
b/docs/user-manual/modules/ROOT/pages/delay-interceptor.adoc
index e36872b..e007163 100644
--- a/docs/user-manual/modules/ROOT/pages/delay-interceptor.adoc
+++ b/docs/user-manual/modules/ROOT/pages/delay-interceptor.adoc
@@ -1,56 +1,50 @@
-[[DelayInterceptor-DelayInterceptor]]
-= Delay Interceptor
+[[Delayer-Delayer]]
+= Delayer
-*Available in Camel 1.5*
+The Delayer is used for slowing processing of messages down.
-The Delay interceptor is an route interceptor that is used for slowing
-processing of messages down. This allows you to enable this interceptor
-and set a fixed amount of delay between each step a message passes in
+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
are not bombarded with a zillion lines of logging output.
-The delay interceptor can be configured as follows:
+The delayer can be configured on two levels:
-* setting the delay attribute in the spring camelContext tag.
-* adding the delay interceptor to the CamelContext in Java code.
+- CamelContext - _Globally_
+- Route - _Individually per route_
-[[DelayInterceptor-ConfiguringusingSpring]]
-== Configuring using Spring
+== Configuring using XML DSL
-Just set the delay attribute of the camelContext tag as shown below:
+Just set the `delayer` attribute of the `<camelContext>` tag as shown below:
[source,xml]
--------------------------------------------------------------------------------------------------
- <camelContext id="camel" delayer="500"
xmlns="http://activemq.apache.org/camel/schema/spring";>
- <route>
- <from uri="direct:start"/>
- <to uri="mock:result"/>
- </route>
- </camelContext>
+<camelContext id="camel" delayer="500"
xmlns="http://activemq.apache.org/camel/schema/spring";>
+ <route>
+ <from uri="direct:start"/>
+ <to uri="mock:result"/>
+ </route>
+</camelContext>
--------------------------------------------------------------------------------------------------
-[[DelayInterceptor-ConfiguringusingJava]]
== Configuring using Java
-You can add the delayer interceptor in the RouteBulder:
+You can enable delaying messages by setting the delay value on the
`CamelContext` as shown:
[source,java]
-----------------------------
-getContext().setDelayer(200);
+camelContext.setDelayer(200);
-----------------------------
-[[DelayInterceptor-Granularity]]
-== Granularity
+=== Configuring on route level
-In *Camel 2.0* you can configure it on both camel context and per route
-as you like. Per route will override the camel context setting. +
- For example the route below is only the first route that has a delayer
-with 200 millis.
+You can also configure it on both camel context and per route
+as you like. Per route will override the camel context setting.
-[source,java]
-------------------------
-<camelContext ...>
+For example the route below is only the first route that has a delayer with
200 millis.
+[source,xml]
+----
+<camelContext>
<route delayer="200">
...
</route>
@@ -58,7 +52,14 @@ with 200 millis.
<route>
...
</route>
-
</camelContext>
-------------------------
+----
+
+And in Java DSL:
+
+[source,java]
+----
+from("direct:start").delayer(200)
+ .to("mock:result")
+----
diff --git a/docs/user-manual/modules/ROOT/pages/index.adoc
b/docs/user-manual/modules/ROOT/pages/index.adoc
index 4517717..555de59 100644
--- a/docs/user-manual/modules/ROOT/pages/index.adoc
+++ b/docs/user-manual/modules/ROOT/pages/index.adoc
@@ -82,7 +82,7 @@ camel routes without them knowing
* xref:components::index.adoc[Component]
* xref:data-format.adoc[Data Format]
* xref:debugger.adoc[Debugger]
-* xref:delay-interceptor.adoc[Delay Interceptor]
+* xref:delay-interceptor.adoc[Delayer]
* xref:dependency-injection.adoc[Dependency Injection]
* xref:dozer-type-conversion.adoc[Dozer Type Conversion]
* xref:dsl.adoc[DSL]
