Package net.bugreaper.modules.kafka.interfaces

Interface KafkaConfig

All Known Implementing Classes:
Kafka
public interface KafkaConfig
Interface that defines helper configuration methods for helper operations. Validates that all required methods are implemented.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getConfigSummary()
    Returns and logs (at INFO level) a human-readable summary of all resolved configuration values.
    Kafka
    setAwaitMs(int awaitMs)
    Configures the global await timeout for assertions and operations that use await.
    Kafka
    setConsumerTimeoutMs(int consumerTimeoutMs)
    Sets the consumer timeout.
    Kafka
    setMaxConsumeMessages(int maxMessages)
    Sets the maximum number of latest messages to consume.
    Kafka
    setReverseMessages(boolean reverseMessages)
    Sets the message ordering behavior.
    Kafka
    setUniqueConsumer(boolean unique)
    Enables or disables generating a unique consumer group ID.

  • Method Details

    • setAwaitMs

      Kafka setAwaitMs(int awaitMs)
      Configures the global await timeout for assertions and operations that use await.
      Parameters:
      awaitMs - await timeout in milliseconds
      Returns:
      this instance for method chaining
      Throws:
      IllegalArgumentException - if the provided timeout is invalid or less than 200 milliseconds

    • setMaxConsumeMessages

      Kafka setMaxConsumeMessages(int maxMessages)
      Sets the maximum number of latest messages to consume.
      Parameters:
      maxMessages - maximum number of messages to consume from the latest offset
      Returns:
      this instance for method chaining
      Throws:
      IllegalArgumentException - if maxMessages is less than 1

    • setConsumerTimeoutMs

      Kafka setConsumerTimeoutMs(int consumerTimeoutMs)
      Sets the consumer timeout.
      Parameters:
      consumerTimeoutMs - maximum consumer execution time in milliseconds before interruption
      Returns:
      this instance for method chaining
      Throws:
      IllegalArgumentException - if the value is invalid

    • setUniqueConsumer

      Kafka setUniqueConsumer(boolean unique)
      Enables or disables generating a unique consumer group ID.
      Parameters:
      unique - true to generate a unique consumer group ID, false to use the default group ID
      Returns:
      this instance for method chaining

    • setReverseMessages

      Kafka setReverseMessages(boolean reverseMessages)
      Sets the message ordering behavior.

      Controls whether consumed messages are returned in reverse order (newest messages first).

      Parameters:
      reverseMessages - true to return messages in reverse order, false to keep the original order
      Returns:
      this instance for method chaining

    • getConfigSummary

      String getConfigSummary()
      Returns and logs (at INFO level) a human-readable summary of all resolved configuration values.

      The summary includes values loaded from the YAML configuration file as well as any fields overridden programmatically after construction. Optional fields that were not present in the configuration and resolved via default values may also be included.

      Returns:
      String with summary