Package org.springframework.kafka.listener.adapter

Interface RecordFilterStrategy<K,V>

Type Parameters:
K - the key type.
V - the value type.
public interface RecordFilterStrategy<K,V>
Implementations of this interface can signal that a record about to be delivered to a message listener should be discarded instead of being delivered.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    filter(org.apache.kafka.clients.consumer.ConsumerRecord<K,V> consumerRecord)
    Return true if the record should be discarded.
    default List<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>>
    filterBatch(List<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>> records)
    Filter an entire batch of records; to filter all records, return an empty list, not null.
    default boolean
    ignoreEmptyBatch()
    Determine whether FilteringBatchMessageListenerAdapter should invoke the BatchMessageListener when all ConsumerRecords in a batch have been filtered out resulting in empty list.

  • Method Details

    • filter

      boolean filter(org.apache.kafka.clients.consumer.ConsumerRecord<K,V> consumerRecord)
      Return true if the record should be discarded.
      Parameters:
      consumerRecord - the record.
      Returns:
      true to discard.

    • filterBatch

      default List<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>> filterBatch(List<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>> records)
      Filter an entire batch of records; to filter all records, return an empty list, not null.
      Parameters:
      records - the records.
      Returns:
      the filtered records.
      Since:
      2.8

    • ignoreEmptyBatch

      default boolean ignoreEmptyBatch()
      Determine whether FilteringBatchMessageListenerAdapter should invoke the BatchMessageListener when all ConsumerRecords in a batch have been filtered out resulting in empty list. By default, do invoke the BatchMessageListener (return false).
      Returns:
      true for FilteringBatchMessageListenerAdapter to not invoke BatchMessageListener when all ConsumerRecord in a batch filtered out
      Since:
      3.3