You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by gn...@apache.org on 2020/09/15 12:51:39 UTC
[camel] 06/06: Fix a few javadoc
This is an automated email from the ASF dual-hosted git repository.
gnodet pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 997a720d87a8b4d4cdc1eac1898aea94b992227c
Author: Guillaume Nodet <gn...@gmail.com>
AuthorDate: Tue Sep 15 10:16:31 2020 +0200
Fix a few javadoc
---
.../org/apache/camel/catalog/docs/failover-eip.adoc | 2 +-
.../docs/faultToleranceConfiguration-eip.adoc | 2 +-
.../org/apache/camel/catalog/models/failover.json | 2 +-
.../catalog/models/faultToleranceConfiguration.json | 2 +-
.../apache/camel/catalog/schemas/camel-spring.xsd | 4 ++--
.../camel/model/faultToleranceConfiguration.json | 2 +-
.../apache/camel/model/loadbalancer/failover.json | 2 +-
.../main/docs/modules/eips/pages/failover-eip.adoc | 2 +-
.../eips/pages/faultToleranceConfiguration-eip.adoc | 2 +-
.../model/FaultToleranceConfigurationCommon.java | 2 +-
.../model/FaultToleranceConfigurationDefinition.java | 20 ++++++++++++++++++--
.../loadbalancer/FailoverLoadBalancerDefinition.java | 4 ++--
12 files changed, 31 insertions(+), 15 deletions(-)
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/failover-eip.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/failover-eip.adoc
index 98be858..37ee085 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/failover-eip.adoc
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/failover-eip.adoc
@@ -15,7 +15,7 @@ The Failover EIP supports 4 options which are listed below:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *exception* | A list of class names for specific exceptions to monitor. If no exceptions are configured then all exceptions is monitored | | List
+| *exception* | A list of class names for specific exceptions to monitor. If no exceptions are configured then all exceptions are monitored | | List
| *roundRobin* | Whether or not the failover load balancer should operate in round robin mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If round robin is enabled, then it keeps state and will continue with the next endpoint in a round robin fashion. You can also enable sticky mode together with round robin, if so then it will pick the last known good endpoint to use wh [...]
| *sticky* | Whether or not the failover load balancer should operate in sticky mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If sticky is enabled, then it keeps state and will continue with the last known good endpoint. You can also enable sticky mode together with round robin, if so then it will pick the last known good endpoint to use when starting the load balanci [...]
| *maximumFailoverAttempts* | A value to indicate after X failover attempts we should exhaust (give up). Use -1 to indicate never give up and continuously try to failover. Use 0 to never failover. And use e.g. 3 to failover at most 3 times before giving up. his option can be used whether or not roundRobin is enabled or not. | -1 | String
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/faultToleranceConfiguration-eip.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/faultToleranceConfiguration-eip.adoc
index 11e52c3..107bbe9 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/faultToleranceConfiguration-eip.adoc
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/faultToleranceConfiguration-eip.adoc
@@ -13,7 +13,7 @@ The Fault Tolerance Configuration EIP supports 13 options which are listed below
|===
| Name | Description | Default | Type
| *circuitBreakerRef* | Refers to an existing io.smallrye.faulttolerance.core.circuit.breaker.CircuitBreaker instance to lookup and use from the registry. When using this, then any other circuit breaker options are not in use. | | String
-| *delay* | Control how long the circuit breaker stays open. The value are in seconds and the default is 5 seconds. | 5s | String
+| *delay* | Control how long the circuit breaker stays open. The default is 5 seconds. | 5s | String
| *successThreshold* | Controls the number of trial calls which are allowed when the circuit breaker is half-open | 1 | Integer
| *requestVolumeThreshold* | Controls the size of the rolling window used when the circuit breaker is closed | 20 | Integer
| *failureRatio* | Configures the failure rate threshold in percentage. If the failure rate is equal or greater than the threshold the CircuitBreaker transitions to open and starts short-circuiting calls. The threshold must be greater than 0 and not greater than 100. Default value is 50 percentage. | 50 | Integer
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/failover.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/failover.json
index e017813..9579cfa 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/failover.json
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/failover.json
@@ -11,7 +11,7 @@
"output": false
},
"properties": {
- "exception": { "kind": "element", "displayName": "Exception", "required": false, "type": "array", "javaType": "java.util.List<java.lang.String>", "deprecated": false, "secret": false, "description": "A list of class names for specific exceptions to monitor. If no exceptions is configured then all exceptions is monitored" },
+ "exception": { "kind": "element", "displayName": "Exception", "required": false, "type": "array", "javaType": "java.util.List<java.lang.String>", "deprecated": false, "secret": false, "description": "A list of class names for specific exceptions to monitor. If no exceptions are configured then all exceptions are monitored" },
"roundRobin": { "kind": "attribute", "displayName": "Round Robin", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Whether or not the failover load balancer should operate in round robin mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If round robin is enabled, then it keeps state and will co [...]
"sticky": { "kind": "attribute", "displayName": "Sticky", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Whether or not the failover load balancer should operate in sticky mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If sticky is enabled, then it keeps state and will continue with the las [...]
"maximumFailoverAttempts": { "kind": "attribute", "displayName": "Maximum Failover Attempts", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "defaultValue": "-1", "description": "A value to indicate after X failover attempts we should exhaust (give up). Use -1 to indicate never give up and continuously try to failover. Use 0 to never failover. And use e.g. 3 to failover at most 3 times before giving up. his option can be use [...]
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/faultToleranceConfiguration.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/faultToleranceConfiguration.json
index 2db6b8d..cf9fab4 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/faultToleranceConfiguration.json
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/faultToleranceConfiguration.json
@@ -12,7 +12,7 @@
},
"properties": {
"circuitBreakerRef": { "kind": "attribute", "displayName": "Circuit Breaker Ref", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Refers to an existing io.smallrye.faulttolerance.core.circuit.breaker.CircuitBreaker instance to lookup and use from the registry. When using this, then any other circuit breaker options are not in use." },
- "delay": { "kind": "attribute", "displayName": "Delay", "required": false, "type": "duration", "javaType": "java.lang.String", "deprecated": false, "secret": false, "defaultValue": "5s", "description": "Control how long the circuit breaker stays open. The values are in seconds and the default value is 5 seconds." },
+ "delay": { "kind": "attribute", "displayName": "Delay", "required": false, "type": "duration", "javaType": "java.lang.String", "deprecated": false, "secret": false, "defaultValue": "5s", "description": "Control how long the circuit breaker stays open. The default is 5 seconds." },
"successThreshold": { "kind": "attribute", "displayName": "Success Threshold", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "secret": false, "defaultValue": "1", "description": "Controls the number of trial calls which are allowed when the circuit breaker is half-open" },
"requestVolumeThreshold": { "kind": "attribute", "displayName": "Request Volume Threshold", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "secret": false, "defaultValue": "20", "description": "Controls the size of the rolling window used when the circuit breaker is closed" },
"failureRatio": { "kind": "attribute", "displayName": "Failure Ratio", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "secret": false, "defaultValue": "50", "description": "Configures the failure rate threshold in percentage. If the failure rate is equal or greater than the threshold the CircuitBreaker transitions to open and starts short-circuiting calls. The threshold must be greater than 0 and not greater than 100. Default value is 50 p [...]
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
index b54d1a1..d4be3ef 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
@@ -4136,8 +4136,8 @@ breaker options are not in use.
<xs:attribute name="delay" type="xs:string">
<xs:annotation>
<xs:documentation xml:lang="en"><![CDATA[
-Control how long the circuit breaker stays open. The values are in seconds and
-the default value is 5 seconds. Default value: 5s
+Control how long the circuit breaker stays open. The default is 5 seconds.
+Default value: 5s
]]></xs:documentation>
</xs:annotation>
</xs:attribute>
diff --git a/core/camel-core-engine/src/generated/resources/org/apache/camel/model/faultToleranceConfiguration.json b/core/camel-core-engine/src/generated/resources/org/apache/camel/model/faultToleranceConfiguration.json
index 2db6b8d..cf9fab4 100644
--- a/core/camel-core-engine/src/generated/resources/org/apache/camel/model/faultToleranceConfiguration.json
+++ b/core/camel-core-engine/src/generated/resources/org/apache/camel/model/faultToleranceConfiguration.json
@@ -12,7 +12,7 @@
},
"properties": {
"circuitBreakerRef": { "kind": "attribute", "displayName": "Circuit Breaker Ref", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Refers to an existing io.smallrye.faulttolerance.core.circuit.breaker.CircuitBreaker instance to lookup and use from the registry. When using this, then any other circuit breaker options are not in use." },
- "delay": { "kind": "attribute", "displayName": "Delay", "required": false, "type": "duration", "javaType": "java.lang.String", "deprecated": false, "secret": false, "defaultValue": "5s", "description": "Control how long the circuit breaker stays open. The values are in seconds and the default value is 5 seconds." },
+ "delay": { "kind": "attribute", "displayName": "Delay", "required": false, "type": "duration", "javaType": "java.lang.String", "deprecated": false, "secret": false, "defaultValue": "5s", "description": "Control how long the circuit breaker stays open. The default is 5 seconds." },
"successThreshold": { "kind": "attribute", "displayName": "Success Threshold", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "secret": false, "defaultValue": "1", "description": "Controls the number of trial calls which are allowed when the circuit breaker is half-open" },
"requestVolumeThreshold": { "kind": "attribute", "displayName": "Request Volume Threshold", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "secret": false, "defaultValue": "20", "description": "Controls the size of the rolling window used when the circuit breaker is closed" },
"failureRatio": { "kind": "attribute", "displayName": "Failure Ratio", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "secret": false, "defaultValue": "50", "description": "Configures the failure rate threshold in percentage. If the failure rate is equal or greater than the threshold the CircuitBreaker transitions to open and starts short-circuiting calls. The threshold must be greater than 0 and not greater than 100. Default value is 50 p [...]
diff --git a/core/camel-core-engine/src/generated/resources/org/apache/camel/model/loadbalancer/failover.json b/core/camel-core-engine/src/generated/resources/org/apache/camel/model/loadbalancer/failover.json
index e017813..9579cfa 100644
--- a/core/camel-core-engine/src/generated/resources/org/apache/camel/model/loadbalancer/failover.json
+++ b/core/camel-core-engine/src/generated/resources/org/apache/camel/model/loadbalancer/failover.json
@@ -11,7 +11,7 @@
"output": false
},
"properties": {
- "exception": { "kind": "element", "displayName": "Exception", "required": false, "type": "array", "javaType": "java.util.List<java.lang.String>", "deprecated": false, "secret": false, "description": "A list of class names for specific exceptions to monitor. If no exceptions is configured then all exceptions is monitored" },
+ "exception": { "kind": "element", "displayName": "Exception", "required": false, "type": "array", "javaType": "java.util.List<java.lang.String>", "deprecated": false, "secret": false, "description": "A list of class names for specific exceptions to monitor. If no exceptions are configured then all exceptions are monitored" },
"roundRobin": { "kind": "attribute", "displayName": "Round Robin", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Whether or not the failover load balancer should operate in round robin mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If round robin is enabled, then it keeps state and will co [...]
"sticky": { "kind": "attribute", "displayName": "Sticky", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Whether or not the failover load balancer should operate in sticky mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If sticky is enabled, then it keeps state and will continue with the las [...]
"maximumFailoverAttempts": { "kind": "attribute", "displayName": "Maximum Failover Attempts", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "defaultValue": "-1", "description": "A value to indicate after X failover attempts we should exhaust (give up). Use -1 to indicate never give up and continuously try to failover. Use 0 to never failover. And use e.g. 3 to failover at most 3 times before giving up. his option can be use [...]
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/failover-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/failover-eip.adoc
index 98be858..37ee085 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/failover-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/failover-eip.adoc
@@ -15,7 +15,7 @@ The Failover EIP supports 4 options which are listed below:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *exception* | A list of class names for specific exceptions to monitor. If no exceptions are configured then all exceptions is monitored | | List
+| *exception* | A list of class names for specific exceptions to monitor. If no exceptions are configured then all exceptions are monitored | | List
| *roundRobin* | Whether or not the failover load balancer should operate in round robin mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If round robin is enabled, then it keeps state and will continue with the next endpoint in a round robin fashion. You can also enable sticky mode together with round robin, if so then it will pick the last known good endpoint to use wh [...]
| *sticky* | Whether or not the failover load balancer should operate in sticky mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If sticky is enabled, then it keeps state and will continue with the last known good endpoint. You can also enable sticky mode together with round robin, if so then it will pick the last known good endpoint to use when starting the load balanci [...]
| *maximumFailoverAttempts* | A value to indicate after X failover attempts we should exhaust (give up). Use -1 to indicate never give up and continuously try to failover. Use 0 to never failover. And use e.g. 3 to failover at most 3 times before giving up. his option can be used whether or not roundRobin is enabled or not. | -1 | String
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/faultToleranceConfiguration-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/faultToleranceConfiguration-eip.adoc
index 11e52c3..107bbe9 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/faultToleranceConfiguration-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/faultToleranceConfiguration-eip.adoc
@@ -13,7 +13,7 @@ The Fault Tolerance Configuration EIP supports 13 options which are listed below
|===
| Name | Description | Default | Type
| *circuitBreakerRef* | Refers to an existing io.smallrye.faulttolerance.core.circuit.breaker.CircuitBreaker instance to lookup and use from the registry. When using this, then any other circuit breaker options are not in use. | | String
-| *delay* | Control how long the circuit breaker stays open. The value are in seconds and the default is 5 seconds. | 5s | String
+| *delay* | Control how long the circuit breaker stays open. The default is 5 seconds. | 5s | String
| *successThreshold* | Controls the number of trial calls which are allowed when the circuit breaker is half-open | 1 | Integer
| *requestVolumeThreshold* | Controls the size of the rolling window used when the circuit breaker is closed | 20 | Integer
| *failureRatio* | Configures the failure rate threshold in percentage. If the failure rate is equal or greater than the threshold the CircuitBreaker transitions to open and starts short-circuiting calls. The threshold must be greater than 0 and not greater than 100. Default value is 50 percentage. | 50 | Integer
diff --git a/core/camel-core-engine/src/main/java/org/apache/camel/model/FaultToleranceConfigurationCommon.java b/core/camel-core-engine/src/main/java/org/apache/camel/model/FaultToleranceConfigurationCommon.java
index 532e825..16b2636 100644
--- a/core/camel-core-engine/src/main/java/org/apache/camel/model/FaultToleranceConfigurationCommon.java
+++ b/core/camel-core-engine/src/main/java/org/apache/camel/model/FaultToleranceConfigurationCommon.java
@@ -85,7 +85,7 @@ public class FaultToleranceConfigurationCommon extends IdentifiedType {
}
/**
- * Control how long the circuit breaker stays open. The values are in seconds and the default value is 5 seconds.
+ * Control how long the circuit breaker stays open. The default is 5 seconds.
*/
public void setDelay(String delay) {
this.delay = delay;
diff --git a/core/camel-core-engine/src/main/java/org/apache/camel/model/FaultToleranceConfigurationDefinition.java b/core/camel-core-engine/src/main/java/org/apache/camel/model/FaultToleranceConfigurationDefinition.java
index edb14c8..e89e292 100644
--- a/core/camel-core-engine/src/main/java/org/apache/camel/model/FaultToleranceConfigurationDefinition.java
+++ b/core/camel-core-engine/src/main/java/org/apache/camel/model/FaultToleranceConfigurationDefinition.java
@@ -56,7 +56,7 @@ public class FaultToleranceConfigurationDefinition extends FaultToleranceConfigu
}
/**
- * Control how long the circuit breaker stays open. The value are in seconds and the default is 60 seconds.
+ * Control how long the circuit breaker stays open. The default is 5 seconds.
*/
public FaultToleranceConfigurationDefinition delay(long delay) {
setDelay(Long.toString(delay));
@@ -64,6 +64,14 @@ public class FaultToleranceConfigurationDefinition extends FaultToleranceConfigu
}
/**
+ * Control how long the circuit breaker stays open. The default is 5 seconds.
+ */
+ public FaultToleranceConfigurationDefinition delay(String delay) {
+ setDelay(delay);
+ return this;
+ }
+
+ /**
* Controls the number of trial calls which are allowed when the circuit breaker is half-open
*/
public FaultToleranceConfigurationDefinition successThreshold(int successThreshold) {
@@ -99,7 +107,7 @@ public class FaultToleranceConfigurationDefinition extends FaultToleranceConfigu
}
/**
- * Configures the thread execution timeout (millis). Default value is 1000 millis (1 second).
+ * Configures the thread execution timeout. Default value is 1 second.
*/
public FaultToleranceConfigurationDefinition timeoutDuration(long timeoutDuration) {
setTimeoutDuration(Long.toString(timeoutDuration));
@@ -107,6 +115,14 @@ public class FaultToleranceConfigurationDefinition extends FaultToleranceConfigu
}
/**
+ * Configures the thread execution timeout. Default value is 1 second.
+ */
+ public FaultToleranceConfigurationDefinition timeoutDuration(String timeoutDuration) {
+ setTimeoutDuration(timeoutDuration);
+ return this;
+ }
+
+ /**
* Configures the pool size of the thread pool when timeout is enabled. Default value is 10.
*/
public FaultToleranceConfigurationDefinition timeoutPoolSize(int poolSize) {
diff --git a/core/camel-core-engine/src/main/java/org/apache/camel/model/loadbalancer/FailoverLoadBalancerDefinition.java b/core/camel-core-engine/src/main/java/org/apache/camel/model/loadbalancer/FailoverLoadBalancerDefinition.java
index 650c96b..a8aa605 100644
--- a/core/camel-core-engine/src/main/java/org/apache/camel/model/loadbalancer/FailoverLoadBalancerDefinition.java
+++ b/core/camel-core-engine/src/main/java/org/apache/camel/model/loadbalancer/FailoverLoadBalancerDefinition.java
@@ -59,7 +59,7 @@ public class FailoverLoadBalancerDefinition extends LoadBalancerDefinition {
}
/**
- * A list of class names for specific exceptions to monitor. If no exceptions is configured then all exceptions is
+ * A list of class names for specific exceptions to monitor. If no exceptions are configured then all exceptions are
* monitored
*/
public void setExceptions(List<String> exceptions) {
@@ -71,7 +71,7 @@ public class FailoverLoadBalancerDefinition extends LoadBalancerDefinition {
}
/**
- * A list of specific exceptions to monitor. If no exceptions is configured then all exceptions is monitored
+ * A list of specific exceptions to monitor. If no exceptions are configured then all exceptions are monitored
*/
public void setExceptionTypes(List<Class<?>> exceptionTypes) {
this.exceptionTypes = exceptionTypes;