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
commit 9c3a347040f13d3a46cc2a6aa8d094f987aeb61a Author: Claus Ibsen <[email protected]> AuthorDate: Wed Aug 11 09:22:26 2021 +0200 Polish and cleanup documentation --- docs/user-manual/modules/ROOT/nav.adoc | 1 - .../modules/ROOT/pages/bean-integration.adoc | 4 +-- .../modules/ROOT/pages/health-check.adoc | 10 ++++-- .../modules/ROOT/pages/hiding-middleware.adoc | 37 ---------------------- .../modules/ROOT/pages/pojo-producing.adoc | 9 +++--- 5 files changed, 12 insertions(+), 49 deletions(-) diff --git a/docs/user-manual/modules/ROOT/nav.adoc b/docs/user-manual/modules/ROOT/nav.adoc index e4d26c6..e76f48b 100644 --- a/docs/user-manual/modules/ROOT/nav.adoc +++ b/docs/user-manual/modules/ROOT/nav.adoc @@ -85,7 +85,6 @@ ** xref:uris.adoc[URIs] ** xref:uuidgenerator.adoc[UuidGenerator] ** xref:validator.adoc[Validator] -** xref:hiding-middleware.adoc[Hiding Middleware] ** xref:health-check.adoc[Health Checks] * Domain Specific Languages ** xref:dsl.adoc[Camel Domain Specific Language] diff --git a/docs/user-manual/modules/ROOT/pages/bean-integration.adoc b/docs/user-manual/modules/ROOT/pages/bean-integration.adoc index e9dda9f..1fe440b 100644 --- a/docs/user-manual/modules/ROOT/pages/bean-integration.adoc +++ b/docs/user-manual/modules/ROOT/pages/bean-integration.adoc @@ -52,7 +52,5 @@ for how to use the annotations for routing and messaging. == Bean Component The xref:components::bean-component.adoc[Bean] component allows one to invoke a particular -method. Alternately the xref:components::bean-component.adoc[Bean] component supports the -creation of a proxy via `ProxyHelper` to a Java interface; which allows hiding sending data -to the endpoint via an interface. See more at xref:hiding-middleware.adoc[Hiding Middleware]. +method. diff --git a/docs/user-manual/modules/ROOT/pages/health-check.adoc b/docs/user-manual/modules/ROOT/pages/health-check.adoc index 16b1967..4ee938a 100644 --- a/docs/user-manual/modules/ROOT/pages/health-check.adoc +++ b/docs/user-manual/modules/ROOT/pages/health-check.adoc @@ -80,7 +80,7 @@ camel.health.routesEnabled=false camel.health.registryEnabled=false ---- -== Configuring routes health-check +=== Configuring routes health-check The `routes` health check supports filtering by route id, or endpoint uri using a pattern style (* as wildcard, and regexp supported). For example to turn off all routes that are from kafka, you can do: @@ -121,7 +121,7 @@ the readiness or liveness checks. The health checks can also be invoked from JMX. -== Writing a custom check: +== Writing a custom health check: There are a limited number of health checks provided by Camel out of the box, so you may need to write your own check which you can do by implementing the _HealthCheck_ interface or by extending _AbstractHealthCheck_ which provides some useful methods: @@ -155,4 +155,8 @@ The example `camel-example-main-health` has a custom health check. == Examples -You can find a standalone example in the Camel examples in the `camel-example-main-health` directory. +There are examples for Camel at: + +- Camel Standalone: https://github.com/apache/camel-examples/tree/main/examples/main-health[main-health] +- Camel Spring Boot: https://github.com/apache/camel-spring-boot-examples/tree/main/health-checks[health-checks] +- Camel Quarkus: https://github.com/apache/camel-quarkus-examples/tree/main/health[health] diff --git a/docs/user-manual/modules/ROOT/pages/hiding-middleware.adoc b/docs/user-manual/modules/ROOT/pages/hiding-middleware.adoc deleted file mode 100644 index 8c7756e..0000000 --- a/docs/user-manual/modules/ROOT/pages/hiding-middleware.adoc +++ /dev/null @@ -1,37 +0,0 @@ -= Hiding Middleware - -When writing software these days, its important to try and decouple as -much middleware code from your business logic as possible. - -This provides a number of benefits... - -* you can choose the right middleware solution for your deployment and -switch at any time -* you don't have to spend a large amount of time learning the specifics -of any particular technology, whether its xref:components::jms-component.adoc[JMS] or -xref:components::jpa-component.adoc[JPA] or xref:components::mybatis-component.adoc[MyBatis] whatever - -For example if you want to implement some kind of message passing, -remoting, reliable load balancing or asynchronous processing in your -application we recommend you use Camel annotations to bind your services -and business logic to Camel xref:components::index.adoc[Components] which means -you can then easily switch between things like - -* in JVM messaging with xref:components::seda-component.adoc[SEDA] -* using JMS via xref:components::activemq-component.adoc[ActiveMQ] or other xref:components::jms-component.adoc[JMS] -providers for reliable load balancing, grid or publish and subscribe -* for low volume, but easier administration since you're probably -already using a database you could use -** xref:components::jpa-component.adoc[JPA] to use an entity -bean / table as a queue -** xref:components::mybatis-component.adoc[MyBatis] to work with SQL -** xref:components::jdbc-component.adoc[MyBatis][JDBC] for raw SQL access - -[[HidingMiddleware-HowtodecouplefrommiddlewareAPIs]] -== How to decouple from middleware APIs - -You can bind Java beans to Camel endpoints via the -xref:bean-integration.adoc[Bean Integration]. For example using -xref:pojo-consuming.adoc[POJO Consuming] and -xref:pojo-producing.adoc[POJO Producing] you can avoid using any Camel -APIs to decouple your code both from middleware APIs _and_ Camel APIs! diff --git a/docs/user-manual/modules/ROOT/pages/pojo-producing.adoc b/docs/user-manual/modules/ROOT/pages/pojo-producing.adoc index 2c37a43..0601d90 100644 --- a/docs/user-manual/modules/ROOT/pages/pojo-producing.adoc +++ b/docs/user-manual/modules/ROOT/pages/pojo-producing.adoc @@ -41,11 +41,10 @@ attribute on *`@Produce`*, *`@EndpointInject`*. [[POJOProducing-HidingtheCamelAPIsFromYourCodeUsingProduce]] == Hiding the Camel APIs From Your Code Using `@Produce` -We recommend xref:hiding-middleware.adoc[Hiding Middleware] APIs from -your application code so the next option might be more suitable. You can -add the *`@Produce`* annotation to an injection point (a field or -property setter) using a *`ProducerTemplate`* *or* using some interface -you use in your business logic. Example: +You can hide Camel APIs from your application code so the next option might +be more suitable. You can add the *`@Produce`* annotation to an injection +point (a field or property setter) using a *`ProducerTemplate`* *or* +using some interface you use in your business logic. Example: [source,java] ----
