Andrea Cosentino created CAMEL-23589:
----------------------------------------

             Summary: camel-solr - align Solr field/param header prefixes with 
Camel naming convention
                 Key: CAMEL-23589
                 URL: https://issues.apache.org/jira/browse/CAMEL-23589
             Project: Camel
          Issue Type: Improvement
          Components: camel-solr
            Reporter: Andrea Cosentino
            Assignee: Andrea Cosentino
             Fix For: 4.21.0


{{SolrConstants}} defines two prefix-based header conventions that 
{{SolrProducer}} / {{SolrRequestConverter}} iterate-and-trust:

* {{HEADER_FIELD_PREFIX = "SolrField."}} - populates Solr document fields from 
any header named {{SolrField.<name>}}
* {{HEADER_PARAM_PREFIX = "SolrParam."}} - populates Solr query params from any 
header named {{SolrParam.<name>}}

Both prefixes cross transport boundaries because they are not in the {{Camel*}} 
namespace. Either move the prefixes under {{CamelSolrField.}} / 
{{CamelSolrParam.}} (constant value rename) or add a 
{{SolrHeaderFilterStrategy}} that filters them on inbound (CAMEL-23532 shape).

h3. Fix shape

Rename the *string value* of each producer-read header constant to 
{{Camel<Component><Name>}}; keep the Java field name unchanged so routes that 
reference the constants symbolically continue to compile and run. Update tests 
that use the literal string values; regenerate component catalog JSON and docs; 
add an upgrade-guide entry in {{camel-4x-upgrade-guide-4_21.adoc}} (and 
matching 4_18 / 4_14 for backports where the component existed in those 
branches).

h3. References

* Tracker: CAMEL-23577
* Precedent (rename pattern): CAMEL-23526 (camel-cxf)
* Alternative pattern (HeaderFilterStrategy approach): CAMEL-23532 
(camel-vertx-websocket / camel-atmosphere-websocket / camel-iggy)




--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to