Package io.kroxylicious.proxy.filter

Interface FilterResult

All Known Subinterfaces:
RequestFilterResult, ResponseFilterResult
public interface FilterResult
The result of a filter request or response operation that encapsulates the request or response to be forwarded to the next filter in the chain. Optionally it carries orders for actions such as close the connection or drop the message.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    closeConnection()
    signals the filter's wish that the connection will be closed. if the filter provides a message it will be forwarded before the connection is closed.
    boolean
    drop()
    signals the filter's wish that message is dropped i.e. not forwarded to the next filter in the chain.
    org.apache.kafka.common.protocol.ApiMessage
    header()
    the header to be forwarded to the next filter in the chain.
    org.apache.kafka.common.protocol.ApiMessage
    message()
    the message to be forwarded to the next filter in the chain.

  • Method Details

    • header

      @Nullable org.apache.kafka.common.protocol.ApiMessage header()
      the header to be forwarded to the next filter in the chain.
      Returns:
      header.

    • message

      @Nullable org.apache.kafka.common.protocol.ApiMessage message()
      the message to be forwarded to the next filter in the chain.
      Returns:
      header.

    • closeConnection

      boolean closeConnection()
      signals the filter's wish that the connection will be closed. if the filter provides a message it will be forwarded before the connection is closed.
      Returns:
      true if the connection is to be closed.

    • drop

      boolean drop()
      signals the filter's wish that message is dropped i.e. not forwarded to the next filter in the chain.
      Returns:
      true if message is to be dropped.