...

One missing piece in the AdminClient is the configuration of client quotas. Without this feature, users have to directly talk to Zookeeper in order to manage the quota configurations. This KIP is designed to bring this feature into the AdminClient library.

Public Interfaces

...

The following quota related APIs will be added to the AdminClient from package org.apache.kafka.clients.admin.

/**
 * This is a convenient method for #{@link AdminClient#setQuotas(Map, SetQuotasOptions)} with default options.
 *
 * This operation is not transactional so it may succeed for some quotas while fail for others.
 *
 * This operation is supported by brokers with version 0.11.0.0 or higher.
 *
 * @param quotas            The quotas to use.
 * @return                  The SetQuotaResults.
 */
public SetQuotasResults setQuotas(Map<QuotaTarget, QuotaLimit> quotas) {
    return setQuotas(quotas, new SetQuotasOptions());
}

/**
 * Set quotas for the specified Quota Targets.
 *
 * This operation is not transactional so it may succeed for some quotas while fail for others.
 *
 * This operation is supported by brokers with version 0.11.0.0 or higher.
 *
 * @param quotas            The quotas to use.
 * @param options           The options to use when set the quotas.
 * @return                  The SetQuotaResults.
 */
public abstract SetQuotasResults setQuotas(Map<QuotaTarget, QuotaLimit> quotas, SetQuotasOptions options);

/**

...

 * This is a convenient method for #{@link AdminClient#describeQuota(Map, DescribeQuotasOptions)} with default options.
 * Get the quota settings for the specific Quota Target.
 *
 * @param target           The quota target to use.
 * @return                 The DescribeQuotasResults.
 */
public DescribeQuotasResults describeQuota(QuotaTarget target) {
    return describeQuota(target, new DescribeQuotasOptions());
}

/**
 *

...

 Get the quota

...

 settings for the specific Quota Target.
 *
 * @param target           The quota target to use.
 * @param options          The options to use when describe the quotas.
 * @return

...

                 The DescribeQuotasResults.
 */
public

...

 abstract DescribeQuotasResults describeQuota(QuotaTarget target, DescribeQuotasOptions options);

/**
 * Delete the quota setting for the specified quota target.
 * @param quotaTargets     The quota target to use.
 * @param options          The options to use when delete the quota.
 * @return                 The DeleteQuotasResults
 */
public abstract DeleteQuotasResults deleteQuotas(Collection<QuotaTarget> quotaTargets, DeleteQuotasOptions options);

/**
 * Delete the quota setting for the specified quota target.
 * @param quotaTargets     The quota target to use.
 * @return                 The DeleteQuotasResults
 */
public DeleteQuotasResults deleteQuotas(Collection<QuotaTarget> quotaTargets) {
    return deleteQuotas(quotaTargets, new DeleteQuotasOptions());
}

2. The AdminClient API changes

Proposed Changes

There are two changes needed for this KIP: client side changes and server side changes:

...