Page History

/**
* Whether this configuration must be excluded from
* {@code BrokerRegistrationRequest.StaticConfigs} (KIP-1326).
*
* <ul>
* <li>{@code DEFAULT} — defer to the broker-side filtering logic (currently
* validator-based: a config is reported if it has a {@link Validator} and
* is not {@code PASSWORD}).</li>
* <li>{@code NEVER} — explicit opt-out. The broker MUST NOT include this config
* under any circumstances, even if it gains a validator in the future.
* Intended for sensitive configs (PASSWORD, SSL/SASL secrets, reflective
* classes, free-form structured strings) as a defense-in-depth marker
* that survives future refactors of the inclusion logic.</li>
* </ul>
*
* There is intentionally no {@code ALWAYS} state: forcing a config without a
* validator into the registration request would defeat the purpose of the
* filter (the controller cannot validate values it has no validator for).
*/
public enum ControllerReportPolicy {
    DEFAULT,
    NEVER
}

/**
 * Define a security-related configuration. The controller report policy is fixed at
 * {@link ControllerReportPolicy#NEVER}, guaranteeing the broker will never include this
 * config in {@code BrokerRegistrationRequest.StaticConfigs} (KIP-1326). Intended for
 * SSL/SASL secrets, PASSWORD-type entries, JAAS configs, and other sensitive material
 * that must never leave the broker.
 *
 * @param name          The name of the config parameter
 * @param type          The type of the config
 * @param defaultValue  The default value to use if this config isn't present
 * @param validator     The validator to use in checking the correctness of the config
 * @param importance    The importance of this config
 * @param documentation The documentation string for the config
 * @return This ConfigDef so you can chain calls
 */
public ConfigDef defineSecurity(String name, Type type, Object defaultValue, Validator validator,
                                Importance importance, String documentation) {
    return define(name, type, defaultValue, validator, importance, documentation,
            ControllerReportPolicy.NEVER);
}