Package org.apache.kafka.server.quota

Interface ClientQuotaCallback

  • All Superinterfaces:
    Configurable
    public interface ClientQuotaCallback
extends Configurable
    Quota callback interface for brokers that enables customization of client quota computation.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()
      Closes this instance.
      java.lang.Double quotaLimit​(ClientQuotaType quotaType, java.util.Map<java.lang.String,​java.lang.String> metricTags)
      Returns the quota limit associated with the provided metric tags.
      java.util.Map<java.lang.String,​java.lang.String> quotaMetricTags​(ClientQuotaType quotaType, KafkaPrincipal principal, java.lang.String clientId)
      Quota callback invoked to determine the quota metric tags to be applied for a request.
      boolean quotaResetRequired​(ClientQuotaType quotaType)
      Returns true if any of the existing quota configs may have been updated since the last call to this method for the provided quota type.
      void removeQuota​(ClientQuotaType quotaType, ClientQuotaEntity quotaEntity)
      Quota configuration removal callback that is invoked when quota configuration for an entity is removed in ZooKeeper.
      boolean updateClusterMetadata​(Cluster cluster)
      Metadata update callback that is invoked whenever UpdateMetadata request is received from the controller.
      void updateQuota​(ClientQuotaType quotaType, ClientQuotaEntity quotaEntity, double newValue)
      Quota configuration update callback that is invoked when quota configuration for an entity is updated in ZooKeeper.

    • Method Detail

      • quotaMetricTags

        java.util.Map<java.lang.String,​java.lang.String> quotaMetricTags​(ClientQuotaType quotaType,
                                                                       KafkaPrincipal principal,
                                                                       java.lang.String clientId)
        Quota callback invoked to determine the quota metric tags to be applied for a request. Quota limits are associated with quota metrics and all clients which use the same metric tags share the quota limit.
        Parameters:
        quotaType - Type of quota requested
        principal - The user principal of the connection for which quota is requested
        clientId - The client id associated with the request
        Returns:
        quota metric tags that indicate which other clients share this quota

      • quotaLimit

        java.lang.Double quotaLimit​(ClientQuotaType quotaType,
                            java.util.Map<java.lang.String,​java.lang.String> metricTags)
        Returns the quota limit associated with the provided metric tags. These tags were returned from a previous call to quotaMetricTags(ClientQuotaType, KafkaPrincipal, String). This method is invoked by quota managers to obtain the current quota limit applied to a metric when the first request using these tags is processed. It is also invoked after a quota update or cluster metadata change. If the tags are no longer in use after the update, (e.g. this is a {user, client-id} quota metric and the quota now in use is a {user} quota), null is returned.
        Parameters:
        quotaType - Type of quota requested
        metricTags - Metric tags for a quota metric of type `quotaType`
        Returns:
        the quota limit for the provided metric tags or null if the metric tags are no longer in use

      • updateQuota

        void updateQuota​(ClientQuotaType quotaType,
                 ClientQuotaEntity quotaEntity,
                 double newValue)
        Quota configuration update callback that is invoked when quota configuration for an entity is updated in ZooKeeper. This is useful to track configured quotas if built-in quota configuration tools are used for quota management.
        Parameters:
        quotaType - Type of quota being updated
        quotaEntity - The quota entity for which quota is being updated
        newValue - The new quota value

      • removeQuota

        void removeQuota​(ClientQuotaType quotaType,
                 ClientQuotaEntity quotaEntity)
        Quota configuration removal callback that is invoked when quota configuration for an entity is removed in ZooKeeper. This is useful to track configured quotas if built-in quota configuration tools are used for quota management.
        Parameters:
        quotaType - Type of quota being updated
        quotaEntity - The quota entity for which quota is being updated

      • quotaResetRequired

        boolean quotaResetRequired​(ClientQuotaType quotaType)
        Returns true if any of the existing quota configs may have been updated since the last call to this method for the provided quota type. Quota updates as a result of calls to updateClusterMetadata(Cluster), updateQuota(ClientQuotaType, ClientQuotaEntity, double) and removeQuota(ClientQuotaType, ClientQuotaEntity) are automatically processed. So callbacks that rely only on built-in quota configuration tools always return false. Quota callbacks with external quota configuration or custom reconfigurable quota configs that affect quota limits must return true if existing metric configs may need to be updated. This method is invoked on every request and hence is expected to be handled by callbacks as a simple flag that is updated when quotas change.
        Parameters:
        quotaType - Type of quota

      • updateClusterMetadata

        boolean updateClusterMetadata​(Cluster cluster)
        Metadata update callback that is invoked whenever UpdateMetadata request is received from the controller. This is useful if quota computation takes partitions into account. Topics that are being deleted will not be included in `cluster`.
        Parameters:
        cluster - Cluster metadata including partitions and their leaders if known
        Returns:
        true if quotas have changed and metric configs may need to be updated

      • close

        void close()
        Closes this instance.