[camel] branch master updated: CAMEL-12702: Improved spring boot docs

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[camel] branch master updated: CAMEL-12702: Improved spring boot docs

davsclaus-2
This is an automated email from the ASF dual-hosted git repository.

davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git


The following commit(s) were added to refs/heads/master by this push:
     new ffa5063  CAMEL-12702: Improved spring boot docs
ffa5063 is described below

commit ffa506381ec0ccec27a071c09b2206fdc43684f4
Author: Claus Ibsen <[hidden email]>
AuthorDate: Tue Jul 31 20:45:43 2018 +0200

    CAMEL-12702: Improved spring boot docs
---
 .../src/main/docs/spring-boot.adoc                 | 28 +++++++++++-----------
 .../ClusteredRouteControllerConfiguration.java     |  7 +++---
 .../health/AbstractHealthCheckConfiguration.java   | 10 +-------
 .../health/HealthCheckRoutesConfiguration.java     | 13 +++++-----
 .../HealthCheckServiceAutoConfiguration.java       |  1 -
 .../health/HealthCheckServiceConfiguration.java    |  6 ++---
 6 files changed, 27 insertions(+), 38 deletions(-)

diff --git a/components/camel-spring-boot/src/main/docs/spring-boot.adoc b/components/camel-spring-boot/src/main/docs/spring-boot.adoc
index ef8ce5f..1f3690c 100644
--- a/components/camel-spring-boot/src/main/docs/spring-boot.adoc
+++ b/components/camel-spring-boot/src/main/docs/spring-boot.adoc
@@ -108,29 +108,29 @@ The component supports 139 options, which are listed below.
 | *camel.cloud.service-registry.enabled* | Configure if service registry should be enabled or not, default true. | true | Boolean
 | *camel.cloud.service-registry.service-host* | Configure the service listening address. |  | String
 | *camel.clustered.controller.cluster-service* | The cluster service. |  | CamelClusterService
-| *camel.clustered.controller.enabled* | Global option to enable/disable this ${@link org.apache.camel.spi.RouteController}, default is false. | false | Boolean
-| *camel.clustered.controller.initial-delay* | Set the amount of time the route controller should wait before to start the routes after the camel context is started or after the route is initialized if the route is created after the camel context is started. |  | String
+| *camel.clustered.controller.enabled* | Global option to enable/disable Camel clustered route controller, default is false. | false | Boolean
+| *camel.clustered.controller.initial-delay* | Set the amount of time (in millis) the route controller should wait before to start the routes after the camel context is started or after the route is initialized if the route is created after the camel context is started. |  | String
 | *camel.clustered.controller.namespace* | The default namespace. |  | String
 | *camel.clustered.controller.routes* | Routes configuration. |  | Map
 | *camel.component.enabled* | Global option to enable/disable component auto-configuration, default is true. | true | Boolean
 | *camel.dataformat.enabled* | Global option to enable/disable dataformat auto-configuration, default is true. | true | Boolean
-| *camel.health.check.routes.enabled* | Global option to enable/disable this ${@link org.apache.camel.health.HealthCheckRepository}, default is false. | false | Boolean
-| *camel.health.check.routes.threshold* | configurations |  | Map
+| *camel.health.check.routes.enabled* | Global option to enable/disable Camel extended health check for routes, default is false. | false | Boolean
+| *camel.health.check.routes.threshold* | General health check configurations. |  | Map
 | *camel.health.check.routes.thresholds.exchanges-failed* | Number of failed exchanges. |  | Long
 | *camel.health.check.routes.thresholds.exchanges-inflight* | Number of inflight exchanges. |  | Long
 | *camel.health.check.routes.thresholds.external-redeliveries* | Number of external initiated redeliveries (such as from JMS broker). |  | Long
-| *camel.health.check.routes.thresholds.last-processing-time.failures* | Failures |  | Integer
-| *camel.health.check.routes.thresholds.last-processing-time.threshold* | The Threshold |  | String
-| *camel.health.check.routes.thresholds.max-processing-time.failures* | Failures |  | Integer
-| *camel.health.check.routes.thresholds.max-processing-time.threshold* | The Threshold |  | String
-| *camel.health.check.routes.thresholds.mean-processing-time.failures* | Failures |  | Integer
-| *camel.health.check.routes.thresholds.mean-processing-time.threshold* | The Threshold |  | String
-| *camel.health.check.routes.thresholds.min-processing-time.failures* | Failures |  | Integer
-| *camel.health.check.routes.thresholds.min-processing-time.threshold* | The Threshold |  | String
+| *camel.health.check.routes.thresholds.last-processing-time.failures* | The threshold of number of failures. |  | Integer
+| *camel.health.check.routes.thresholds.last-processing-time.threshold* | The threshold value. |  | String
+| *camel.health.check.routes.thresholds.max-processing-time.failures* | The threshold of number of failures. |  | Integer
+| *camel.health.check.routes.thresholds.max-processing-time.threshold* | The threshold value. |  | String
+| *camel.health.check.routes.thresholds.mean-processing-time.failures* | The threshold of number of failures. |  | Integer
+| *camel.health.check.routes.thresholds.mean-processing-time.threshold* | The threshold value. |  | String
+| *camel.health.check.routes.thresholds.min-processing-time.failures* | The threshold of number of failures. |  | Integer
+| *camel.health.check.routes.thresholds.min-processing-time.threshold* | The threshold value. |  | String
 | *camel.health.check.routes.thresholds.redeliveries* | Number of redeliveries (internal only). |  | Long
 | *camel.health.check.service.check-interval* | The interval between checks. |  | String
-| *camel.health.check.service.checks* | Checks configuration.s |  | Map
-| *camel.health.check.service.enabled* | Global option to enable/disable this ${@link org.apache.camel.health.HealthCheckService}, default is false. | false | Boolean
+| *camel.health.check.service.checks* | Configuration of health checks |  | Map
+| *camel.health.check.service.enabled* | Global option to enable/disable extended Camel health checks, default is false. | false | Boolean
 | *camel.health.enabled* | Global option to enable/disable camel health bean, default is true. | true | Boolean
 | *camel.language.enabled* | Global option to enable/disable language auto-configuration, default is true. | true | Boolean
 | *camel.springboot.allow-use-original-message* | Sets whether to allow access to the original message from Camel's error handler, or from org.apache.camel.spi.UnitOfWork.getOriginalInMessage(). Turning this off can optimize performance, as defensive copy of the original message is not needed. Default is false. | false | Boolean
diff --git a/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/cluster/ClusteredRouteControllerConfiguration.java b/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/cluster/ClusteredRouteControllerConfiguration.java
index d27751f..32798b1 100644
--- a/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/cluster/ClusteredRouteControllerConfiguration.java
+++ b/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/cluster/ClusteredRouteControllerConfiguration.java
@@ -26,12 +26,12 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
 @ConfigurationProperties(prefix = "camel.clustered.controller")
 public class ClusteredRouteControllerConfiguration {
     /**
-     * Global option to enable/disable this ${@link org.apache.camel.spi.RouteController}, default is false.
+     * Global option to enable/disable Camel clustered route controller, default is false.
      */
     private boolean enabled;
 
     /**
-     * Set the amount of time the route controller should wait before to start
+     * Set the amount of time (in millis) the route controller should wait before to start
      * the routes after the camel context is started or after the route is
      * initialized if the route is created after the camel context is started.
      */
@@ -108,7 +108,7 @@ public class ClusteredRouteControllerConfiguration {
         private boolean clustered = true;
 
         /**
-         * Set the amount of time the route controller should wait before to start
+         * Set the amount of time (in millis) the route controller should wait before to start
          * the routes after the camel context is started or after the route is
          * initialized if the route is created after the camel context is started.
          */
@@ -119,7 +119,6 @@ public class ClusteredRouteControllerConfiguration {
          */
         private String namespace;
 
-
         public boolean isClustered() {
             return clustered;
         }
diff --git a/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/AbstractHealthCheckConfiguration.java b/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/AbstractHealthCheckConfiguration.java
index e59f34d..87942d4 100644
--- a/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/AbstractHealthCheckConfiguration.java
+++ b/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/AbstractHealthCheckConfiguration.java
@@ -34,10 +34,8 @@ public abstract class AbstractHealthCheckConfiguration {
      */
     private Integer failureThreshold;
 
-
     /**
-     * @return true if the check associated to this configuration is enabled,
-     * false otherwise.
+     * Set if the check associated to this configuration is enabled or not.
      */
     public Boolean isEnabled() {
         return enabled;
@@ -50,9 +48,6 @@ public abstract class AbstractHealthCheckConfiguration {
         this.enabled = enabled;
     }
 
-    /**
-     * @return the check interval.
-     */
     public String getInterval() {
         return interval;
     }
@@ -64,9 +59,6 @@ public abstract class AbstractHealthCheckConfiguration {
         this.interval = interval;
     }
 
-    /**
-     * @return the number of failure before reporting the service as un-healthy.
-     */
     public Integer getFailureThreshold() {
         return failureThreshold;
     }
diff --git a/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/HealthCheckRoutesConfiguration.java b/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/HealthCheckRoutesConfiguration.java
index 8555b3b..781970a 100644
--- a/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/HealthCheckRoutesConfiguration.java
+++ b/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/HealthCheckRoutesConfiguration.java
@@ -24,17 +24,17 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
 @ConfigurationProperties(prefix = HealthConstants.HEALTH_CHECK_ROUTES_PREFIX)
 public class HealthCheckRoutesConfiguration {
     /**
-     * Global option to enable/disable this ${@link org.apache.camel.health.HealthCheckRepository}, default is false.
+     * Global option to enable/disable Camel extended health check for routes, default is false.
      */
     private boolean enabled;
 
     /**
-     * configuration
+     * Threshold healthc check configurations.
      */
     private ThresholdsConfiguration thresholds = new ThresholdsConfiguration();
 
     /**
-     * configurations
+     * General health check configurations.
      */
     private Map<String, RouteThresholdsConfiguration> threshold;
 
@@ -130,7 +130,6 @@ public class HealthCheckRoutesConfiguration {
          */
         protected ThresholdsWithFailuresConfiguration maxProcessingTime;
 
-
         public Long getExchangesFailed() {
             return exchangesFailed;
         }
@@ -206,7 +205,7 @@ public class HealthCheckRoutesConfiguration {
 
     public static class RouteThresholdsConfiguration extends ThresholdsConfiguration {
         /**
-         * Inherit from global from global configuration;
+         * Inherit from global from global configuration.
          */
         private boolean inherit = true;
 
@@ -221,12 +220,12 @@ public class HealthCheckRoutesConfiguration {
 
     public static class ThresholdsWithFailuresConfiguration {
         /**
-         * The Threshold
+         * The threshold value.
          */
         private String threshold;
 
         /**
-         * Failures
+         * The threshold of number of failures.
          */
         private Integer failures;
 
diff --git a/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/HealthCheckServiceAutoConfiguration.java b/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/HealthCheckServiceAutoConfiguration.java
index 58a10cb..a688ba9 100644
--- a/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/HealthCheckServiceAutoConfiguration.java
+++ b/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/HealthCheckServiceAutoConfiguration.java
@@ -16,7 +16,6 @@
  */
 package org.apache.camel.spring.boot.health;
 
-
 import java.util.Objects;
 import java.util.Optional;
 import java.util.concurrent.TimeUnit;
diff --git a/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/HealthCheckServiceConfiguration.java b/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/HealthCheckServiceConfiguration.java
index fdd5108..12b9139 100644
--- a/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/HealthCheckServiceConfiguration.java
+++ b/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/health/HealthCheckServiceConfiguration.java
@@ -24,7 +24,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
 @ConfigurationProperties(prefix = HealthConstants.HEALTH_CHECK_SERVICE_PREFIX)
 public class HealthCheckServiceConfiguration {
     /**
-     * Global option to enable/disable this ${@link org.apache.camel.health.HealthCheckService}, default is false.
+     * Global option to enable/disable extended Camel health checks, default is false.
      */
     private boolean enabled;
 
@@ -34,7 +34,7 @@ public class HealthCheckServiceConfiguration {
     private String checkInterval;
 
     /**
-     * Checks configuration.s
+     * Configuration of health checks
      */
     private Map<String, Check> checks = new HashMap<>();
 
@@ -64,7 +64,7 @@ public class HealthCheckServiceConfiguration {
 
     public class Check {
         /**
-         * Option for this check.
+         * Option for this health check.
          */
         private Map<String, Object> options;