org.springframework.cloud.stream.binder.kafka

Class KafkaMessageChannelBinder

java.lang.Object

org.springframework.cloud.stream.binder.AbstractBinder<org.springframework.messaging.MessageChannel,ExtendedConsumerProperties<KafkaConsumerProperties>,ExtendedProducerProperties<KafkaProducerProperties>>

org.springframework.cloud.stream.binder.kafka.KafkaMessageChannelBinder

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, Binder<org.springframework.messaging.MessageChannel,ExtendedConsumerProperties<KafkaConsumerProperties>,ExtendedProducerProperties<KafkaProducerProperties>>, ExtendedBindingProperties<KafkaConsumerProperties,KafkaProducerProperties>, ExtendedPropertiesBinder<org.springframework.messaging.MessageChannel,KafkaConsumerProperties,KafkaProducerProperties>, org.springframework.context.ApplicationContextAware

public class KafkaMessageChannelBinder
extends AbstractBinder<org.springframework.messaging.MessageChannel,ExtendedConsumerProperties<KafkaConsumerProperties>,ExtendedProducerProperties<KafkaProducerProperties>>
implements ExtendedPropertiesBinder<org.springframework.messaging.MessageChannel,KafkaConsumerProperties,KafkaProducerProperties>, org.springframework.beans.factory.DisposableBean

A Binder that uses Kafka as the underlying middleware.

Author:

Eric Bottard, Marius Bogoevici, Ilayaperumal Gopinathan, David Turanski, Gary Russell, Mark Fisher, Soby Chacko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KafkaMessageChannelBinder.StartOffset

Nested classes/interfaces inherited from class org.springframework.cloud.stream.binder.AbstractBinder

AbstractBinder.JavaClassMimeTypeConversion

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.kafka.common.serialization.ByteArraySerializer	BYTE_ARRAY_SERIALIZER
static ThreadFactory	DAEMON_THREAD_FACTORY

Fields inherited from class org.springframework.cloud.stream.binder.AbstractBinder

embeddedHeadersMessageConverter, evaluationContext, logger, PARTITION_HEADER, partitionSelector

Constructor Summary

Constructors

Constructor and Description
KafkaMessageChannelBinder(KafkaBinderConfigurationProperties configurationProperties)

Method Summary

Modifier and Type	Method and Description
void	destroy()
protected Binding<org.springframework.messaging.MessageChannel>	doBindConsumer(String name, String group, org.springframework.messaging.MessageChannel inputChannel, ExtendedConsumerProperties<KafkaConsumerProperties> properties)
Binding<org.springframework.messaging.MessageChannel>	doBindProducer(String name, org.springframework.messaging.MessageChannel moduleOutputChannel, ExtendedProducerProperties<KafkaProducerProperties> properties)
void	doManualAck(LinkedList<org.springframework.messaging.MessageHeaders> messageHeadersList)
org.springframework.integration.kafka.core.ConnectionFactory	getConnectionFactory()
KafkaConsumerProperties	getExtendedConsumerProperties(String channelName)
KafkaProducerProperties	getExtendedProducerProperties(String channelName)
void	onInit()
void	setExtendedBindingProperties(KafkaExtendedBindingProperties extendedBindingProperties)
void	setMetadataRetryOperations(org.springframework.retry.RetryOperations metadataRetryOperations) Retry configuration for operations such as validating topic creation
void	setProducerListener(org.springframework.integration.kafka.support.ProducerListener producerListener)
static void	validateTopicName(String topicName) Allowed chars are ASCII alphanumerics, '.', '_' and '-'.

Methods inherited from class org.springframework.cloud.stream.binder.AbstractBinder

afterPropertiesSet, applyPrefix, bindConsumer, bindProducer, buildPartitionRoutingExpression, buildRetryTemplateIfRetryEnabled, constructDLQName, deserializePayloadIfNecessary, deserializePayloadIfNecessary, extractMessageValues, getApplicationContext, getBeanFactory, groupedName, serializePayloadIfNecessary, setApplicationContext, setCodec, setIntegrationEvaluationContext, setPartitionSelector

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cloud.stream.binder.Binder

bindConsumer, bindProducer

Field Detail

BYTE_ARRAY_SERIALIZER

public static final org.apache.kafka.common.serialization.ByteArraySerializer BYTE_ARRAY_SERIALIZER

DAEMON_THREAD_FACTORY

public static final ThreadFactory DAEMON_THREAD_FACTORY

Constructor Detail

KafkaMessageChannelBinder

public KafkaMessageChannelBinder(KafkaBinderConfigurationProperties configurationProperties)

Method Detail

getConnectionFactory

public org.springframework.integration.kafka.core.ConnectionFactory getConnectionFactory()

setProducerListener

public void setProducerListener(org.springframework.integration.kafka.support.ProducerListener producerListener)

setMetadataRetryOperations

public void setMetadataRetryOperations(org.springframework.retry.RetryOperations metadataRetryOperations)

Retry configuration for operations such as validating topic creation

Parameters:

metadataRetryOperations - the retry configuration

setExtendedBindingProperties

public void setExtendedBindingProperties(KafkaExtendedBindingProperties extendedBindingProperties)

onInit

public void onInit()
            throws Exception

Overrides:

onInit in class AbstractBinder<org.springframework.messaging.MessageChannel,ExtendedConsumerProperties<KafkaConsumerProperties>,ExtendedProducerProperties<KafkaProducerProperties>>

Throws:

Exception

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

validateTopicName

public static void validateTopicName(String topicName)

Allowed chars are ASCII alphanumerics, '.', '_' and '-'.

getExtendedConsumerProperties

public KafkaConsumerProperties getExtendedConsumerProperties(String channelName)

Specified by:

getExtendedConsumerProperties in interface ExtendedBindingProperties<KafkaConsumerProperties,KafkaProducerProperties>

getExtendedProducerProperties

public KafkaProducerProperties getExtendedProducerProperties(String channelName)

Specified by:

getExtendedProducerProperties in interface ExtendedBindingProperties<KafkaConsumerProperties,KafkaProducerProperties>

doBindConsumer

protected Binding<org.springframework.messaging.MessageChannel> doBindConsumer(String name,
                                                                               String group,
                                                                               org.springframework.messaging.MessageChannel inputChannel,
                                                                               ExtendedConsumerProperties<KafkaConsumerProperties> properties)

Specified by:

doBindConsumer in class AbstractBinder<org.springframework.messaging.MessageChannel,ExtendedConsumerProperties<KafkaConsumerProperties>,ExtendedProducerProperties<KafkaProducerProperties>>

doBindProducer

public Binding<org.springframework.messaging.MessageChannel> doBindProducer(String name,
                                                                            org.springframework.messaging.MessageChannel moduleOutputChannel,
                                                                            ExtendedProducerProperties<KafkaProducerProperties> properties)

Specified by:

doBindProducer in class AbstractBinder<org.springframework.messaging.MessageChannel,ExtendedConsumerProperties<KafkaConsumerProperties>,ExtendedProducerProperties<KafkaProducerProperties>>

doManualAck

public void doManualAck(LinkedList<org.springframework.messaging.MessageHeaders> messageHeadersList)

Overrides:

doManualAck in class AbstractBinder<org.springframework.messaging.MessageChannel,ExtendedConsumerProperties<KafkaConsumerProperties>,ExtendedProducerProperties<KafkaProducerProperties>>