org.springframework.boot.autoconfigure.kafka

Class KafkaProperties

java.lang.Object

org.springframework.boot.autoconfigure.kafka.KafkaProperties

@ConfigurationProperties(prefix="spring.kafka")
public class KafkaProperties
extends Object

Configuration properties for Spring for Apache Kafka.

Users should refer to Kafka documentation for complete descriptions of these properties.

Since:

1.5.0

Author:

Gary Russell, Stephane Nicoll, Artem Bilan, Nakul Mishra

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KafkaProperties.Admin
static class	KafkaProperties.Consumer
static class	KafkaProperties.Jaas
static class	KafkaProperties.Listener
static class	KafkaProperties.Producer
static class	KafkaProperties.Ssl
static class	KafkaProperties.Template

Constructor Summary

Constructors

Constructor and Description
KafkaProperties()

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	buildAdminProperties() Create an initial map of admin properties from the state of this instance.
Map<String,Object>	buildConsumerProperties() Create an initial map of consumer properties from the state of this instance.
Map<String,Object>	buildProducerProperties() Create an initial map of producer properties from the state of this instance.
KafkaProperties.Admin	getAdmin()
List<String>	getBootstrapServers()
String	getClientId()
KafkaProperties.Consumer	getConsumer()
KafkaProperties.Jaas	getJaas()
KafkaProperties.Listener	getListener()
KafkaProperties.Producer	getProducer()
Map<String,String>	getProperties()
KafkaProperties.Ssl	getSsl()
KafkaProperties.Template	getTemplate()
void	setBootstrapServers(List<String> bootstrapServers)
void	setClientId(String clientId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KafkaProperties

public KafkaProperties()

Method Detail

getBootstrapServers

public List<String> getBootstrapServers()

setBootstrapServers

public void setBootstrapServers(List<String> bootstrapServers)

getClientId

public String getClientId()

setClientId

public void setClientId(String clientId)

getProperties

public Map<String,String> getProperties()

getConsumer

public KafkaProperties.Consumer getConsumer()

getProducer

public KafkaProperties.Producer getProducer()

getListener

public KafkaProperties.Listener getListener()

getAdmin

public KafkaProperties.Admin getAdmin()

getSsl

public KafkaProperties.Ssl getSsl()

getJaas

public KafkaProperties.Jaas getJaas()

getTemplate

public KafkaProperties.Template getTemplate()

buildConsumerProperties

public Map<String,Object> buildConsumerProperties()

Create an initial map of consumer properties from the state of this instance.

This allows you to add additional properties, if necessary, and override the default kafkaConsumerFactory bean.

Returns:

the consumer properties initialized with the customizations defined on this instance

buildProducerProperties

public Map<String,Object> buildProducerProperties()

Create an initial map of producer properties from the state of this instance.

This allows you to add additional properties, if necessary, and override the default kafkaProducerFactory bean.

Returns:

the producer properties initialized with the customizations defined on this instance

buildAdminProperties

public Map<String,Object> buildAdminProperties()

Create an initial map of admin properties from the state of this instance.

This allows you to add additional properties, if necessary, and override the default kafkaAdmin bean.

Returns:

the admin properties initialized with the customizations defined on this instance