Skip to content

CAMEL-23509: camel-lucene - align Exchange header constant values with Camel naming convention #23208

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 14, 2026
Merged

CAMEL-23509: camel-lucene - align Exchange header constant values with Camel naming convention #23208

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 ...log/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/lucene.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" },
Expand Down
4 changes: 2 additions & 2 deletions ...mel-lucene/src/generated/resources/META-INF/org/apache/camel/component/lucene/lucene.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" },
Expand Down
2 changes: 1 addition & 1 deletion components/camel-lucene/src/main/docs/lucene-component.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,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]

Expand Down
4 changes: 2 additions & 2 deletions components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
}
Expand Down
17 changes: 17 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 @@ -329,6 +329,23 @@ Two new endpoint options have been added to control the pull fetch loop:
* `pullBatchSize` (default `10`) — maximum number of messages to fetch per pull request.
* `pullFetchTimeout` (default `1000` ms) — maximum time to wait for a batch on each fetch.

=== camel-lucene

The Exchange header values exposed by `LuceneConstants` have been renamed to follow the standard
Camel naming convention. The field names are unchanged, so routes referencing the constants
(`LuceneConstants.HEADER_QUERY`, `LuceneConstants.HEADER_RETURN_LUCENE_DOCS`) continue to work
without modification. However, routes that set or read these headers using the raw string values
must be updated:

* `QUERY` -> `CamelLuceneQuery`
* `RETURN_LUCENE_DOCS` -> `CamelLuceneReturnLuceneDocs`

As a consequence, the generated Endpoint DSL header accessors on `LuceneHeaderNameBuilder`
have been renamed accordingly:

* `qUERY()` -> `luceneQuery()`
* `returnLuceneDocs()` -> `luceneReturnLuceneDocs()`

=== Deprecation of camel-ironmqThe library used had no stable release since 2007. There is no Java library very active for this protocol.

The component camel-ironmq is deprecated. The official library used has been unmaintained since 2017
Expand Down
12 changes: 6 additions & 6 deletions ...rc/generated/java/org/apache/camel/builder/endpoint/dsl/LuceneEndpointBuilderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,10 +312,10 @@ public static class LuceneHeaderNameBuilder {
*
* 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
Expand All @@ -325,10 +325,10 @@ public String qUERY() {
*
* 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) {
Expand Down