Package org.springframework.boot.autoconfigure.kafka

Interface KafkaConnectionDetails

All Superinterfaces:
ConnectionDetails
public interface KafkaConnectionDetails extends ConnectionDetails
Details required to establish a connection to a Kafka service.
Since:
3.1.0
Author:
Moritz Halbritter, Andy Wilkinson, Phillip Webb

  • Method Details

    • getBootstrapServers

      List<String> getBootstrapServers()
      Returns the list of bootstrap servers.
      Returns:
      the list of bootstrap servers

    • getSslBundle

      default SslBundle getSslBundle()
      Returns the SSL bundle.
      Returns:
      the SSL bundle
      Since:
      3.5.0

    • getSecurityProtocol

      default String getSecurityProtocol()
      Returns the security protocol.
      Returns:
      the security protocol
      Since:
      3.5.0

    • getConsumer

      default KafkaConnectionDetails.Configuration getConsumer()
      Returns the consumer configuration.
      Returns:
      the consumer configuration
      Since:
      3.5.0

    • getProducer

      default KafkaConnectionDetails.Configuration getProducer()
      Returns the producer configuration.
      Returns:
      the producer configuration
      Since:
      3.5.0

    • getAdmin

      default KafkaConnectionDetails.Configuration getAdmin()
      Returns the admin configuration.
      Returns:
      the admin configuration
      Since:
      3.5.0

    • getStreams

      default KafkaConnectionDetails.Configuration getStreams()
      Returns the Kafka Streams configuration.
      Returns:
      the Kafka Streams configuration
      Since:
      3.5.0

    • getConsumerBootstrapServers

      @Deprecated(since="3.5.0", forRemoval=true) default List<String> getConsumerBootstrapServers()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 3.5.0 for removal in 3.7.0 in favor of getConsumer()
      Returns the list of bootstrap servers used for consumers.
      Returns:
      the list of bootstrap servers used for consumers

    • getProducerBootstrapServers

      @Deprecated(since="3.5.0", forRemoval=true) default List<String> getProducerBootstrapServers()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 3.5.0 for removal in 3.7.0 in favor of getProducer()
      Returns the list of bootstrap servers used for producers.
      Returns:
      the list of bootstrap servers used for producers

    • getAdminBootstrapServers

      @Deprecated(since="3.5.0", forRemoval=true) default List<String> getAdminBootstrapServers()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 3.5.0 for removal in 3.7.0 in favor of getAdmin()
      Returns the list of bootstrap servers used for the admin.
      Returns:
      the list of bootstrap servers used for the admin

    • getStreamsBootstrapServers

      @Deprecated(since="3.5.0", forRemoval=true) default List<String> getStreamsBootstrapServers()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 3.5.0 for removal in 3.7.0 in favor of getStreams()
      Returns the list of bootstrap servers used for Kafka Streams.
      Returns:
      the list of bootstrap servers used for Kafka Streams