[KAFKA-10412] Deprecate all setters of Headers

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Labels: need-kip
• Assignee: Chia-Ping Tsai
• Reporter: Chia-Ping Tsai
• Created: 18/Aug/20 10:29
• Updated: 18/Aug/20 10:30

Description

Headers is a part of public APIs but the usage of Headers is a bit chaos to users.

1. it has a lot of abstract setters so users have to implement all of them. However, we never call user-defined setters in production.
2. it is not thread-safe so we have to call "setReadOnly" to make data consistency.
3. "setReadOnly" is not a part of public API so users have no idea about the "thread-safe" of Headers

We can't improve Headers right now by reason of deprecation cycles. This KIP plans to deprecate and offer default implementation (java.lang.UnsupportedOperationException) to all setters of Headers so we can cleanup all setters to make it be readonly in next major and users are able to remove all useless implementation from their Headers in this patch.

Issue Links

• links to: KIP-658