This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch fix/CAMEL-23816 in repository https://gitbox.apache.org/repos/asf/camel.git
commit f1e0b44b3a643feba24d6d872f0fc9786f3c23a6 Author: Claus Ibsen <[email protected]> AuthorDate: Tue Jun 23 15:19:45 2026 +0200 CAMEL-23816: Improve descriptions in additional model classes for catalog and MCP tools Co-Authored-By: Claude Opus 4.6 <[email protected]> --- .../org/apache/camel/model/BeanDefinition.java | 3 +- .../apache/camel/model/BeanFactoryDefinition.java | 12 ++-- .../camel/model/CircuitBreakerDefinition.java | 3 +- .../apache/camel/model/ConvertBodyDefinition.java | 6 +- .../camel/model/ConvertHeaderDefinition.java | 6 +- .../camel/model/ConvertVariableDefinition.java | 6 +- .../model/InterceptSendToEndpointDefinition.java | 3 +- .../model/OptimisticLockRetryPolicyDefinition.java | 15 +++-- .../org/apache/camel/model/PausableDefinition.java | 6 +- .../org/apache/camel/model/PollDefinition.java | 5 +- .../camel/model/RedeliveryPolicyDefinition.java | 72 ++++++++++++++-------- .../camel/model/RemoveHeadersDefinition.java | 3 +- .../camel/model/RemovePropertiesDefinition.java | 3 +- .../apache/camel/model/ResequenceDefinition.java | 2 +- .../apache/camel/model/ResumableDefinition.java | 9 ++- .../org/apache/camel/model/RouteDefinition.java | 30 ++++----- .../org/apache/camel/model/SortDefinition.java | 3 +- .../camel/model/TemplatedRouteDefinition.java | 6 +- .../apache/camel/model/UnmarshalDefinition.java | 3 +- .../camel/model/config/BatchResequencerConfig.java | 15 +++-- .../model/config/StreamResequencerConfig.java | 18 ++++-- 21 files changed, 147 insertions(+), 82 deletions(-) diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/BeanDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/BeanDefinition.java index 298fc870a69c..424c9c85d870 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/BeanDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/BeanDefinition.java @@ -49,7 +49,8 @@ public class BeanDefinition extends NoOutputDefinition<BeanDefinition> { @XmlAttribute private String beanType; @XmlAttribute - @Metadata(label = "advanced", defaultValue = "Singleton", enums = "Singleton,Request,Prototype") + @Metadata(label = "advanced", defaultValue = "Singleton", enums = "Singleton,Request,Prototype", + description = "Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint.") private String scope; public BeanDefinition() { diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/BeanFactoryDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/BeanFactoryDefinition.java index f0e10b12466a..028de9282417 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/BeanFactoryDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/BeanFactoryDefinition.java @@ -67,13 +67,16 @@ public class BeanFactoryDefinition<P> implements ResourceAware { @XmlAttribute private String builderClass; @XmlAttribute - @Metadata(defaultValue = "build") + @Metadata(defaultValue = "build", + description = "Name of method when using builder class. This method is invoked after configuring to create the actual bean. This method is often named build (used by default).") private String builderMethod; @XmlAttribute - @Metadata(label = "advanced") + @Metadata(label = "advanced", + description = "The script language to use when using inlined script for creating the bean, such as groovy, java, javascript etc.") private String scriptLanguage; @XmlAttribute - @Metadata(javaType = "java.lang.Boolean", label = "advanced", defaultValue = "true") + @Metadata(javaType = "java.lang.Boolean", label = "advanced", defaultValue = "true", + description = "Whether the script should support using Camel property placeholder syntax {{ }}.") private String scriptPropertyPlaceholders; @XmlElement(name = "constructors") @XmlJavaTypeAdapter(BeanConstructorsAdapter.class) @@ -82,7 +85,8 @@ public class BeanFactoryDefinition<P> implements ResourceAware { @XmlJavaTypeAdapter(BeanPropertiesAdapter.class) private Map<String, Object> properties; @XmlElement(name = "script") - @Metadata(label = "advanced") + @Metadata(label = "advanced", + description = "The script to execute that creates the bean when using scripting languages.") private String script; public void setParent(P parent) { diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/CircuitBreakerDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/CircuitBreakerDefinition.java index 7d420c92b025..4b915abdf49a 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/CircuitBreakerDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/CircuitBreakerDefinition.java @@ -40,7 +40,8 @@ public class CircuitBreakerDefinition extends OutputDefinition<CircuitBreakerDef @XmlAttribute private String configuration; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "false") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "false", + description = "Whether to inherit Camel error handling during circuit breaker. By default, Camel error handler is turned off.") private Boolean inheritErrorHandler; @XmlElement private Resilience4jConfigurationDefinition resilience4jConfiguration; diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/ConvertBodyDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/ConvertBodyDefinition.java index bde906eb60f6..42c10abcb50f 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/ConvertBodyDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/ConvertBodyDefinition.java @@ -40,10 +40,12 @@ public class ConvertBodyDefinition extends NoOutputDefinition<ConvertBodyDefinit @DslArg(renderType = "class") private String type; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true", + description = "Whether the conversion is mandatory. If mandatory and conversion is not possible, a NoTypeConversionAvailableException is thrown." + + " Setting this to false means null may be returned if conversion is not possible.") private String mandatory; @XmlAttribute - @Metadata(label = "advanced") + @Metadata(label = "advanced", description = "To use a specific charset when converting.") private String charset; public ConvertBodyDefinition() { diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/ConvertHeaderDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/ConvertHeaderDefinition.java index 3211de976cb3..a4299c382ccb 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/ConvertHeaderDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/ConvertHeaderDefinition.java @@ -45,10 +45,12 @@ public class ConvertHeaderDefinition extends NoOutputDefinition<ConvertHeaderDef @XmlAttribute private String toName; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true", + description = "Whether the conversion is mandatory. If mandatory and conversion is not possible, a NoTypeConversionAvailableException is thrown." + + " Setting this to false means null may be returned if conversion is not possible.") private String mandatory; @XmlAttribute - @Metadata(label = "advanced") + @Metadata(label = "advanced", description = "To use a specific charset when converting.") private String charset; public ConvertHeaderDefinition() { diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/ConvertVariableDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/ConvertVariableDefinition.java index e9afc4972185..e8b394a58849 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/ConvertVariableDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/ConvertVariableDefinition.java @@ -45,10 +45,12 @@ public class ConvertVariableDefinition extends NoOutputDefinition<ConvertVariabl @XmlAttribute private String toName; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true", + description = "Whether the conversion is mandatory. If mandatory and conversion is not possible, a NoTypeConversionAvailableException is thrown." + + " Setting this to false means null may be returned if conversion is not possible.") private String mandatory; @XmlAttribute - @Metadata(label = "advanced") + @Metadata(label = "advanced", description = "To use a specific charset when converting.") private String charset; public ConvertVariableDefinition() { diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/InterceptSendToEndpointDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/InterceptSendToEndpointDefinition.java index 74262b05e98f..30b022006dcb 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/InterceptSendToEndpointDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/InterceptSendToEndpointDefinition.java @@ -44,7 +44,8 @@ public class InterceptSendToEndpointDefinition extends OutputDefinition<Intercep @XmlAttribute private String skipSendToOriginalEndpoint; @XmlAttribute - @Metadata(label = "advanced") + @Metadata(label = "advanced", + description = "After sending to the endpoint then send the message to this uri which allows to process its result.") private String afterUri; @Metadata(description = "To use an expression to only trigger intercepting sending to an endpoint in specific situations") @XmlElement diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/OptimisticLockRetryPolicyDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/OptimisticLockRetryPolicyDefinition.java index 92c5f91dd85b..c33b8a814485 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/OptimisticLockRetryPolicyDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/OptimisticLockRetryPolicyDefinition.java @@ -32,19 +32,24 @@ import org.apache.camel.spi.Metadata; public class OptimisticLockRetryPolicyDefinition { @XmlAttribute - @Metadata(javaType = "java.lang.Integer") + @Metadata(javaType = "java.lang.Integer", + description = "Sets the maximum number of retries.") private String maximumRetries; @XmlAttribute - @Metadata(javaType = "java.time.Duration", defaultValue = "50") + @Metadata(javaType = "java.time.Duration", defaultValue = "50", + description = "Sets the delay in millis between retries.") private String retryDelay; @XmlAttribute - @Metadata(javaType = "java.time.Duration", defaultValue = "1000") + @Metadata(javaType = "java.time.Duration", defaultValue = "1000", + description = "Sets the upper value of retry in millis between retries, when using exponential or random backoff.") private String maximumRetryDelay; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true", + description = "Whether to enable exponential backoff.") private String exponentialBackOff; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", + description = "Whether to enable random backoff.") private String randomBackOff; public OptimisticLockRetryPolicyDefinition() { diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/PausableDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/PausableDefinition.java index 67aa1f1c36a6..490d3aa20ec7 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/PausableDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/PausableDefinition.java @@ -42,10 +42,12 @@ public class PausableDefinition extends NoOutputDefinition<PausableDefinition> { private Predicate<?> untilCheckBean; @XmlAttribute(required = true) - @Metadata(required = true, javaType = "org.apache.camel.resume.ConsumerListener") + @Metadata(required = true, javaType = "org.apache.camel.resume.ConsumerListener", + description = "The consumer listener to use for pausing and resuming the consumer.") private String consumerListener; @XmlAttribute(required = true) - @Metadata(required = true, javaType = "java.util.function.Predicate") + @Metadata(required = true, javaType = "java.util.function.Predicate", + description = "Predicate to evaluate whether the processing can resume. Returns true if consumption can resume, or false otherwise.") private String untilCheck; public PausableDefinition() { diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/PollDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/PollDefinition.java index 241711312ff4..c0b9c68ffba5 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/PollDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/PollDefinition.java @@ -46,11 +46,12 @@ public class PollDefinition extends NoOutputDefinition<PollDefinition> implement @XmlAttribute private String variableReceive; @XmlAttribute - @Metadata(required = true) + @Metadata(required = true, description = "Sets the uri of the endpoint to poll from.") @DslArg private String uri; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.time.Duration", defaultValue = "20000") + @Metadata(label = "advanced", javaType = "java.time.Duration", defaultValue = "20000", + description = "Timeout in millis when polling from the external service. The default value is 20000 (20 seconds).") @DslArg(position = 1, renderType = "long") private String timeout; diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/RedeliveryPolicyDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/RedeliveryPolicyDefinition.java index eb61a015cea6..766c71e178a8 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/RedeliveryPolicyDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/RedeliveryPolicyDefinition.java @@ -33,77 +33,101 @@ import org.apache.camel.spi.Metadata; public class RedeliveryPolicyDefinition extends IdentifiedType implements Cloneable { @XmlAttribute - @Metadata(javaType = "java.lang.Integer") + @Metadata(javaType = "java.lang.Integer", + description = "Sets the maximum number of redeliveries. Use 0 for no redeliveries, or -1 to redeliver forever.") private String maximumRedeliveries; @XmlAttribute - @Metadata(javaType = "java.time.Duration", defaultValue = "1000") + @Metadata(javaType = "java.time.Duration", defaultValue = "1000", + description = "Sets the initial redelivery delay in milliseconds.") private String redeliveryDelay; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", + description = "Allow asynchronous delayed redelivery. The route, in particular the consumer's component, must support the Asynchronous Routing Engine (e.g. seda).") private String asyncDelayedRedelivery; @XmlAttribute - @Metadata(javaType = "java.lang.Double", defaultValue = "2.0") + @Metadata(javaType = "java.lang.Double", defaultValue = "2.0", + description = "Sets the back off multiplier.") private String backOffMultiplier; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", + description = "Turn on exponential back off.") private String useExponentialBackOff; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Double", defaultValue = "0.15") + @Metadata(label = "advanced", javaType = "java.lang.Double", defaultValue = "0.15", + description = "Sets the collision avoidance factor.") private String collisionAvoidanceFactor; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", + description = "Turn on collision avoidance.") private String useCollisionAvoidance; @XmlAttribute - @Metadata(javaType = "java.time.Duration", defaultValue = "60000") + @Metadata(javaType = "java.time.Duration", defaultValue = "60000", + description = "Sets the maximum delay between redelivery in milliseconds.") private String maximumRedeliveryDelay; @XmlAttribute @Metadata(label = "advanced", javaType = "org.apache.camel.LoggingLevel", defaultValue = "ERROR", - enums = "TRACE,DEBUG,INFO,WARN,ERROR,OFF") + enums = "TRACE,DEBUG,INFO,WARN,ERROR,OFF", + description = "Sets the logging level to use when retries have been exhausted.") private String retriesExhaustedLogLevel; @XmlAttribute - @Metadata(javaType = "org.apache.camel.LoggingLevel", defaultValue = "DEBUG", enums = "TRACE,DEBUG,INFO,WARN,ERROR,OFF") + @Metadata(javaType = "org.apache.camel.LoggingLevel", defaultValue = "DEBUG", enums = "TRACE,DEBUG,INFO,WARN,ERROR,OFF", + description = "Sets the logging level to use for logging retry attempts.") private String retryAttemptedLogLevel; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Integer", defaultValue = "1") + @Metadata(label = "advanced", javaType = "java.lang.Integer", defaultValue = "1", + description = "Sets the interval for logging retry attempts.") private String retryAttemptedLogInterval; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true", + description = "Whether retry attempts should be logged or not. Can be used to include or reduce verbose.") private String logRetryAttempted; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true", + description = "Whether stack traces should be logged. Can be used to include or reduce verbose.") private String logStackTrace; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", + description = "Whether stack traces should be logged when a retry attempt failed. Can be used to include or reduce verbose.") private String logRetryStackTrace; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", + description = "Whether handled exceptions should be logged or not. Can be used to include or reduce verbose.") private String logHandled; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true", + description = "Whether new exceptions should be logged or not. A new exception is an exception that was thrown while handling a previous exception.") private String logNewException; @XmlAttribute - @Metadata(javaType = "java.lang.Boolean") + @Metadata(javaType = "java.lang.Boolean", + description = "Whether continued exceptions should be logged or not. Can be used to include or reduce verbose.") private String logContinued; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true", + description = "Whether exhausted exceptions should be logged or not. Can be used to include or reduce verbose.") private String logExhausted; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", + description = "Whether exhausted exceptions should be logged including message history. Can be used to include or reduce verbose.") private String logExhaustedMessageHistory; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", + description = "Whether exhausted message body should be logged including message history. Requires logExhaustedMessageHistory to be enabled.") private String logExhaustedMessageBody; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", + description = "Disables redelivery (same as setting maximum redeliveries to 0).") private String disableRedelivery; @XmlAttribute - @Metadata(label = "advanced") + @Metadata(label = "advanced", + description = "Sets the delay pattern with delay intervals.") private String delayPattern; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "true", + description = "Controls whether to allow redelivery while stopping/shutting down a route that uses error handling.") private String allowRedeliveryWhileStopping; @XmlAttribute - @Metadata(label = "advanced") + @Metadata(label = "advanced", + description = "Sets the reference of the instance of org.apache.camel.spi.ExchangeFormatter to generate the log message from exchange.") private String exchangeFormatterRef; @Override diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/RemoveHeadersDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/RemoveHeadersDefinition.java index 32b8ad8f1418..5a7fc0ec630f 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/RemoveHeadersDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/RemoveHeadersDefinition.java @@ -42,7 +42,8 @@ public class RemoveHeadersDefinition extends NoOutputDefinition<RemoveHeadersDef @DslArg private String pattern; @XmlAttribute - @Metadata(label = "advanced") + @Metadata(label = "advanced", + description = "Name or pattern of headers to not remove. You can use comma to separate multiple patterns.") private String excludePattern; public RemoveHeadersDefinition() { diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/RemovePropertiesDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/RemovePropertiesDefinition.java index 911b2b5b241a..9eb947ab80a8 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/RemovePropertiesDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/RemovePropertiesDefinition.java @@ -42,7 +42,8 @@ public class RemovePropertiesDefinition extends NoOutputDefinition<RemovePropert @DslArg private String pattern; @XmlAttribute - @Metadata(label = "advanced") + @Metadata(label = "advanced", + description = "Name or pattern of properties to not remove. You can use comma to separate multiple patterns.") private String excludePattern; public RemovePropertiesDefinition() { diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/ResequenceDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/ResequenceDefinition.java index d556687a404b..9bc233d8c1ae 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/ResequenceDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/ResequenceDefinition.java @@ -54,7 +54,7 @@ public class ResequenceDefinition extends OutputDefinition<ResequenceDefinition> @XmlElement(name = "streamConfig", type = StreamResequencerConfig.class) }) private ResequencerConfig resequencerConfig; @XmlElementRef - @Metadata(required = true) + @Metadata(required = true, description = "Expression to use for re-ordering the messages, such as a header with a sequence number.") private ExpressionDefinition expression; public ResequenceDefinition() { diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/ResumableDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/ResumableDefinition.java index 3b6d9764577b..f663891ad44a 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/ResumableDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/ResumableDefinition.java @@ -42,14 +42,17 @@ public class ResumableDefinition extends NoOutputDefinition<ResumableDefinition> private ResumeStrategyConfiguration resumeStrategyConfiguration; @XmlAttribute(required = true) - @Metadata(required = true, javaType = "org.apache.camel.resume.ResumeStrategy") + @Metadata(required = true, javaType = "org.apache.camel.resume.ResumeStrategy", + description = "The resume strategy to use for resuming processing from the last known offset.") private String resumeStrategy; @XmlAttribute @Metadata(label = "advanced", javaType = "org.apache.camel.LoggingLevel", defaultValue = "ERROR", - enums = "TRACE,DEBUG,INFO,WARN,ERROR,OFF") + enums = "TRACE,DEBUG,INFO,WARN,ERROR,OFF", + description = "The logging level to use in case of failures.") private String loggingLevel; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "false") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "false", + description = "Whether the offsets will be intermittently present or whether they must be present in every exchange.") private String intermittent; public ResumableDefinition() { diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/RouteDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/RouteDefinition.java index b0f1129c53d8..e157e356815d 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/RouteDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/RouteDefinition.java @@ -1000,7 +1000,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> * The group name for this route. Multiple routes can belong to the same group. */ @XmlAttribute - @Metadata(label = "advanced") + @Metadata(label = "advanced", description = "The group name for this route. Multiple routes can belong to the same group.") public void setGroup(String group) { this.group = group; } @@ -1016,7 +1016,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> * Sets a prefix to use for all node ids (not route id). */ @XmlAttribute - @Metadata(label = "advanced") + @Metadata(label = "advanced", description = "Sets a prefix to use for all node ids (not route id).") public void setNodePrefixId(String nodePrefixId) { this.nodePrefixId = nodePrefixId; } @@ -1032,7 +1032,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> * Whether stream caching is enabled on this route. */ @XmlAttribute - @Metadata(javaType = "java.lang.Boolean") + @Metadata(javaType = "java.lang.Boolean", description = "Whether stream caching is enabled on this route.") public void setStreamCache(String streamCache) { this.streamCache = streamCache; } @@ -1048,7 +1048,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> * Whether tracing is enabled on this route. */ @XmlAttribute - @Metadata(javaType = "java.lang.Boolean") + @Metadata(javaType = "java.lang.Boolean", description = "Whether tracing is enabled on this route.") public void setTrace(String trace) { this.trace = trace; } @@ -1064,7 +1064,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> * Whether message history is enabled on this route. */ @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", description = "Whether message history is enabled on this route.") public void setMessageHistory(String messageHistory) { this.messageHistory = messageHistory; } @@ -1080,7 +1080,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> * Whether security mask for Logging is enabled on this route. */ @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", description = "Whether security mask for logging is enabled on this route.") public void setLogMask(String logMask) { this.logMask = logMask; } @@ -1096,7 +1096,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> * Whether to slow down processing messages by a given delay in msec. */ @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Long") + @Metadata(label = "advanced", javaType = "java.lang.Long", description = "Whether to slow down processing messages by a given delay in msec.") public void setDelayer(String delayer) { this.delayer = delayer; } @@ -1112,7 +1112,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> * Whether to auto start this route */ @XmlAttribute - @Metadata(javaType = "java.lang.Boolean", defaultValue = "true") + @Metadata(javaType = "java.lang.Boolean", defaultValue = "true", description = "Whether to auto start this route.") public void setAutoStartup(String autoStartup) { this.autoStartup = autoStartup; } @@ -1131,7 +1131,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> * included or not. */ @XmlAttribute - @Metadata(label = "advanced") + @Metadata(label = "advanced", description = "The predicate of the precondition in simple language to evaluate in order to determine if this route should be included or not.") @Override public void setPrecondition(String precondition) { this.precondition = precondition; @@ -1148,7 +1148,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> * To configure the ordering of the routes being started */ @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Integer") + @Metadata(label = "advanced", javaType = "java.lang.Integer", description = "To configure the ordering of the routes being started.") public void setStartupOrder(Integer startupOrder) { this.startupOrder = startupOrder; } @@ -1234,7 +1234,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> */ @XmlAttribute @Metadata(label = "advanced", javaType = "org.apache.camel.ShutdownRoute", defaultValue = "Default", - enums = "Default,Defer") + enums = "Default,Defer", description = "To control how to shutdown the route.") public void setShutdownRoute(String shutdownRoute) { this.shutdownRoute = shutdownRoute; } @@ -1251,7 +1251,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> */ @XmlAttribute @Metadata(label = "advanced", javaType = "org.apache.camel.ShutdownRunningTask", defaultValue = "CompleteCurrentTaskOnly", - enums = "CompleteCurrentTaskOnly,CompleteAllTasks") + enums = "CompleteCurrentTaskOnly,CompleteAllTasks", description = "To control how to shut down the route.") public void setShutdownRunningTask(String shutdownRunningTask) { this.shutdownRunningTask = shutdownRunningTask; } @@ -1346,7 +1346,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> } @XmlElementRef(required = false) - @Metadata(label = "advanced") + @Metadata(label = "advanced", description = "Declare the expected data type of the input message. If the actual message type is different at runtime, camel looks for a required Transformer and applies if exists.") public void setInputType(InputTypeDefinition inputType) { this.inputType = inputType; } @@ -1356,7 +1356,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> } @XmlElementRef(required = false) - @Metadata(label = "advanced") + @Metadata(label = "advanced", description = "Declare the expected data type of the output message. If the actual message type is different at runtime, camel looks for a required Transformer and applies if exists.") public void setOutputType(OutputTypeDefinition outputType) { this.outputType = outputType; } @@ -1373,7 +1373,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> * To set metadata as properties on the route. */ @XmlElement(name = "routeProperty") - @Metadata(label = "advanced") + @Metadata(label = "advanced", description = "To set metadata as properties on the route.") public void setRouteProperties(List<PropertyDefinition> routeProperties) { this.routeProperties = routeProperties; } diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/SortDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/SortDefinition.java index f0bb48075bcf..798b128704c7 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/SortDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/SortDefinition.java @@ -39,7 +39,8 @@ public class SortDefinition<T> extends ExpressionNode { @XmlTransient private Comparator<? super T> comparatorBean; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.util.Comparator") + @Metadata(label = "advanced", javaType = "java.util.Comparator", + description = "Sets a reference to lookup for the comparator to use for sorting.") private String comparator; public SortDefinition() { diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/TemplatedRouteDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/TemplatedRouteDefinition.java index dbec1987fc6a..14c2faca849d 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/TemplatedRouteDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/TemplatedRouteDefinition.java @@ -55,10 +55,12 @@ public class TemplatedRouteDefinition implements CamelContextAware, ResourceAwar @XmlAttribute private String routeId; @XmlAttribute - @Metadata(label = "advanced") + @Metadata(label = "advanced", + description = "Sets a prefix to use for all node ids (not route id).") private String prefixId; @XmlAttribute - @Metadata(label = "advanced") + @Metadata(label = "advanced", + description = "The group name for the route built from this template. Multiple routes can belong to the same group.") private String group; @XmlElement(name = "parameter") @Metadata(description = "Adds an input parameter of the template to build the route") diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/UnmarshalDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/UnmarshalDefinition.java index c7ba54b7dec1..01842abf4bb0 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/UnmarshalDefinition.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/UnmarshalDefinition.java @@ -136,7 +136,8 @@ public class UnmarshalDefinition extends NoOutputDefinition<UnmarshalDefinition> @XmlAttribute private String variableReceive; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "false") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", defaultValue = "false", + description = "Indicates whether null is allowed as value of a body to unmarshall.") private String allowNullBody; public UnmarshalDefinition() { diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/config/BatchResequencerConfig.java b/core/camel-core-model/src/main/java/org/apache/camel/model/config/BatchResequencerConfig.java index db188eedf0e2..582cf874d1b6 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/config/BatchResequencerConfig.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/config/BatchResequencerConfig.java @@ -32,19 +32,24 @@ import org.apache.camel.spi.Metadata; public class BatchResequencerConfig extends ResequencerConfig { @XmlAttribute - @Metadata(defaultValue = "100", javaType = "java.lang.Integer") + @Metadata(defaultValue = "100", javaType = "java.lang.Integer", + description = "Sets the size of the batch to be re-ordered. The default size is 100.") private String batchSize; @XmlAttribute - @Metadata(defaultValue = "1000", javaType = "java.time.Duration") + @Metadata(defaultValue = "1000", javaType = "java.time.Duration", + description = "Sets the timeout for collecting elements to be re-ordered. The default timeout is 1000 msec.") private String batchTimeout; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", + description = "Whether to allow duplicates.") private String allowDuplicates; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", + description = "Whether to reverse the ordering.") private String reverse; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", + description = "Whether to ignore invalid exchanges.") private String ignoreInvalidExchanges; /** diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/config/StreamResequencerConfig.java b/core/camel-core-model/src/main/java/org/apache/camel/model/config/StreamResequencerConfig.java index b8ac84e35fae..2ef9f21e3c23 100644 --- a/core/camel-core-model/src/main/java/org/apache/camel/model/config/StreamResequencerConfig.java +++ b/core/camel-core-model/src/main/java/org/apache/camel/model/config/StreamResequencerConfig.java @@ -37,22 +37,28 @@ public class StreamResequencerConfig extends ResequencerConfig { private ExpressionResultComparator comparatorBean; @XmlAttribute - @Metadata(defaultValue = "1000", javaType = "java.lang.Integer") + @Metadata(defaultValue = "1000", javaType = "java.lang.Integer", + description = "Sets the capacity of the resequencer inbound queue.") private String capacity; @XmlAttribute - @Metadata(defaultValue = "1000", javaType = "java.time.Duration") + @Metadata(defaultValue = "1000", javaType = "java.time.Duration", + description = "Sets the minimum time (milliseconds) to wait for missing elements (messages).") private String timeout; @XmlAttribute - @Metadata(label = "advanced", defaultValue = "1000", javaType = "java.time.Duration") + @Metadata(label = "advanced", defaultValue = "1000", javaType = "java.time.Duration", + description = "Sets the interval in milliseconds the stream resequencer will at most wait while waiting for the condition of being able to deliver.") private String deliveryAttemptInterval; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", + description = "Whether to ignore invalid exchanges.") private String ignoreInvalidExchanges; @XmlAttribute - @Metadata(label = "advanced", javaType = "java.lang.Boolean") + @Metadata(label = "advanced", javaType = "java.lang.Boolean", + description = "If true, throws an exception when messages older than the last delivered message are processed.") private String rejectOld; @XmlAttribute - @Metadata(label = "advanced", javaType = "org.apache.camel.processor.resequencer.ExpressionResultComparator") + @Metadata(label = "advanced", javaType = "org.apache.camel.processor.resequencer.ExpressionResultComparator", + description = "To use a custom comparator for ordering the sequence of messages.") private String comparator; /**
