You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@kafka.apache.org by Jeremy Custenborder <jc...@gmail.com> on 2021/02/05 21:28:35 UTC

Proposing KIP-713: Validation of Enums in configuration

Hello All,

I am proposing an API addition for handling enums in configuration.
https://cwiki.apache.org/confluence/display/KAFKA/KIP-713%3A+Validation+of+Enums+in+configuration

The Kafka ecosystem utilizes configuration values that map to java
enums. If there is a typo in the configuration an
IllegalArgumentException exception is thrown. This signals to the user
that there is a configuration problem but it doesn't actually help
them fix the problem.

This KIP proposes a few API changes that a developer can use to
validate configuration values that map to enums, and throw helpful
error messages. For example:

Before:

java.lang.IllegalArgumentException: No enum constant
org.apache.kafka.common.security.auth.SecurityProtocol.SASL_PLAINTEXTA

After:

org.apache.kafka.common.config.ConfigException: Invalid value
SASL_PLAINTEXTA for security.protocol. Enum value not found. Valid
values are: PLAINTEXT, SASL_PLAINTEXT, SASL_SSL, SSL

Please share discussions/feedback along this email thread.