Skip to content

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

Merged
oscerd merged 1 commit into
apache:mainfrom
oscerd:fix/CAMEL-23509
May 14, 2026
Merged

CAMEL-23509: camel-lucene - align Exchange header constant values with Camel naming convention#23208
oscerd merged 1 commit into
apache:mainfrom
oscerd:fix/CAMEL-23509

Conversation

@oscerd
Copy link
Copy Markdown
Contributor

@oscerd oscerd commented May 14, 2026

Summary

Aligns the values of the Exchange header constants exposed by LuceneConstants with the standard Camel CamelLucene* naming convention.

  • LuceneConstants.HEADER_QUERY: QUERY -> CamelLuceneQuery
  • LuceneConstants.HEADER_RETURN_LUCENE_DOCS: RETURN_LUCENE_DOCS -> CamelLuceneReturnLuceneDocs

The field names (HEADER_QUERY, HEADER_RETURN_LUCENE_DOCS) are unchanged, so routes that reference the constants continue to work without modification. Routes that set or read these headers using the raw string values must be updated.

As a consequence of the value rename, the auto-generated Endpoint DSL header accessors on LuceneHeaderNameBuilder are also renamed:

  • qUERY() -> luceneQuery()
  • returnLuceneDocs() -> luceneReturnLuceneDocs()

An entry has been added to the 4.21 upgrade guide.

Changes

  • components/camel-lucene/.../LuceneConstants.java — header value rename
  • components/camel-lucene/src/main/docs/lucene-component.adoc — text reference update
  • Regenerated lucene.json (component metadata + catalog mirror) and LuceneEndpointBuilderFactory.java
  • docs/user-manual/.../camel-4x-upgrade-guide-4_21.adoc — upgrade-guide entry

Test plan

  • mvn verify in components/camel-lucene (6 tests pass)
  • Full reactor mvn clean install -DskipTests from repo root succeeds, all regen artifacts committed

JIRA: https://issues.apache.org/jira/browse/CAMEL-23509

Claude Code on behalf of Andrea Cosentino

…h Camel naming convention

Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
@oscerd oscerd requested review from apupier and davsclaus May 14, 2026 08:37
@github-actions
Copy link
Copy Markdown
Contributor

🌟 Thank you for your contribution to the Apache Camel project! 🌟
🤖 CI automation will test this PR automatically.

🐫 Apache Camel Committers, please review the following items:

  • First-time contributors require MANUAL approval for the GitHub Actions to run
  • You can use the command /component-test (camel-)component-name1 (camel-)component-name2.. to request a test from the test bot although they are normally detected and executed by CI.
  • You can label PRs using skip-tests and test-dependents to fine-tune the checks executed by this PR.
  • Build and test logs are available in the summary page. Only Apache Camel committers have access to the summary.

⚠️ Be careful when sharing logs. Review their contents before sharing them publicly.

@github-actions
Copy link
Copy Markdown
Contributor

🧪 CI tested the following changed modules:

  • catalog/camel-catalog
  • components/camel-lucene
  • docs
  • dsl/camel-endpointdsl
All tested modules (10 modules)
  • Camel :: Catalog :: Camel Catalog
  • Camel :: Endpoint DSL
  • Camel :: JBang :: MCP
  • Camel :: JBang :: Plugin :: Route Parser
  • Camel :: JBang :: Plugin :: TUI
  • Camel :: JBang :: Plugin :: Validate
  • Camel :: Launcher :: Container
  • Camel :: Lucene
  • Camel :: YAML DSL :: Validator
  • Camel :: YAML DSL :: Validator Maven Plugin

⚙️ View full build and test results

@oscerd oscerd merged commit 878ea07 into apache:main May 14, 2026
7 checks passed
@oscerd oscerd deleted the fix/CAMEL-23509 branch May 14, 2026 09:25
oscerd added a commit that referenced this pull request May 14, 2026
…ader constant values with Camel naming convention

Cherry-pick of #23208 onto camel-4.18.x for the 4.18.3 release line.

Rename the values of the Exchange header constants exposed by
LuceneConstants to follow the standard CamelLucene* convention:
HEADER_QUERY: QUERY -> CamelLuceneQuery; HEADER_RETURN_LUCENE_DOCS:
RETURN_LUCENE_DOCS -> CamelLuceneReturnLuceneDocs. Field names are
unchanged so routes referencing the constants symbolically continue to
work. Routes using literal string values must be updated.

The camel-4x-upgrade-guide-4_21.adoc hunk from the source PR was dropped
(file does not exist on camel-4.18.x). The matching 4.18 upgrade guide
entry is added on main via doc-sync PR #23222.

Closes #23220
oscerd added a commit that referenced this pull request May 14, 2026
…h 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants