Package io.kroxylicious.proxy.filter

Interface EnvelopeResponseFilter

All Superinterfaces:
Filter
public interface EnvelopeResponseFilter extends Filter
A stateless filter for EnvelopeResponses.

  • Method Summary

    Modifier and Type
    Method
    Description
    CompletionStage<ResponseFilterResult>
    onEnvelopeResponse(short apiVersion, org.apache.kafka.common.message.ResponseHeaderData header, org.apache.kafka.common.message.EnvelopeResponseData response, FilterContext context)
    Handle the given header and response pair, returning the header and response pair to be passed to the next filter using the ResponseFilterResult.
    default boolean
    shouldHandleEnvelopeResponse(short apiVersion)
    Determine if a response message of type EnvelopeResponse should be handled by this filter implementation.

  • Method Details

    • shouldHandleEnvelopeResponse

      default boolean shouldHandleEnvelopeResponse(short apiVersion)
      Determine if a response message of type EnvelopeResponse should be handled by this filter implementation. returns true then onEnvelopeResponse is eligible to be invoked with deserialized data, if the message reaches this filter in the chain.
      Parameters:
      apiVersion - the apiVersion of the message
      Returns:
      true if it should be handled

    • onEnvelopeResponse

      CompletionStage<ResponseFilterResult> onEnvelopeResponse(short apiVersion, org.apache.kafka.common.message.ResponseHeaderData header, org.apache.kafka.common.message.EnvelopeResponseData response, FilterContext context)
      Handle the given header and response pair, returning the header and response pair to be passed to the next filter using the ResponseFilterResult.
      The implementation may modify the given header and response in-place, or instantiate a new instances.
      Parameters:
      apiVersion - the apiVersion of the response
      header - response header.
      response - The body to handle.
      context - The context.
      Returns:
      a non-null CompletionStage that, when complete, will yield a ResponseFilterResult containing the response to be forwarded.
      See Also: