This is an automated email from the ASF dual-hosted git repository.
oscerd 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 4578a9014a6b CAMEL-23597: camel-solr - align Exchange header prefix
constants with Camel naming convention (#23410)
4578a9014a6b is described below
commit 4578a9014a6b7a914cf16baf2c5bf62a7b163a88
Author: Andrea Cosentino <[email protected]>
AuthorDate: Fri May 22 13:37:11 2026 +0200
CAMEL-23597: camel-solr - align Exchange header prefix constants with Camel
naming convention (#23410)
Rename the two Exchange header prefix constants in SolrConstants from
"SolrField." / "SolrParam." to "CamelSolrField." / "CamelSolrParam.",
completing the CamelSolrXxx alignment started in CAMEL-21697 (4.10) which
missed the two prefix constants. Java field names are unchanged, so routes
referencing the constants symbolically are unaffected; routes setting the
headers by literal value must adopt the new prefix. Updates the camel-solr
integration tests, inline comments, solr-component.adoc, and adds a 4.21
upgrade-guide entry.
---
.../camel-solr/src/main/docs/solr-component.adoc | 8 ++---
.../apache/camel/component/solr/SolrConstants.java | 4 +--
.../apache/camel/component/solr/SolrProducer.java | 4 +--
.../solr/converter/SolrRequestConverter.java | 4 +--
.../solr/integration/SolrInsertAndDeleteTest.java | 38 +++++++++++-----------
.../solr/integration/SolrPingAndSearchTest.java | 2 +-
.../solr/integration/SolrTestSupport.java | 2 +-
.../ROOT/pages/camel-4x-upgrade-guide-4_21.adoc | 31 ++++++++++++++++++
8 files changed, 62 insertions(+), 31 deletions(-)
diff --git a/components/camel-solr/src/main/docs/solr-component.adoc
b/components/camel-solr/src/main/docs/solr-component.adoc
index ddceb1b2b462..0abeaa15da6f 100644
--- a/components/camel-solr/src/main/docs/solr-component.adoc
+++ b/components/camel-solr/src/main/docs/solr-component.adoc
@@ -60,7 +60,7 @@ the following. Some operations also require the message body
to be set.
|=======================================================================
|Operation |Message body |Description
-|`INSERT` | n/a |inserts/updates a document using message headers (solr fields
must be prefixed with "SolrField.")
+|`INSERT` | n/a |inserts/updates a document using message headers (solr fields
must be prefixed with "CamelSolrField.")
|`INSERT` | File |inserts/updates a document or documents using the given File
(using ContentStreamUpdateRequest)
|`INSERT` | SolrInputDocument or Collection<SolrInputDocument>|inserts/updates
a document or documents based on the given (collection of) SolrInputDocument
|`INSERT` | bean or Collection<bean> |inserts/updates a document or documents
based on values in an
http://wiki.apache.org/solr/Solrj#Directly_adding_POJOs_to_Solr[annotated bean]
@@ -101,7 +101,7 @@ from("direct:search")
<setHeader name="CamelSolrOperation">
<constant>INSERT</constant>
</setHeader>
- <setHeader name="SolrField.id">
+ <setHeader name="CamelSolrField.id">
<simple>${body}</simple>
</setHeader>
<to uri="solr://localhost:8983/solr"/>
@@ -127,8 +127,8 @@ delete routes and then call the commit route.
[source,java]
-----------------------------------------------
-template.sendBodyAndHeader("direct:insert", "1234", "SolrParam.commit", true);
-template.sendBodyAndHeader("direct:delete", "1234", "SolrParam.commit", true);
+template.sendBodyAndHeader("direct:insert", "1234", "CamelSolrParam.commit",
true);
+template.sendBodyAndHeader("direct:delete", "1234", "CamelSolrParam.commit",
true);
template.sendBody("direct:search", "id:1234");
-----------------------------------------------
diff --git
a/components/camel-solr/src/main/java/org/apache/camel/component/solr/SolrConstants.java
b/components/camel-solr/src/main/java/org/apache/camel/component/solr/SolrConstants.java
index 46e45631e989..d5bfc3073005 100644
---
a/components/camel-solr/src/main/java/org/apache/camel/component/solr/SolrConstants.java
+++
b/components/camel-solr/src/main/java/org/apache/camel/component/solr/SolrConstants.java
@@ -42,8 +42,8 @@ public interface SolrConstants {
@Metadata(description = "The content type is used to identify the type
when inserting files.", javaType = "String")
String PARAM_CONTENT_TYPE = Exchange.CONTENT_TYPE;
- String HEADER_FIELD_PREFIX = "SolrField.";
- String HEADER_PARAM_PREFIX = "SolrParam.";
+ String HEADER_FIELD_PREFIX = "CamelSolrField.";
+ String HEADER_PARAM_PREFIX = "CamelSolrParam.";
String PROPERTY_ACTION_CONTEXT = "SolrActionContext";
diff --git
a/components/camel-solr/src/main/java/org/apache/camel/component/solr/SolrProducer.java
b/components/camel-solr/src/main/java/org/apache/camel/component/solr/SolrProducer.java
index 8a3af0ab72ea..373012d4f230 100644
---
a/components/camel-solr/src/main/java/org/apache/camel/component/solr/SolrProducer.java
+++
b/components/camel-solr/src/main/java/org/apache/camel/component/solr/SolrProducer.java
@@ -69,7 +69,7 @@ public class SolrProducer extends DefaultAsyncProducer {
? message.getHeader(SolrConstants.PARAM_REQUEST_HANDLER,
String.class)
: configuration.getRequestHandler();
- // Retrieve all SolrParams: SolrParams header and SolrParam.xxx headers
+ // Retrieve all SolrParams: SolrParams header and CamelSolrParam.xxx
headers
ModifiableSolrParams modifiableSolrParams =
getAndGroupedSolrParams(message);
boolean hasSolrParams = modifiableSolrParams.size() > 0;
@@ -130,7 +130,7 @@ public class SolrProducer extends DefaultAsyncProducer {
ModifiableSolrParams modifiableSolrParams = solrParams instanceof
ModifiableSolrParams
? (ModifiableSolrParams) solrParams
: new ModifiableSolrParams(solrParams);
- // add possible headers that start with "SolrParam." prefix
+ // add possible headers that start with "CamelSolrParam." prefix
message.getHeaders().entrySet().stream()
.filter(entry ->
entry.getKey().startsWith(SolrConstants.HEADER_PARAM_PREFIX))
.forEach(entry -> {
diff --git
a/components/camel-solr/src/main/java/org/apache/camel/component/solr/converter/SolrRequestConverter.java
b/components/camel-solr/src/main/java/org/apache/camel/component/solr/converter/SolrRequestConverter.java
index 1c2d3c0a7c65..075f8dc2f103 100644
---
a/components/camel-solr/src/main/java/org/apache/camel/component/solr/converter/SolrRequestConverter.java
+++
b/components/camel-solr/src/main/java/org/apache/camel/component/solr/converter/SolrRequestConverter.java
@@ -226,14 +226,14 @@ public final class SolrRequestConverter {
docs.ifPresent(updateRequest::add);
return updateRequest;
}
- // Map: gather solr fields from body and merge with solr fields from
headers (gathered from SolrField.xxx headers)
+ // Map: gather solr fields from body and merge with solr fields from
headers (gathered from CamelSolrField.xxx headers)
// The header solr fields have priority
Map<String, Object> map = new LinkedHashMap<>(getMapFromBody(body));
map.putAll(getMapFromHeaderSolrFields(exchange));
if (!map.isEmpty()) {
body = map;
}
- // Map: translate to SolrInputDocument (possibly gathered from
SolrField.xxx headers
+ // Map: translate to SolrInputDocument (possibly gathered from
CamelSolrField.xxx headers
Optional<SolrInputDocument> doc =
getOptionalSolrInputDocumentFromMap(body, exchange);
if (doc.isPresent()) {
updateRequest.add(doc.get());
diff --git
a/components/camel-solr/src/test/java/org/apache/camel/component/solr/integration/SolrInsertAndDeleteTest.java
b/components/camel-solr/src/test/java/org/apache/camel/component/solr/integration/SolrInsertAndDeleteTest.java
index 169ac23adb23..e573872593c5 100644
---
a/components/camel-solr/src/test/java/org/apache/camel/component/solr/integration/SolrInsertAndDeleteTest.java
+++
b/components/camel-solr/src/test/java/org/apache/camel/component/solr/integration/SolrInsertAndDeleteTest.java
@@ -192,7 +192,7 @@ public class SolrInsertAndDeleteTest extends
SolrTestSupport {
public void testInsertStreaming() {
// TODO rename method
ExchangeBuilder builder = ExchangeBuilder.anExchange(camelContext())
- .withHeader("SolrField.id", "MA147LL/A");
+ .withHeader("CamelSolrField.id", "MA147LL/A");
executeInsert(builder.build());
QueryResponse response = executeSolrQuery("id:MA147LL/A");
@@ -203,7 +203,7 @@ public class SolrInsertAndDeleteTest extends
SolrTestSupport {
@Test
public void indexSingleDocumentOnlyWithId() {
ExchangeBuilder builder = ExchangeBuilder.anExchange(camelContext())
- .withHeader("SolrField.id", "MA147LL/A");
+ .withHeader("CamelSolrField.id", "MA147LL/A");
executeInsert(builder.build());
// Check things were indexed.
@@ -224,9 +224,9 @@ public class SolrInsertAndDeleteTest extends
SolrTestSupport {
public void setHeadersAsSolrFields() {
ExchangeBuilder builder = ExchangeBuilder.anExchange(camelContext())
.withBody("Body is ignored")
- .withHeader("SolrField.id", "MA147LL/A")
- .withHeader("SolrField.name_s", "Apple 60 GB iPod with Video
Playback Black")
- .withHeader("SolrField.manu_s", "Apple Computer Inc.");
+ .withHeader("CamelSolrField.id", "MA147LL/A")
+ .withHeader("CamelSolrField.name_s", "Apple 60 GB iPod with
Video Playback Black")
+ .withHeader("CamelSolrField.manu_s", "Apple Computer Inc.");
executeInsert(builder.build());
QueryResponse response = executeSolrQuery("id:MA147LL/A");
@@ -243,8 +243,8 @@ public class SolrInsertAndDeleteTest extends
SolrTestSupport {
String[] categories = { "electronics", "apple" };
ExchangeBuilder builder = ExchangeBuilder.anExchange(camelContext())
.withBody("Test body for iPod.")
- .withHeader("SolrField.id", "MA147LL/A")
- .withHeader("SolrField.cat", categories);
+ .withHeader("CamelSolrField.id", "MA147LL/A")
+ .withHeader("CamelSolrField.cat", categories);
executeInsert(builder.build());
// Check things were indexed.
@@ -260,9 +260,9 @@ public class SolrInsertAndDeleteTest extends
SolrTestSupport {
@Test
public void indexDocumentsAndThenCommit() {
ExchangeBuilder builder = ExchangeBuilder.anExchange(camelContext())
- .withHeader("SolrField.id", "MA147LL/A")
- .withHeader("SolrField.name", "Apple 60 GB iPod with Video
Playback Black")
- .withHeader("SolrField.manu", "Apple Computer Inc.");
+ .withHeader("CamelSolrField.id", "MA147LL/A")
+ .withHeader("CamelSolrField.name", "Apple 60 GB iPod with
Video Playback Black")
+ .withHeader("CamelSolrField.manu", "Apple Computer Inc.");
executeInsert(builder.build(), false);
QueryResponse response = executeSolrQuery("*:*");
@@ -280,7 +280,7 @@ public class SolrInsertAndDeleteTest extends
SolrTestSupport {
public void indexWithAutoCommit() {
// new exchange - not autocommit route
ExchangeBuilder builder = ExchangeBuilder.anExchange(camelContext())
- .withHeader("SolrField.content", "NO_AUTO_COMMIT");
+ .withHeader("CamelSolrField.content", "NO_AUTO_COMMIT");
executeInsert(DEFAULT_START_ENDPOINT, builder.build(), false);
// not committed
QueryResponse response = executeSolrQuery("*:*");
@@ -293,7 +293,7 @@ public class SolrInsertAndDeleteTest extends
SolrTestSupport {
// new exchange - autocommit route
builder = ExchangeBuilder.anExchange(camelContext())
- .withHeader("SolrField.content", "AUTO_COMMIT");
+ .withHeader("CamelSolrField.content", "AUTO_COMMIT");
executeInsert(DEFAULT_START_ENDPOINT_AUTO_COMMIT, builder.build(),
false);
// should be committed
response = executeSolrQuery("*:*");
@@ -304,9 +304,9 @@ public class SolrInsertAndDeleteTest extends
SolrTestSupport {
@Test
public void invalidSolrParametersAreIgnored() {
ExchangeBuilder builder = ExchangeBuilder.anExchange(camelContext())
- .withHeader("SolrField.id", "MA147LL/A")
- .withHeader("SolrField.name", "Apple 60 GB iPod with Video
Playback Black")
- .withHeader("SolrParam.invalid-param", "this is ignored");
+ .withHeader("CamelSolrField.id", "MA147LL/A")
+ .withHeader("CamelSolrField.name", "Apple 60 GB iPod with
Video Playback Black")
+ .withHeader("CamelSolrParam.invalid-param", "this is ignored");
executeInsert(builder.build());
QueryResponse response = executeSolrQuery("*:*");
@@ -375,9 +375,9 @@ public class SolrInsertAndDeleteTest extends
SolrTestSupport {
ExchangeBuilder builder = ExchangeBuilder.anExchange(camelContext())
.withBody(new File("src/test/resources/data/books.csv"))
.withHeader(SolrConstants.PARAM_CONTENT_TYPE, "text/csv")
- .withHeader("SolrParam.fieldnames",
"id,cat,name,price,inStock,author_t,series_t,sequence_i,genre_s")
- .withHeader("SolrParam.skip", "cat,sequence_i,genre_s")
- .withHeader("SolrParam.skipLines", 1);
+ .withHeader("CamelSolrParam.fieldnames",
"id,cat,name,price,inStock,author_t,series_t,sequence_i,genre_s")
+ .withHeader("CamelSolrParam.skip", "cat,sequence_i,genre_s")
+ .withHeader("CamelSolrParam.skipLines", 1);
executeInsert(builder.build());
QueryResponse response = executeSolrQuery("*:*");
assertEquals(0, response.getStatus());
@@ -393,7 +393,7 @@ public class SolrInsertAndDeleteTest extends
SolrTestSupport {
ExchangeBuilder builder = ExchangeBuilder.anExchange(camelContext())
.withBody(new File("src/test/resources/data/tutorial.pdf"))
- .withHeader("SolrParam.literal.id", "tutorial.pdf");
+ .withHeader("CamelSolrParam.literal.id", "tutorial.pdf");
executeInsert(builder.build());
QueryResponse response = executeSolrQuery("*:*");
diff --git
a/components/camel-solr/src/test/java/org/apache/camel/component/solr/integration/SolrPingAndSearchTest.java
b/components/camel-solr/src/test/java/org/apache/camel/component/solr/integration/SolrPingAndSearchTest.java
index a718cb44d352..0e119ca7ae98 100644
---
a/components/camel-solr/src/test/java/org/apache/camel/component/solr/integration/SolrPingAndSearchTest.java
+++
b/components/camel-solr/src/test/java/org/apache/camel/component/solr/integration/SolrPingAndSearchTest.java
@@ -133,7 +133,7 @@ class SolrPingAndSearchTest extends SolrTestSupport {
assertFalse(returnedValues.contains("content1"));
assertFalse(returnedValues.contains("content4"));
- // we can also send the 2 filters by using the 'SolrParam.fq' header
and passing an Iterable.
+ // we can also send the 2 filters by using the 'CamelSolrParam.fq'
header and passing an Iterable.
Map<String, Object> solrFilters = Map.of(HEADER_PARAM_PREFIX + "fq",
List.of("-content:content2", "-content:content3"));
sdl = executeSolrQuery("direct:search", "*:*",
solrFilters).getResults();
diff --git
a/components/camel-solr/src/test/java/org/apache/camel/component/solr/integration/SolrTestSupport.java
b/components/camel-solr/src/test/java/org/apache/camel/component/solr/integration/SolrTestSupport.java
index 33bea4a09f4b..787624a452ac 100644
---
a/components/camel-solr/src/test/java/org/apache/camel/component/solr/integration/SolrTestSupport.java
+++
b/components/camel-solr/src/test/java/org/apache/camel/component/solr/integration/SolrTestSupport.java
@@ -148,7 +148,7 @@ public abstract class SolrTestSupport implements
CamelTestSupportHelper, Configu
protected void solrInsertTestEntry(String id) {
Map<String, Object> headers = new HashMap<>();
headers.put(SolrConstants.PARAM_OPERATION,
SolrConstants.OPERATION_INSERT);
- headers.put("SolrField.id", id);
+ headers.put("CamelSolrField.id", id);
template.sendBodyAndHeaders(DEFAULT_START_ENDPOINT, "", headers);
}
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc
b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc
index f04d62c0afaa..25aacb7fc001 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc
@@ -564,6 +564,37 @@ to drive `DnsConstants.DNS_SERVER` (the recursive resolver
target in
`dns:dig`) without such a mapping step is not the intended use of the
component.
+=== camel-solr
+
+The two Exchange header prefix constants in `SolrConstants` have been renamed
to
+follow the Camel naming convention already used by the other constants in the
+same file (which were renamed in 4.10 under CAMEL-21697). The Java field names
+are unchanged; only the prefix string values have changed:
+
+[options="header"]
+|===
+| Constant | Previous value | New value
+| `SolrConstants.HEADER_FIELD_PREFIX` | `SolrField.` | `CamelSolrField.`
+| `SolrConstants.HEADER_PARAM_PREFIX` | `SolrParam.` | `CamelSolrParam.`
+|===
+
+Routes that reference the constants symbolically (for example
+`setHeader(SolrConstants.HEADER_FIELD_PREFIX + "id", ...)`) continue to work
+without changes. Routes that set the headers by their literal string value
+(for example `setHeader("SolrField.id", ...)` or
+`setHeader("SolrParam.commit", ...)`) must be updated to use the new prefix
+(`CamelSolrField.id`, `CamelSolrParam.commit`).
+
+Because the renamed prefixes now begin with `Camel`, they are stripped by the
+standard transport `HeaderFilterStrategy` (`HttpHeaderFilterStrategy`, etc.)
+when crossing a transport boundary, by design — `Camel*` headers are
+framework-internal and are not propagated over the wire. Routes that bridge an
+external transport (HTTP, JMS, ...) into a `solr:` producer and want to drive
+Solr document fields or query parameters from a header supplied by the sender
+must therefore carry the value in a non-`Camel`-prefixed application header and
+map it to the appropriate `CamelSolrField.*` / `CamelSolrParam.*` header in the
+route between the transport `from` and the `solr:` `to`.
+
=== camel-aws2-s3
The `listObjects` operation now uses the `ListObjectsV2` AWS API instead of
the deprecated `ListObjects` API.
