Package io.kroxylicious.proxy.filter

Interface FilterResultBuilder<H extends org.apache.kafka.common.protocol.ApiMessage,R extends FilterResult>

Type Parameters:
H - kafka api message header class
R - filter result
All Superinterfaces:
CloseStage<R>
All Known Subinterfaces:
RequestFilterResultBuilder, ResponseFilterResultBuilder
public interface FilterResultBuilder<H extends org.apache.kafka.common.protocol.ApiMessage,R extends FilterResult> extends CloseStage<R>
Fluent builder for filter results.

  • Method Summary

    Modifier and Type
    Method
    Description
    TerminalStage<R>
    drop()
    Signals the filter's wish that the message is dropped i.e. not forwarded to the next filter in the chain.
    CloseOrTerminalStage<R>
    forward(H header, org.apache.kafka.common.protocol.ApiMessage message)
    A forward of a request or response message to the next filter in the chain.

    Methods inherited from interface io.kroxylicious.proxy.filter.filterresultbuilder.CloseStage

    withCloseConnection

  • Method Details

    • forward

      CloseOrTerminalStage<R> forward(H header, org.apache.kafka.common.protocol.ApiMessage message) throws IllegalArgumentException
      A forward of a request or response message to the next filter in the chain.
      Parameters:
      header - message header. May not be null.
      message - api message. May not be null. for request messages the class must have a name that that ends with RequestData. for response messages the class must have one that ends with ResponseData.
      Returns:
      next stage in the fluent builder API
      Throws:
      IllegalArgumentException - header or message do not meet criteria described above.

    • drop

      TerminalStage<R> drop()
      Signals the filter's wish that the message is dropped i.e. not forwarded to the next filter in the chain.
      Returns:
      last stage in the fluent API.