Package io.kroxylicious.proxy.filter

Interface HeartbeatRequestFilter

All Superinterfaces:
Filter
public interface HeartbeatRequestFilter extends Filter
A stateless filter for HeartbeatRequests.

  • Method Summary

    Modifier and Type
    Method
    Description
    CompletionStage<RequestFilterResult>
    onHeartbeatRequest(short apiVersion, org.apache.kafka.common.message.RequestHeaderData header, org.apache.kafka.common.message.HeartbeatRequestData request, FilterContext context)
    Handle the given header and request pair, returning the header and request pair to be passed to the next filter using the RequestFilterResult.
    default boolean
    shouldHandleHeartbeatRequest(short apiVersion)
    Determine if a request message of type HeartbeatRequest should be handled by this filter implementation.

  • Method Details

    • shouldHandleHeartbeatRequest

      default boolean shouldHandleHeartbeatRequest(short apiVersion)
      Determine if a request message of type HeartbeatRequest should be handled by this filter implementation. returns true then onHeartbeatRequest 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

    • onHeartbeatRequest

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