org.springframework.cloud.stream.binder.kafka

Class KafkaMessageChannelBinder

java.lang.Object

org.springframework.cloud.stream.binder.AbstractBinder<org.springframework.messaging.MessageChannel,C,P>

org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<KafkaProducerProperties>,KafkaTopicProvisioner>

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

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.cloud.stream.binder.Binder<org.springframework.messaging.MessageChannel,org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<KafkaProducerProperties>>, org.springframework.cloud.stream.binder.ExtendedBindingProperties<KafkaConsumerProperties,KafkaProducerProperties>, org.springframework.cloud.stream.binder.ExtendedPropertiesBinder<org.springframework.messaging.MessageChannel,KafkaConsumerProperties,KafkaProducerProperties>, org.springframework.cloud.stream.binder.PollableConsumerBinder<org.springframework.messaging.MessageHandler,org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties>>, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationEventPublisherAware

public class KafkaMessageChannelBinder
extends org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<KafkaProducerProperties>,KafkaTopicProvisioner>
implements org.springframework.cloud.stream.binder.ExtendedPropertiesBinder<org.springframework.messaging.MessageChannel,KafkaConsumerProperties,KafkaProducerProperties>

A Binder that uses Kafka as the underlying middleware.

Author:

Eric Bottard, Marius Bogoevici, Ilayaperumal Gopinathan, David Turanski, Gary Russell, Mark Fisher, Soby Chacko, Henryk Konsek, Doug Saus

Nested Class Summary

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

org.springframework.cloud.stream.binder.AbstractMessageChannelBinder.ErrorInfrastructure, org.springframework.cloud.stream.binder.AbstractMessageChannelBinder.PolledConsumerResources

Field Summary

Fields

Modifier and Type	Field and Description
static String	X_EXCEPTION_MESSAGE
static String	X_EXCEPTION_STACKTRACE
static String	X_ORIGINAL_TOPIC

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

provisioningProvider

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

logger

Constructor Summary

Constructors

Constructor and Description
KafkaMessageChannelBinder(KafkaBinderConfigurationProperties configurationProperties, KafkaTopicProvisioner provisioningProvider)

Method Summary

Modifier and Type	Method and Description
protected org.springframework.integration.core.MessageProducer	createConsumerEndpoint(org.springframework.cloud.stream.provisioning.ConsumerDestination destination, String group, org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties> extendedConsumerProperties)
protected org.springframework.kafka.core.ConsumerFactory<?,?>	createKafkaConsumerFactory(boolean anonymous, String consumerGroup, org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties> consumerProperties)
protected org.springframework.cloud.stream.binder.AbstractMessageChannelBinder.PolledConsumerResources	createPolledConsumerResources(String name, String group, org.springframework.cloud.stream.provisioning.ConsumerDestination destination, org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties> consumerProperties)
protected org.springframework.messaging.MessageHandler	createProducerMessageHandler(org.springframework.cloud.stream.provisioning.ProducerDestination destination, org.springframework.cloud.stream.binder.ExtendedProducerProperties<KafkaProducerProperties> producerProperties, org.springframework.messaging.MessageChannel errorChannel)
protected org.springframework.messaging.MessageHandler	getErrorMessageHandler(org.springframework.cloud.stream.provisioning.ConsumerDestination destination, String group, org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties> properties)
protected org.springframework.integration.support.ErrorMessageStrategy	getErrorMessageStrategy()
KafkaConsumerProperties	getExtendedConsumerProperties(String channelName)
KafkaProducerProperties	getExtendedProducerProperties(String channelName)
protected org.springframework.messaging.MessageHandler	getPolledConsumerErrorMessageHandler(org.springframework.cloud.stream.provisioning.ConsumerDestination destination, String group, org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties> properties)
protected org.springframework.kafka.core.DefaultKafkaProducerFactory<byte[],byte[]>	getProducerFactory(String transactionIdPrefix, org.springframework.cloud.stream.binder.ExtendedProducerProperties<KafkaProducerProperties> producerProperties)
protected void	postProcessPollableSource(org.springframework.cloud.stream.binder.DefaultPollableMessageSource bindingTarget)
void	setExtendedBindingProperties(KafkaExtendedBindingProperties extendedBindingProperties)
void	setProducerListener(org.springframework.kafka.support.ProducerListener<byte[],byte[]> producerListener)

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

afterUnbindConsumer, afterUnbindProducer, bindPollableConsumer, doBindConsumer, doBindProducer, errorsBaseName, errorsBaseName, getApplicationEventPublisher, getDefaultErrorMessageHandler, getErrorBridgeName, getErrorBridgeName, getErrorMessageHandlerName, getErrorRecovererName, getPolledConsumerRecoveryCallback, postProcessOutputChannel, registerErrorInfrastructure, registerErrorInfrastructure, setApplicationEventPublisher

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

afterPropertiesSet, applyPrefix, bindConsumer, bindProducer, buildPartitionRoutingExpression, buildRetryTemplate, constructDLQName, getApplicationContext, getBeanFactory, getEvaluationContext, groupedName, onInit, serializePayloadIfNecessary, setApplicationContext

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

X_EXCEPTION_STACKTRACE

public static final String X_EXCEPTION_STACKTRACE

See Also:

Constant Field Values

X_EXCEPTION_MESSAGE

public static final String X_EXCEPTION_MESSAGE

See Also:

Constant Field Values

X_ORIGINAL_TOPIC

public static final String X_ORIGINAL_TOPIC

See Also:

Constant Field Values

Constructor Detail

KafkaMessageChannelBinder

public KafkaMessageChannelBinder(KafkaBinderConfigurationProperties configurationProperties,
                                 KafkaTopicProvisioner provisioningProvider)

Method Detail

setExtendedBindingProperties

public void setExtendedBindingProperties(KafkaExtendedBindingProperties extendedBindingProperties)

setProducerListener

public void setProducerListener(org.springframework.kafka.support.ProducerListener<byte[],byte[]> producerListener)

getExtendedConsumerProperties

public KafkaConsumerProperties getExtendedConsumerProperties(String channelName)

Specified by:

getExtendedConsumerProperties in interface org.springframework.cloud.stream.binder.ExtendedBindingProperties<KafkaConsumerProperties,KafkaProducerProperties>

getExtendedProducerProperties

public KafkaProducerProperties getExtendedProducerProperties(String channelName)

Specified by:

getExtendedProducerProperties in interface org.springframework.cloud.stream.binder.ExtendedBindingProperties<KafkaConsumerProperties,KafkaProducerProperties>

createProducerMessageHandler

protected org.springframework.messaging.MessageHandler createProducerMessageHandler(org.springframework.cloud.stream.provisioning.ProducerDestination destination,
                                                                                    org.springframework.cloud.stream.binder.ExtendedProducerProperties<KafkaProducerProperties> producerProperties,
                                                                                    org.springframework.messaging.MessageChannel errorChannel)
                                                                             throws Exception

Specified by:

createProducerMessageHandler in class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<KafkaProducerProperties>,KafkaTopicProvisioner>

Throws:

Exception

getProducerFactory

protected org.springframework.kafka.core.DefaultKafkaProducerFactory<byte[],byte[]> getProducerFactory(String transactionIdPrefix,
                                                                                                       org.springframework.cloud.stream.binder.ExtendedProducerProperties<KafkaProducerProperties> producerProperties)

createConsumerEndpoint

protected org.springframework.integration.core.MessageProducer createConsumerEndpoint(org.springframework.cloud.stream.provisioning.ConsumerDestination destination,
                                                                                      String group,
                                                                                      org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties> extendedConsumerProperties)

Specified by:

createConsumerEndpoint in class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<KafkaProducerProperties>,KafkaTopicProvisioner>

createPolledConsumerResources

protected org.springframework.cloud.stream.binder.AbstractMessageChannelBinder.PolledConsumerResources createPolledConsumerResources(String name,
                                                                                                                                     String group,
                                                                                                                                     org.springframework.cloud.stream.provisioning.ConsumerDestination destination,
                                                                                                                                     org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties> consumerProperties)

Overrides:

createPolledConsumerResources in class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<KafkaProducerProperties>,KafkaTopicProvisioner>

postProcessPollableSource

protected void postProcessPollableSource(org.springframework.cloud.stream.binder.DefaultPollableMessageSource bindingTarget)

Overrides:

postProcessPollableSource in class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<KafkaProducerProperties>,KafkaTopicProvisioner>

getErrorMessageStrategy

protected org.springframework.integration.support.ErrorMessageStrategy getErrorMessageStrategy()

Overrides:

getErrorMessageStrategy in class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<KafkaProducerProperties>,KafkaTopicProvisioner>

getErrorMessageHandler

protected org.springframework.messaging.MessageHandler getErrorMessageHandler(org.springframework.cloud.stream.provisioning.ConsumerDestination destination,
                                                                              String group,
                                                                              org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties> properties)

Overrides:

getErrorMessageHandler in class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<KafkaProducerProperties>,KafkaTopicProvisioner>

getPolledConsumerErrorMessageHandler

protected org.springframework.messaging.MessageHandler getPolledConsumerErrorMessageHandler(org.springframework.cloud.stream.provisioning.ConsumerDestination destination,
                                                                                            String group,
                                                                                            org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties> properties)

Overrides:

getPolledConsumerErrorMessageHandler in class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<KafkaProducerProperties>,KafkaTopicProvisioner>

createKafkaConsumerFactory

protected org.springframework.kafka.core.ConsumerFactory<?,?> createKafkaConsumerFactory(boolean anonymous,
                                                                                         String consumerGroup,
                                                                                         org.springframework.cloud.stream.binder.ExtendedConsumerProperties<KafkaConsumerProperties> consumerProperties)