Package org.sdase.commons.server.kafka

Interface KafkaBundle.FinalBuilder<T extends io.dropwizard.core.Configuration>

All Known Implementing Classes:
KafkaBundle.Builder
Enclosing class:
KafkaBundle<C extends io.dropwizard.core.Configuration>
public static interface KafkaBundle.FinalBuilder<T extends io.dropwizard.core.Configuration>

  • Method Details

    • withoutHealthCheck

      KafkaBundle.FinalBuilder<T> withoutHealthCheck()
      Disables the health check for Kafka. By disabling the health check the service can stay healthy even if the connection to Kafka is disrupted, if Kafka is not essential to the functionality. However, disabling it still registers an external health check to be able to monitor the connection.
      Returns:
      the same builder instance

    • withHealthCheckName

      KafkaBundle.FinalBuilder<T> withHealthCheckName(String name)
      Defines a custom health check name for this kafka bundle. Defining a custom name is only needed and should only be set, if multiple KafkaBundles are used for multiple brokers to create unique names.

      An external health check, created when withoutHealthCheck() is configured, uses "kafkaConnectionExternal" as default and a regular health check uses "kafkaConnection" as default.

      Parameters:
      name - the name of the health check
      Returns:
      the same builder instance

    • build

      KafkaBundle<T> build()