Franky Georg created CAMEL-15770:
------------------------------------

             Summary: Kafka serialize/deserialize properties are inconsistently 
named
                 Key: CAMEL-15770
                 URL: https://issues.apache.org/jira/browse/CAMEL-15770
             Project: Camel
          Issue Type: Improvement
          Components: camel-kafka, documentation
    Affects Versions: 3.6.0
            Reporter: Franky Georg


There are 3 pairs of serializer/deserialiser properties on the Kafka component.

The inconsistent parts of the names are highlighted

 
||Consumer||Producer||Type||
|*kafka*HeaderDeserializer|*kafka*HeaderSerializer|Bean|
|keyDeserializer|keySerializer*Class*|String FQN|
|*value*Deserializer|serializer*Class*|String FQN|

 

I think it would be worth making these names consistent.
||Current||Proposed||
|kafkaHeaderDeserializer|headerDeserializer|
|kafkaHeaderSerializer|headerSerializer|
|keyDeserializer|keyDeserializer |
|keySerializerClass|keySerializer|
|valueDeserializer|valueDeserializer|
|serializerClass|valueSerializer|

It looks like there was an intent to denote the key- and value- properties as 
expecting a class FQN string by appending 'Class' to the name. I don't see any 
other properties that do this so I think the consistent approach is to leave it 
off.

I've made an assumption that valueDeserializer & serializerClass are a pair, as 
the descriptions don't match. It would be good to take the opportunity to make 
all six descriptions consistent.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to