This is an automated email from the ASF dual-hosted git repository.
oscerd pushed a commit to branch camel-4.14.x
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/camel-4.14.x by this push:
new 349f197115d6 CAMEL-23509: camel-lucene - align Exchange header
constant values with Camel naming convention
349f197115d6 is described below
commit 349f197115d60e0c180cf9836e08f4aeb5a87872
Author: Andrea Cosentino <[email protected]>
AuthorDate: Thu May 14 18:42:29 2026 +0200
CAMEL-23509: camel-lucene - align Exchange header constant values with
Camel naming convention
Backport of #23208 onto camel-4.14.x for the 4.14.8 release line.
Renames the values of LuceneConstants.HEADER_QUERY and
LuceneConstants.HEADER_RETURN_LUCENE_DOCS to follow the standard
CamelLucene* naming convention. The constant field names are unchanged,
so routes referencing the constants continue to work as-is.
The cascading rename of the auto-generated Endpoint DSL accessors
(qUERY() -> luceneQuery(), returnLuceneDocs() -> luceneReturnLuceneDocs())
is included. The matching 4.14.8 upgrade-guide entry was added to
main via #23234.
---
.../org/apache/camel/catalog/components/lucene.json | 4 ++--
.../META-INF/org/apache/camel/component/lucene/lucene.json | 4 ++--
components/camel-lucene/src/main/docs/lucene-component.adoc | 2 +-
.../org/apache/camel/component/lucene/LuceneConstants.java | 4 ++--
.../builder/endpoint/dsl/LuceneEndpointBuilderFactory.java | 12 ++++++------
5 files changed, 13 insertions(+), 13 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/lucene.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/lucene.json
index 7d904d2ae614..7f6d0c1d8fb3 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/lucene.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/lucene.json
@@ -33,8 +33,8 @@
"config": { "index": 6, "kind": "property", "displayName": "Config",
"group": "advanced", "label": "advanced", "required": false, "type": "object",
"javaType": "org.apache.camel.component.lucene.LuceneConfiguration",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use a shared lucene configuration" }
},
"headers": {
- "QUERY": { "index": 0, "kind": "header", "displayName": "", "group":
"producer", "label": "", "required": false, "javaType": "String", "deprecated":
false, "deprecationNote": "", "autowired": false, "secret": false,
"description": "The Lucene Query to performed on the index. The query may
include wildcards and phrases.", "constantName":
"org.apache.camel.component.lucene.LuceneConstants#HEADER_QUERY" },
- "RETURN_LUCENE_DOCS": { "index": 1, "kind": "header", "displayName": "",
"group": "producer", "label": "", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "Set this header to true to include the actual Lucene
documentation when returning hit information.", "constantName":
"org.apache.camel.component.lucene.LuceneConstants#HEADER_RETURN_LUCENE_DOCS" }
+ "CamelLuceneQuery": { "index": 0, "kind": "header", "displayName": "",
"group": "producer", "label": "", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "The Lucene Query to performed on the index. The query
may include wildcards and phrases.", "constantName":
"org.apache.camel.component.lucene.LuceneConstants#HEADER_QUERY" },
+ "CamelLuceneReturnLuceneDocs": { "index": 1, "kind": "header",
"displayName": "", "group": "producer", "label": "", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Set this header to true to include the
actual Lucene documentation when returning hit information.", "constantName":
"org.apache.camel.component.lucene.LuceneConstants#HEADER_RETURN_LUCENE_DOCS" }
},
"properties": {
"host": { "index": 0, "kind": "path", "displayName": "Host", "group":
"producer", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.lucene.LuceneConfiguration", "configurationField":
"config", "description": "The URL to the lucene server" },
diff --git
a/components/camel-lucene/src/generated/resources/META-INF/org/apache/camel/component/lucene/lucene.json
b/components/camel-lucene/src/generated/resources/META-INF/org/apache/camel/component/lucene/lucene.json
index 7d904d2ae614..7f6d0c1d8fb3 100644
---
a/components/camel-lucene/src/generated/resources/META-INF/org/apache/camel/component/lucene/lucene.json
+++
b/components/camel-lucene/src/generated/resources/META-INF/org/apache/camel/component/lucene/lucene.json
@@ -33,8 +33,8 @@
"config": { "index": 6, "kind": "property", "displayName": "Config",
"group": "advanced", "label": "advanced", "required": false, "type": "object",
"javaType": "org.apache.camel.component.lucene.LuceneConfiguration",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use a shared lucene configuration" }
},
"headers": {
- "QUERY": { "index": 0, "kind": "header", "displayName": "", "group":
"producer", "label": "", "required": false, "javaType": "String", "deprecated":
false, "deprecationNote": "", "autowired": false, "secret": false,
"description": "The Lucene Query to performed on the index. The query may
include wildcards and phrases.", "constantName":
"org.apache.camel.component.lucene.LuceneConstants#HEADER_QUERY" },
- "RETURN_LUCENE_DOCS": { "index": 1, "kind": "header", "displayName": "",
"group": "producer", "label": "", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "Set this header to true to include the actual Lucene
documentation when returning hit information.", "constantName":
"org.apache.camel.component.lucene.LuceneConstants#HEADER_RETURN_LUCENE_DOCS" }
+ "CamelLuceneQuery": { "index": 0, "kind": "header", "displayName": "",
"group": "producer", "label": "", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "The Lucene Query to performed on the index. The query
may include wildcards and phrases.", "constantName":
"org.apache.camel.component.lucene.LuceneConstants#HEADER_QUERY" },
+ "CamelLuceneReturnLuceneDocs": { "index": 1, "kind": "header",
"displayName": "", "group": "producer", "label": "", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "Set this header to true to include the
actual Lucene documentation when returning hit information.", "constantName":
"org.apache.camel.component.lucene.LuceneConstants#HEADER_RETURN_LUCENE_DOCS" }
},
"properties": {
"host": { "index": 0, "kind": "path", "displayName": "Host", "group":
"producer", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.lucene.LuceneConfiguration", "configurationField":
"config", "description": "The URL to the lucene server" },
diff --git a/components/camel-lucene/src/main/docs/lucene-component.adoc
b/components/camel-lucene/src/main/docs/lucene-component.adoc
index 7942d04d7751..2cdcdc20440b 100644
--- a/components/camel-lucene/src/main/docs/lucene-component.adoc
+++ b/components/camel-lucene/src/main/docs/lucene-component.adoc
@@ -79,7 +79,7 @@ the body in incoming exchanges and associating it with a token
*query*: the query producer performs searches on a pre-created index.
The query uses the searchable index to perform score & relevance based
searches. Queries are sent via the incoming exchange contains a header
-property name called 'QUERY'. The value of the header property 'QUERY'
+property name called `CamelLuceneQuery`. The value of the header property
`CamelLuceneQuery`
is a Lucene Query. For more details on how to create Lucene Queries,
check out
https://lucene.apache.org/core/8_4_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package.description[Query
Parser Classic syntax]
diff --git
a/components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneConstants.java
b/components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneConstants.java
index bbbf4167caa5..13361e5d7205 100644
---
a/components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneConstants.java
+++
b/components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneConstants.java
@@ -23,11 +23,11 @@ public final class LuceneConstants {
@Metadata(description = "The Lucene Query to performed on the index. The
query may include\n" +
"wildcards and phrases.",
javaType = "String")
- public static final String HEADER_QUERY = "QUERY";
+ public static final String HEADER_QUERY = "CamelLuceneQuery";
@Metadata(description = "Set this header to true to include the actual
Lucene\n" +
"documentation when returning hit information.",
javaType = "String")
- public static final String HEADER_RETURN_LUCENE_DOCS =
"RETURN_LUCENE_DOCS";
+ public static final String HEADER_RETURN_LUCENE_DOCS =
"CamelLuceneReturnLuceneDocs";
private LuceneConstants() {
}
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/LuceneEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/LuceneEndpointBuilderFactory.java
index 099ed2974540..5e77e27190ac 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/LuceneEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/LuceneEndpointBuilderFactory.java
@@ -312,10 +312,10 @@ public interface LuceneEndpointBuilderFactory {
*
* Group: producer
*
- * @return the name of the header {@code QUERY}.
+ * @return the name of the header {@code LuceneQuery}.
*/
- public String qUERY() {
- return "QUERY";
+ public String luceneQuery() {
+ return "CamelLuceneQuery";
}
/**
* Set this header to true to include the actual Lucene documentation
@@ -325,10 +325,10 @@ public interface LuceneEndpointBuilderFactory {
*
* Group: producer
*
- * @return the name of the header {@code RETURN_LUCENE_DOCS}.
+ * @return the name of the header {@code LuceneReturnLuceneDocs}.
*/
- public String returnLuceneDocs() {
- return "RETURN_LUCENE_DOCS";
+ public String luceneReturnLuceneDocs() {
+ return "CamelLuceneReturnLuceneDocs";
}
}
static LuceneEndpointBuilder endpointBuilder(String componentName, String
path) {
