This is an automated email from the ASF dual-hosted git repository.
gnodet 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 8c3e6eac38e8 Fix Javadoc typos, copy-paste errors, and outdated
references in camel-api
8c3e6eac38e8 is described below
commit 8c3e6eac38e8ec028f42d093ed4fc6bff90ae8af
Author: Guillaume Nodet <[email protected]>
AuthorDate: Wed May 13 12:15:38 2026 +0200
Fix Javadoc typos, copy-paste errors, and outdated references in camel-api
- Fix copy-paste error in FluentProducerTemplate.withVariable ("exchange
property" -> "variable")
- Fix FluentProducerTemplate referencing ProducerTemplate instead of itself
- Fix "covert" -> "convert" typos in Exchange and CamelContext
- Fix "defunitions" -> "definitions" typo in CamelContext
- Fix "non exists" -> "none exists" in ConsumerTemplate (6 occurrences)
- Fix "his property" -> "this property" in Exchange (2 occurrences)
- Fix garbled phrasing in CamelContext.resolveDataFormat Javadoc
- Fix GcpVaultConfiguration referencing "AWS" instead of "GCP" (+
regenerated metadata)
- Remove outdated fault.body references in ProducerTemplate and
FluentProducerTemplate
- Update DataFormat to remove outdated "OUT message" references
---
.../catalog/main/camel-main-configuration-metadata.json | 2 +-
.../src/main/java/org/apache/camel/CamelContext.java | 6 +++---
.../src/main/java/org/apache/camel/ConsumerTemplate.java | 12 ++++++------
.../camel-api/src/main/java/org/apache/camel/Exchange.java | 8 ++++----
.../main/java/org/apache/camel/FluentProducerTemplate.java | 14 ++++++--------
.../src/main/java/org/apache/camel/ProducerTemplate.java | 4 +---
.../src/main/java/org/apache/camel/spi/DataFormat.java | 12 ++++++------
.../java/org/apache/camel/vault/GcpVaultConfiguration.java | 2 +-
.../META-INF/camel-main-configuration-metadata.json | 2 +-
core/camel-main/src/main/docs/main.adoc | 2 +-
10 files changed, 30 insertions(+), 34 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
index 8cb1b1af58f7..225c7f367946 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
@@ -437,7 +437,7 @@
{ "name": "camel.vault.cyberark.username", "required": false,
"description": "The username for authentication", "sourceType":
"org.apache.camel.vault.CyberArkVaultConfiguration", "type": "string",
"javaType": "java.lang.String", "secret": true, "security": "secret" },
{ "name": "camel.vault.cyberark.verifySsl", "required": false,
"description": "Whether to verify SSL certificates", "sourceType":
"org.apache.camel.vault.CyberArkVaultConfiguration", "type": "boolean",
"javaType": "boolean", "defaultValue": false, "secret": false },
{ "name": "camel.vault.gcp.projectId", "required": false, "description":
"The GCP Project ID", "sourceType":
"org.apache.camel.vault.GcpVaultConfiguration", "type": "string", "javaType":
"java.lang.String", "secret": false },
- { "name": "camel.vault.gcp.refreshEnabled", "required": false,
"description": "Whether to automatically reload Camel upon secrets being
updated in AWS.", "sourceType": "org.apache.camel.vault.GcpVaultConfiguration",
"type": "boolean", "javaType": "boolean", "defaultValue": false, "secret":
false },
+ { "name": "camel.vault.gcp.refreshEnabled", "required": false,
"description": "Whether to automatically reload Camel upon secrets being
updated in GCP.", "sourceType": "org.apache.camel.vault.GcpVaultConfiguration",
"type": "boolean", "javaType": "boolean", "defaultValue": false, "secret":
false },
{ "name": "camel.vault.gcp.refreshPeriod", "required": false,
"description": "The period (millis) between checking Google for updated
secrets.", "sourceType": "org.apache.camel.vault.GcpVaultConfiguration",
"type": "integer", "javaType": "long", "defaultValue": 30000, "secret": false },
{ "name": "camel.vault.gcp.secrets", "required": false, "description":
"Specify the secret names (or pattern) to check for updates. Multiple secrets
can be separated by comma.", "sourceType":
"org.apache.camel.vault.GcpVaultConfiguration", "type": "string", "javaType":
"java.lang.String", "secret": false },
{ "name": "camel.vault.gcp.serviceAccountKey", "required": false,
"description": "The Service Account Key location", "sourceType":
"org.apache.camel.vault.GcpVaultConfiguration", "type": "string", "javaType":
"java.lang.String", "secret": true, "security": "secret" },
diff --git a/core/camel-api/src/main/java/org/apache/camel/CamelContext.java
b/core/camel-api/src/main/java/org/apache/camel/CamelContext.java
index 8f38569407e7..83742bd71373 100644
--- a/core/camel-api/src/main/java/org/apache/camel/CamelContext.java
+++ b/core/camel-api/src/main/java/org/apache/camel/CamelContext.java
@@ -807,7 +807,7 @@ public interface CamelContext extends
CamelContextLifecycle, RuntimeConfiguratio
List<RoutePolicyFactory> getRoutePolicyFactories();
/**
- * Gets a light-weight API for the route model defunitions.
+ * Gets a light-weight API for the route model definitions.
*/
List<NamedRoute> getNamedRouteDefinitions();
@@ -959,7 +959,7 @@ public interface CamelContext extends
CamelContextLifecycle, RuntimeConfiguratio
Object getVariable(String name);
/**
- * To get a variable by name and covert to the given type.
+ * To get a variable by name and convert to the given type.
*
* @param name the variable name. Can be prefixed with repo-id:name to
lookup the variable from a specific
* repository. If no repo-id is provided, then global
repository will be used.
@@ -1105,7 +1105,7 @@ public interface CamelContext extends
CamelContextLifecycle, RuntimeConfiguratio
ConsumerTemplate createConsumerTemplate(int maximumCacheSize);
/**
- * Resolve an existing data format, or creates a new by the given its name
+ * Resolve an existing data format, or creates a new one with the given
name
*
* @param name the data format name or a reference to it in the {@link
Registry}
* @return the resolved data format, or <tt>null</tt> if not found
diff --git
a/core/camel-api/src/main/java/org/apache/camel/ConsumerTemplate.java
b/core/camel-api/src/main/java/org/apache/camel/ConsumerTemplate.java
index 3bfcfd6fe7c5..3d6d4a6ca90f 100644
--- a/core/camel-api/src/main/java/org/apache/camel/ConsumerTemplate.java
+++ b/core/camel-api/src/main/java/org/apache/camel/ConsumerTemplate.java
@@ -131,7 +131,7 @@ public interface ConsumerTemplate extends Service {
Exchange receive(Endpoint endpoint, long timeout);
/**
- * Receives from the endpoint, not waiting for a response if non exists.
+ * Receives from the endpoint, not waiting for a response if none exists.
* <p/>
* <b>Important:</b> See {@link #doneUoW(Exchange)}
*
@@ -142,7 +142,7 @@ public interface ConsumerTemplate extends Service {
Exchange receiveNoWait(String endpointUri);
/**
- * Receives from the endpoint, not waiting for a response if non exists.
+ * Receives from the endpoint, not waiting for a response if none exists.
* <p/>
* <b>Important:</b> See {@link #doneUoW(Exchange)}
*
@@ -191,7 +191,7 @@ public interface ConsumerTemplate extends Service {
Object receiveBody(Endpoint endpoint, long timeout);
/**
- * Receives from the endpoint, not waiting for a response if non exists.
+ * Receives from the endpoint, not waiting for a response if none exists.
*
* @param endpointUri the endpoint to receive from
* @return the returned response body, or <tt>null</tt> if no
response
@@ -200,7 +200,7 @@ public interface ConsumerTemplate extends Service {
Object receiveBodyNoWait(String endpointUri);
/**
- * Receives from the endpoint, not waiting for a response if non exists.
+ * Receives from the endpoint, not waiting for a response if none exists.
*
* @param endpoint the endpoint to receive from
* @return the returned response body, or <tt>null</tt> if no
response
@@ -247,7 +247,7 @@ public interface ConsumerTemplate extends Service {
<T> @Nullable T receiveBody(Endpoint endpoint, long timeout, Class<T>
type);
/**
- * Receives from the endpoint, not waiting for a response if non exists.
+ * Receives from the endpoint, not waiting for a response if none exists.
*
* @param endpointUri the endpoint to receive from
* @param type the expected response type
@@ -256,7 +256,7 @@ public interface ConsumerTemplate extends Service {
<T> @Nullable T receiveBodyNoWait(String endpointUri, Class<T> type);
/**
- * Receives from the endpoint, not waiting for a response if non exists.
+ * Receives from the endpoint, not waiting for a response if none exists.
*
* @param endpoint the endpoint to receive from
* @param type the expected response type
diff --git a/core/camel-api/src/main/java/org/apache/camel/Exchange.java
b/core/camel-api/src/main/java/org/apache/camel/Exchange.java
index 43f47bcc5731..88b81c0064ac 100644
--- a/core/camel-api/src/main/java/org/apache/camel/Exchange.java
+++ b/core/camel-api/src/main/java/org/apache/camel/Exchange.java
@@ -559,7 +559,7 @@ public interface Exchange extends VariableAware {
* Returns the current message as the given type
*
* @param type the given type
- * @return the message as the given type or <tt>null</tt> if not
possible to covert to given type
+ * @return the message as the given type or <tt>null</tt> if not
possible to convert to given type
*/
<T> @Nullable T getMessage(Class<T> type);
@@ -574,7 +574,7 @@ public interface Exchange extends VariableAware {
* Returns the inbound request message as the given type
*
* @param type the given type
- * @return the message as the given type or <tt>null</tt> if not
possible to covert to given type
+ * @return the message as the given type or <tt>null</tt> if not
possible to convert to given type
*/
<T> @Nullable T getIn(Class<T> type);
@@ -613,7 +613,7 @@ public interface Exchange extends VariableAware {
* If you want to test whether an OUT message has been set or not, use the
{@link #hasOut()} method.
*
* @param type the given type
- * @return the message as the given type or <tt>null</tt> if not
possible to covert to given type
+ * @return the message as the given type or <tt>null</tt> if not
possible to convert to given type
* @see #getIn(Class)
* @deprecated use {@link #getMessage(Class)}
*/
@@ -739,7 +739,7 @@ public interface Exchange extends VariableAware {
/**
* Returns the endpoint which originated this message exchange if a
consumer on an endpoint created the message
- * exchange, otherwise his property will be <tt>null</tt>.
+ * exchange, otherwise this property will be <tt>null</tt>.
*
* Note: In case this message exchange has been cloned through another
parent message exchange (which itself has
* been created through the consumer of it's own endpoint), then if
desired one could still retrieve the consumer
diff --git
a/core/camel-api/src/main/java/org/apache/camel/FluentProducerTemplate.java
b/core/camel-api/src/main/java/org/apache/camel/FluentProducerTemplate.java
index f44893115f81..c63e494271f1 100644
--- a/core/camel-api/src/main/java/org/apache/camel/FluentProducerTemplate.java
+++ b/core/camel-api/src/main/java/org/apache/camel/FluentProducerTemplate.java
@@ -76,9 +76,7 @@ import org.jspecify.annotations.Nullable;
* <ul>
* <li>throws {@link org.apache.camel.CamelExecutionException} if processing
failed <i>during</i> routing with the
* caused exception wrapped</li>
- * <li>The <tt>fault.body</tt> if there is a fault message set and its not
<tt>null</tt></li>
- * <li>Either <tt>IN</tt> or <tt>OUT</tt> body according to the message
exchange pattern. If the pattern is Out capable
- * then the <tt>OUT</tt> body is returned, otherwise <tt>IN</tt>.
+ * <li>The <tt>OUT</tt> body if the pattern is Out capable, otherwise
<tt>IN</tt>.
* </ul>
* <br/>
* <p/>
@@ -148,8 +146,8 @@ public interface FluentProducerTemplate extends Service {
void setDefaultEndpointUri(String endpointUri);
/**
- * Sets whether the {@link org.apache.camel.spi.EventNotifier} should be
used by this {@link ProducerTemplate} to
- * send events about the {@link Exchange} being sent.
+ * Sets whether the {@link org.apache.camel.spi.EventNotifier} should be
used by this {@link FluentProducerTemplate}
+ * to send events about the {@link Exchange} being sent.
* <p/>
* By default this is enabled.
*
@@ -158,8 +156,8 @@ public interface FluentProducerTemplate extends Service {
void setEventNotifierEnabled(boolean enabled);
/**
- * Whether the {@link org.apache.camel.spi.EventNotifier} should be used
by this {@link ProducerTemplate} to send
- * events about the {@link Exchange} being sent.
+ * Whether the {@link org.apache.camel.spi.EventNotifier} should be used
by this {@link FluentProducerTemplate} to
+ * send events about the {@link Exchange} being sent.
*
* @return <tt>true</tt> if enabled, <tt>false</tt> otherwise
*/
@@ -226,7 +224,7 @@ public interface FluentProducerTemplate extends Service {
FluentProducerTemplate withVariables(Map<String, Object> variables);
/**
- * Set the exchange property
+ * Set the variable with the given value.
*
* <b>Important:</b> You can either only use either withExchange, or
withProcessor or a combination of
* withBody/withHeaders to construct the message to be sent.
diff --git
a/core/camel-api/src/main/java/org/apache/camel/ProducerTemplate.java
b/core/camel-api/src/main/java/org/apache/camel/ProducerTemplate.java
index ffec2a1c9621..8e1fbb6a8021 100644
--- a/core/camel-api/src/main/java/org/apache/camel/ProducerTemplate.java
+++ b/core/camel-api/src/main/java/org/apache/camel/ProducerTemplate.java
@@ -45,9 +45,7 @@ import org.jspecify.annotations.Nullable;
* <ul>
* <li>throws {@link org.apache.camel.CamelExecutionException} if processing
failed <i>during</i> routing with the
* caused exception wrapped</li>
- * <li>The <tt>fault.body</tt> if there is a fault message set and its not
<tt>null</tt></li>
- * <li>Either <tt>IN</tt> or <tt>OUT</tt> body according to the message
exchange pattern. If the pattern is Out capable
- * then the <tt>OUT</tt> body is returned, otherwise <tt>IN</tt>.
+ * <li>The <tt>OUT</tt> body if the pattern is Out capable, otherwise
<tt>IN</tt>.
* </ul>
* <br/>
* <p/>
diff --git a/core/camel-api/src/main/java/org/apache/camel/spi/DataFormat.java
b/core/camel-api/src/main/java/org/apache/camel/spi/DataFormat.java
index 4b0eedbb2d06..f311e80f6b08 100644
--- a/core/camel-api/src/main/java/org/apache/camel/spi/DataFormat.java
+++ b/core/camel-api/src/main/java/org/apache/camel/spi/DataFormat.java
@@ -44,11 +44,11 @@ public interface DataFormat extends Service {
/**
* Unmarshals the given stream into an object.
* <p/>
- * <b>Notice:</b> The result is set as body on the exchange OUT message.
It is possible to mutate the OUT message
- * provided in the given exchange parameter. For instance adding headers
to the OUT message will be preserved.
+ * <b>Notice:</b> The result is set as body on the exchange message. It is
possible to mutate the message provided
+ * in the given exchange parameter. For instance adding headers to the
message will be preserved.
* <p/>
* It's also legal to return the <b>same</b> passed <tt>exchange</tt> as
is but also a {@link Message} object as
- * well which will be used as the OUT message of <tt>exchange</tt>.
+ * well which will be used as the message of <tt>exchange</tt>.
*
* @param exchange the current exchange
* @param stream the input stream with the object to be unmarshalled
@@ -61,11 +61,11 @@ public interface DataFormat extends Service {
/**
* Unmarshals the given body into an object.
* <p/>
- * <b>Notice:</b> The result is set as body on the exchange OUT message.
It is possible to mutate the OUT message
- * provided in the given exchange parameter. For instance adding headers
to the OUT message will be preserved.
+ * <b>Notice:</b> The result is set as body on the exchange message. It is
possible to mutate the message provided
+ * in the given exchange parameter. For instance adding headers to the
message will be preserved.
* <p/>
* It's also legal to return the <b>same</b> passed <tt>exchange</tt> as
is but also a {@link Message} object as
- * well which will be used as the OUT message of <tt>exchange</tt>.
+ * well which will be used as the message of <tt>exchange</tt>.
* <p/>
* This method can be used when a dataformat is optimized to handle any
kind of message body as-is. For example
* camel-jaxb has been optimized to do this. The regular {@link
#unmarshal(Exchange, InputStream)} method requires
diff --git
a/core/camel-api/src/main/java/org/apache/camel/vault/GcpVaultConfiguration.java
b/core/camel-api/src/main/java/org/apache/camel/vault/GcpVaultConfiguration.java
index 7798a9cdf7c3..e2e389a2465b 100644
---
a/core/camel-api/src/main/java/org/apache/camel/vault/GcpVaultConfiguration.java
+++
b/core/camel-api/src/main/java/org/apache/camel/vault/GcpVaultConfiguration.java
@@ -88,7 +88,7 @@ public class GcpVaultConfiguration extends VaultConfiguration
{
}
/**
- * Whether to automatically reload Camel upon secrets being updated in AWS.
+ * Whether to automatically reload Camel upon secrets being updated in GCP.
*/
public void setRefreshEnabled(boolean refreshEnabled) {
this.refreshEnabled = refreshEnabled;
diff --git
a/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
b/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
index 8cb1b1af58f7..225c7f367946 100644
---
a/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
+++
b/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
@@ -437,7 +437,7 @@
{ "name": "camel.vault.cyberark.username", "required": false,
"description": "The username for authentication", "sourceType":
"org.apache.camel.vault.CyberArkVaultConfiguration", "type": "string",
"javaType": "java.lang.String", "secret": true, "security": "secret" },
{ "name": "camel.vault.cyberark.verifySsl", "required": false,
"description": "Whether to verify SSL certificates", "sourceType":
"org.apache.camel.vault.CyberArkVaultConfiguration", "type": "boolean",
"javaType": "boolean", "defaultValue": false, "secret": false },
{ "name": "camel.vault.gcp.projectId", "required": false, "description":
"The GCP Project ID", "sourceType":
"org.apache.camel.vault.GcpVaultConfiguration", "type": "string", "javaType":
"java.lang.String", "secret": false },
- { "name": "camel.vault.gcp.refreshEnabled", "required": false,
"description": "Whether to automatically reload Camel upon secrets being
updated in AWS.", "sourceType": "org.apache.camel.vault.GcpVaultConfiguration",
"type": "boolean", "javaType": "boolean", "defaultValue": false, "secret":
false },
+ { "name": "camel.vault.gcp.refreshEnabled", "required": false,
"description": "Whether to automatically reload Camel upon secrets being
updated in GCP.", "sourceType": "org.apache.camel.vault.GcpVaultConfiguration",
"type": "boolean", "javaType": "boolean", "defaultValue": false, "secret":
false },
{ "name": "camel.vault.gcp.refreshPeriod", "required": false,
"description": "The period (millis) between checking Google for updated
secrets.", "sourceType": "org.apache.camel.vault.GcpVaultConfiguration",
"type": "integer", "javaType": "long", "defaultValue": 30000, "secret": false },
{ "name": "camel.vault.gcp.secrets", "required": false, "description":
"Specify the secret names (or pattern) to check for updates. Multiple secrets
can be separated by comma.", "sourceType":
"org.apache.camel.vault.GcpVaultConfiguration", "type": "string", "javaType":
"java.lang.String", "secret": false },
{ "name": "camel.vault.gcp.serviceAccountKey", "required": false,
"description": "The Service Account Key location", "sourceType":
"org.apache.camel.vault.GcpVaultConfiguration", "type": "string", "javaType":
"java.lang.String", "secret": true, "security": "secret" },
diff --git a/core/camel-main/src/main/docs/main.adoc
b/core/camel-main/src/main/docs/main.adoc
index aabcf2682df1..ac293f180104 100644
--- a/core/camel-main/src/main/docs/main.adoc
+++ b/core/camel-main/src/main/docs/main.adoc
@@ -456,7 +456,7 @@ The camel.vault.gcp supports 7 options, which are listed
below.
|===
| Name | Description | Default | Type
| *camel.vault.gcp.projectId* | The GCP Project ID | | String
-| *camel.vault.gcp.refreshEnabled* | Whether to automatically reload Camel
upon secrets being updated in AWS. | false | boolean
+| *camel.vault.gcp.refreshEnabled* | Whether to automatically reload Camel
upon secrets being updated in GCP. | false | boolean
| *camel.vault.gcp.refreshPeriod* | The period (millis) between checking
Google for updated secrets. | 30000 | long
| *camel.vault.gcp.secrets* | Specify the secret names (or pattern) to check
for updates. Multiple secrets can be separated by comma. | | String
| *camel.vault.gcp.serviceAccountKey* | The Service Account Key location | |
String
