Package io.kroxylicious.proxy.internal.filter

Class DescribeTopicPartitionsRequestFilterInvoker

java.lang.Object
io.kroxylicious.proxy.internal.filter.DescribeTopicPartitionsRequestFilterInvoker
All Implemented Interfaces:
FilterInvoker
public class DescribeTopicPartitionsRequestFilterInvoker extends Object implements FilterInvoker
An invoker for DescribeTopicPartitionsRequestFilter. The point is that this invoker knows the type of DescribeTopicPartitionsRequestFilter to avoid using instanceof/cast, which has a performance issue in the current LTS java (17).

  • Constructor Summary

    Constructors
    Constructor
    Description
    DescribeTopicPartitionsRequestFilterInvoker(io.kroxylicious.proxy.filter.DescribeTopicPartitionsRequestFilter filter)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    CompletionStage<io.kroxylicious.proxy.filter.RequestFilterResult>
    onRequest(org.apache.kafka.common.protocol.ApiKeys apiKey, short apiVersion, org.apache.kafka.common.message.RequestHeaderData header, org.apache.kafka.common.protocol.ApiMessage body, io.kroxylicious.proxy.filter.FilterContext filterContext)
    Handle deserialized request data.
    boolean
    shouldHandleRequest(org.apache.kafka.common.protocol.ApiKeys apiKey, short apiVersion)
    Should this Invoker handle a request with a given api key and api version.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface io.kroxylicious.proxy.internal.filter.FilterInvoker

    onResponse, shouldHandleResponse

  • Constructor Details

    • DescribeTopicPartitionsRequestFilterInvoker

      public DescribeTopicPartitionsRequestFilterInvoker(io.kroxylicious.proxy.filter.DescribeTopicPartitionsRequestFilter filter)

  • Method Details

    • shouldHandleRequest

      public boolean shouldHandleRequest(org.apache.kafka.common.protocol.ApiKeys apiKey, short apiVersion)
      Description copied from interface: FilterInvoker
      Should this Invoker handle a request with a given api key and api version. Returning true implies that this request will be deserialized and FilterInvoker.onRequest(ApiKeys, short, RequestHeaderData, ApiMessage, FilterContext) is eligible to be called with the deserialized data (if the message flows to that filter).
      Specified by:
      shouldHandleRequest in interface FilterInvoker
      Parameters:
      apiKey - the key of the message
      apiVersion - the version of the message
      Returns:
      true if the message should be deserialized

    • onRequest

      public CompletionStage<io.kroxylicious.proxy.filter.RequestFilterResult> onRequest(org.apache.kafka.common.protocol.ApiKeys apiKey, short apiVersion, org.apache.kafka.common.message.RequestHeaderData header, org.apache.kafka.common.protocol.ApiMessage body, io.kroxylicious.proxy.filter.FilterContext filterContext)
      Description copied from interface: FilterInvoker

      Handle deserialized request data. Implementations must tolerate being called with requests that this FilterInvoker is NOT interested in handling. If any FilterInvoker in the chain should handle a response, then all invokers in the chain are eligible to have their onRequest called. Implementations should forward requests they do not wish to operate on.

      Filters must return a CompletionStage<io.kroxylicious.proxy.filter.RequestFilterResult> object. This object encapsulates the request to be forwarded and, optionally, orders for actions such as closing the connection or dropping the request.

      The FilterContext is the factory for FilterResult objects. See FilterContext.forwardRequest(RequestHeaderData, ApiMessage) and FilterContext.requestFilterResultBuilder() for more details.

      Specified by:
      onRequest in interface FilterInvoker
      Parameters:
      apiKey - the key of the message
      apiVersion - the apiVersion of the message
      header - the header of the message
      body - the body of the message
      filterContext - contains methods to continue the filter chain and other contextual data
      Returns:
      a CompletionStage<io.kroxylicious.proxy.filter.RequestFilterResult>, that when complete, will yield the request to forward.