org.springframework.integration.kafka.dsl

Class KafkaInboundGatewaySpec<K,V,R,S extends KafkaInboundGatewaySpec<K,V,R,S>>

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<T>

org.springframework.integration.dsl.IntegrationComponentSpec<S,G>

org.springframework.integration.dsl.MessagingGatewaySpec<S,KafkaInboundGateway<K,V,R>>

org.springframework.integration.kafka.dsl.KafkaInboundGatewaySpec<K,V,R,S>

Type Parameters:

K - the key type.

V - the request value type.

R - the reply value type.

S - the target KafkaInboundGatewaySpec implementation type.

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<KafkaInboundGateway<K,V,R>>, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, org.springframework.integration.dsl.ComponentsRegistration

Direct Known Subclasses:

KafkaInboundGatewaySpec.KafkaInboundGatewayListenerContainerSpec

public class KafkaInboundGatewaySpec<K,V,R,S extends KafkaInboundGatewaySpec<K,V,R,S>>
extends org.springframework.integration.dsl.MessagingGatewaySpec<S,KafkaInboundGateway<K,V,R>>
implements org.springframework.integration.dsl.ComponentsRegistration

A MessagingGatewaySpec implementation for the KafkaInboundGateway.

Since:

5.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KafkaInboundGatewaySpec.KafkaInboundGatewayListenerContainerSpec<K,V,R> A ConcurrentMessageListenerContainer configuration KafkaInboundGatewaySpec extension.

Field Summary

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

PARSER, target

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.Object,java.lang.String>	getComponentsToRegister()
S	messageConverter(org.springframework.kafka.support.converter.RecordMessageConverter messageConverter) Set the message converter to use with a record-based consumer.
S	onPartitionsAssignedSeekCallback(java.util.function.BiConsumer<java.util.Map<org.apache.kafka.common.TopicPartition,java.lang.Long>,org.springframework.kafka.listener.ConsumerSeekAware.ConsumerSeekCallback> onPartitionsAssignedCallback) Specify a BiConsumer for seeks management during ConsumerSeekAware.ConsumerSeekCallback#onPartitionsAssigned(Map, ConsumerSeekAware.ConsumerSeekCallback) call from the KafkaMessageListenerContainer.
S	recoveryCallback(org.springframework.retry.RecoveryCallback<? extends java.lang.Object> recoveryCallback) A RecoveryCallback instance for retry operation; if null, the exception will be thrown to the container after retries are exhausted.
S	retryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate) Specify a RetryTemplate instance to wrap KafkaInboundGateway.IntegrationRecordMessageListener into RetryingMessageListenerAdapter.

Methods inherited from class org.springframework.integration.dsl.MessagingGatewaySpec

autoStartup, errorChannel, errorChannel, errorOnTimeout, id, phase, replyChannel, replyChannel, replyMapper, replyTimeout, requestChannel, requestChannel, requestMapper, requestTimeout, shouldTrack

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, createInstance, destroyInstance, doGet, get, getId, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Method Detail

messageConverter

public S messageConverter(org.springframework.kafka.support.converter.RecordMessageConverter messageConverter)

Set the message converter to use with a record-based consumer.

Parameters:

messageConverter - the converter.

Returns:

the spec

retryTemplate

public S retryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)

Specify a RetryTemplate instance to wrap KafkaInboundGateway.IntegrationRecordMessageListener into RetryingMessageListenerAdapter.

Parameters:

retryTemplate - the RetryTemplate to use.

Returns:

the spec

recoveryCallback

public S recoveryCallback(org.springframework.retry.RecoveryCallback<? extends java.lang.Object> recoveryCallback)

A RecoveryCallback instance for retry operation; if null, the exception will be thrown to the container after retries are exhausted. Does not make sense if retryTemplate(RetryTemplate) isn't specified.

Parameters:

recoveryCallback - the recovery callback.

Returns:

the spec

onPartitionsAssignedSeekCallback

public S onPartitionsAssignedSeekCallback(java.util.function.BiConsumer<java.util.Map<org.apache.kafka.common.TopicPartition,java.lang.Long>,org.springframework.kafka.listener.ConsumerSeekAware.ConsumerSeekCallback> onPartitionsAssignedCallback)

Specify a BiConsumer for seeks management during ConsumerSeekAware.ConsumerSeekCallback#onPartitionsAssigned(Map, ConsumerSeekAware.ConsumerSeekCallback) call from the KafkaMessageListenerContainer.

Parameters:

onPartitionsAssignedCallback - the BiConsumer to use

Returns:

the spec

Since:

3.0.4

getComponentsToRegister

public java.util.Map<java.lang.Object,java.lang.String> getComponentsToRegister()

Specified by:

getComponentsToRegister in interface org.springframework.integration.dsl.ComponentsRegistration