Skip to content

CAMEL-23585: camel-arangodb - align Exchange header constant names with Camel naming convention #23469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oscerd merged 1 commit into from
May 22, 2026
Merged

CAMEL-23585: camel-arangodb - align Exchange header constant names with Camel naming convention #23469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...g/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/arangodb.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@
"CamelArangoDbMultiUpdate": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": false, "description": "Indicates if there are multiple documents to update. If set to true, the body of the message must be a Collection of documents to update.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_UPDATE" },
"CamelArangoDbMultiInsert": { "index": 1, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": false, "description": "Indicates if there are multiple documents to insert. If set to true, the body of the message must be a Collection of documents to insert.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_INSERT" },
"CamelArangoDbMultiDelete": { "index": 2, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": false, "description": "Indicates if there are multiple documents to delete. If set to true, the body of the message must be a Collection of key of documents to delete.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_DELETE" },
"key": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The Arango key to use for the operation.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#ARANGO_KEY" },
"ResultClassType": { "index": 4, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.Class", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": "BaseDocument.class or BaseEdgeDocument.class", "description": "The type of the result of the operation.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#RESULT_CLASS_TYPE" },
"CamelArangoDbKey": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The Arango key to use for the operation.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#ARANGO_KEY" },
"CamelArangoDbResultClassType": { "index": 4, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.Class", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": "BaseDocument.class or BaseEdgeDocument.class", "description": "The type of the result of the operation.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#RESULT_CLASS_TYPE" },
"CamelArangoDbAqlQuery": { "index": 5, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The AQL query to execute.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY" },
"CamelArangoDbAqlParameters": { "index": 6, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.util.Map", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The key\/value pairs defining the variables to bind the query to.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY_BIND_PARAMETERS" },
"CamelArangoDbAqlOptions": { "index": 7, "kind": "header", "displayName": "", "group": "advanced", "label": "advanced", "required": false, "javaType": "com.arangodb.model.AqlQueryOptions", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The additional options that will be passed to the query API.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY_OPTIONS" }
Expand Down
4 changes: 2 additions & 2 deletions ...angodb/src/generated/resources/META-INF/org/apache/camel/component/arangodb/arangodb.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@
"CamelArangoDbMultiUpdate": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": false, "description": "Indicates if there are multiple documents to update. If set to true, the body of the message must be a Collection of documents to update.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_UPDATE" },
"CamelArangoDbMultiInsert": { "index": 1, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": false, "description": "Indicates if there are multiple documents to insert. If set to true, the body of the message must be a Collection of documents to insert.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_INSERT" },
"CamelArangoDbMultiDelete": { "index": 2, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": false, "description": "Indicates if there are multiple documents to delete. If set to true, the body of the message must be a Collection of key of documents to delete.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_DELETE" },
"key": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The Arango key to use for the operation.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#ARANGO_KEY" },
"ResultClassType": { "index": 4, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.Class", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": "BaseDocument.class or BaseEdgeDocument.class", "description": "The type of the result of the operation.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#RESULT_CLASS_TYPE" },
"CamelArangoDbKey": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The Arango key to use for the operation.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#ARANGO_KEY" },
"CamelArangoDbResultClassType": { "index": 4, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.Class", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": "BaseDocument.class or BaseEdgeDocument.class", "description": "The type of the result of the operation.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#RESULT_CLASS_TYPE" },
"CamelArangoDbAqlQuery": { "index": 5, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The AQL query to execute.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY" },
"CamelArangoDbAqlParameters": { "index": 6, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.util.Map", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The key\/value pairs defining the variables to bind the query to.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY_BIND_PARAMETERS" },
"CamelArangoDbAqlOptions": { "index": 7, "kind": "header", "displayName": "", "group": "advanced", "label": "advanced", "required": false, "javaType": "com.arangodb.model.AqlQueryOptions", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The additional options that will be passed to the query API.", "constantName": "org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY_OPTIONS" }
Expand Down
4 changes: 2 additions & 2 deletions ...s/camel-arangodb/src/main/java/org/apache/camel/component/arangodb/ArangoDbConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ public final class ArangoDbConstants {
javaType = "java.lang.Boolean", defaultValue = "false")
public static final String MULTI_DELETE = "CamelArangoDbMultiDelete";
@Metadata(description = "The Arango key to use for the operation.", javaType = "java.lang.String")
public static final String ARANGO_KEY = "key";
public static final String ARANGO_KEY = "CamelArangoDbKey";
@Metadata(description = "The type of the result of the operation.", javaType = "java.lang.Class",
defaultValue = "BaseDocument.class or BaseEdgeDocument.class")
public static final String RESULT_CLASS_TYPE = "ResultClassType";
public static final String RESULT_CLASS_TYPE = "CamelArangoDbResultClassType";
@Metadata(description = "The AQL query to execute.", javaType = "java.lang.String")
public static final String AQL_QUERY = "CamelArangoDbAqlQuery";
@Metadata(description = "The key/value pairs defining the variables to bind the query to.",
Expand Down
29 changes: 29 additions & 0 deletions docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1224,6 +1224,35 @@ The generated Endpoint DSL header accessor names are unchanged (for example
deriving the accessor name; the accessors now return the new `Camel`-prefixed
values.

=== camel-arangodb

Two Exchange header constants in `ArangoDbConstants` that were not in the
`Camel` namespace (and therefore not filtered by the default
`HeaderFilterStrategy`) have been renamed to follow the Camel naming
convention. The Java field names are unchanged; only the header string values
have changed:

[options="header"]
|===
| Constant | Previous value | New value
| `ArangoDbConstants.ARANGO_KEY` | `key` | `CamelArangoDbKey`
| `ArangoDbConstants.RESULT_CLASS_TYPE` | `ResultClassType` | `CamelArangoDbResultClassType`
|===

The remaining constants (`MULTI_UPDATE`, `MULTI_INSERT`, `MULTI_DELETE`,
`AQL_QUERY`, `AQL_QUERY_BIND_PARAMETERS`, `AQL_QUERY_OPTIONS`) were already
`Camel`-prefixed and are unchanged.

Routes that reference the constants symbolically (for example
`setHeader(ArangoDbConstants.ARANGO_KEY, ...)`) continue to work without
changes. Routes that set the header by its literal string value (for example
`setHeader("key", ...)`) must be updated to use the new value
(`setHeader("CamelArangoDbKey", ...)`).

As a consequence, the generated Endpoint DSL header accessors on
`ArangoDbHeaderNameBuilder` have been renamed: `key()` -> `arangoDbKey()` and
`resultClassType()` -> `arangoDbResultClassType()`.

=== Jackson dataformat documentation pages renamed

The Jackson 2.x and Jackson 3.x lines ship the same dataformat names (`jackson`, `jacksonXml`,
Expand Down
12 changes: 6 additions & 6 deletions .../generated/java/org/apache/camel/builder/endpoint/dsl/ArangoDbEndpointBuilderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,10 +457,10 @@ public String arangoDbMultiDelete() {
*
* Group: producer
*
* @return the name of the header {@code key}.
* @return the name of the header {@code ArangoDbKey}.
*/
public String key() {
return "key";
public String arangoDbKey() {
return "CamelArangoDbKey";
}
/**
* The type of the result of the operation.
Expand All @@ -470,10 +470,10 @@ public String key() {
* Default: BaseDocument.class or BaseEdgeDocument.class
* Group: producer
*
* @return the name of the header {@code ResultClassType}.
* @return the name of the header {@code ArangoDbResultClassType}.
*/
public String resultClassType() {
return "ResultClassType";
public String arangoDbResultClassType() {
return "CamelArangoDbResultClassType";
}
/**
* The AQL query to execute.
Expand Down