org.springframework.integration.kafka.inbound

Class KafkaInboundGateway<K,V,R>

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.gateway.MessagingGatewaySupport

org.springframework.integration.kafka.inbound.KafkaInboundGateway<K,V,R>

Type Parameters:

K - the key type.

V - the request value type.

R - the reply value type.

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, OrderlyShutdownCapable, Pausable, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent

public class KafkaInboundGateway<K,V,R>
extends MessagingGatewaySupport
implements Pausable, OrderlyShutdownCapable

Inbound gateway.

Since:

5.4

Author:

Gary Russell, Artem Bilan, Urs Keller

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.gateway.MessagingGatewaySupport

messagingTemplate

Fields inherited from class org.springframework.integration.endpoint.AbstractEndpoint

lifecycleCondition, lifecycleLock

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor and Description
KafkaInboundGateway(org.springframework.kafka.listener.AbstractMessageListenerContainer<K,V> messageListenerContainer, org.springframework.kafka.core.KafkaTemplate<K,R> kafkaTemplate) Construct an instance with the provided container.

Method Summary

Modifier and Type	Method and Description
int	afterShutdown() Called after normal shutdown of schedulers, executors etc, and after the shutdown delay has elapsed, but before any forced shutdown of any remaining active scheduler/executor threads.Can optionally return the number of active messages still in process.
int	beforeShutdown() Called before shutdown begins.
protected void	doStart() Subclasses must implement this method with the start behavior.
protected void	doStop() Subclasses must implement this method with the stop behavior.
String	getComponentType() Subclasses may implement this method to provide component type information.
protected AttributeAccessor	getErrorMessageAttributes(Message<?> message) Populate an AttributeAccessor to be used when building an error message with the errorMessageStrategy.
boolean	isPaused() Check if the endpoint is paused.
protected void	onInit() Subclasses may implement this for initialization logic.
void	pause() Pause the endpoint.
void	resume() Resume the endpoint if paused.
void	setBindSourceRecord(boolean bindSourceRecord) Set to true to bind the source consumer record in the header named IntegrationMessageHeaderAccessor.SOURCE_DATA.
void	setMessageConverter(org.springframework.kafka.support.converter.RecordMessageConverter messageConverter) Set the message converter; must be a RecordMessageConverter or BatchMessageConverter depending on mode.
void	setOnPartitionsAssignedSeekCallback(java.util.function.BiConsumer<Map<org.apache.kafka.common.TopicPartition,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.
void	setPayloadType(Class<?> payloadType) When using a type-aware message converter (such as StringJsonMessageConverter, set the payload type the converter should create.
void	setRecoveryCallback(org.springframework.retry.RecoveryCallback<?> recoveryCallback) A RecoveryCallback instance for retry operation; if null, the exception will be thrown to the container after retries are exhausted (unless an error channel is configured).
void	setRetryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate) Specify a RetryTemplate instance to wrap KafkaInboundGateway.IntegrationRecordMessageListener into RetryingMessageListenerAdapter.

Methods inherited from class org.springframework.integration.gateway.MessagingGatewaySupport

buildErrorMessage, buildSendTimer, destroy, getErrorChannel, getIntegrationPatternType, getManagedName, getManagedType, getOverrides, getReplyChannel, getRequestChannel, isLoggingEnabled, receive, receive, receiveMessage, receiveMessage, registerMetricsCaptor, registerReplyMessageCorrelatorIfNecessary, send, sendAndReceive, sendAndReceiveMessage, sendAndReceiveMessageReactive, sendTimer, setErrorChannel, setErrorChannelName, setErrorMessageStrategy, setErrorOnTimeout, setLoggingEnabled, setManagedName, setManagedType, setReplyChannel, setReplyChannelName, setReplyMapper, setReplyTimeout, setRequestChannel, setRequestChannelName, setRequestMapper, setRequestTimeout, setShouldTrack

Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint

doStop, getPhase, getRole, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.support.management.ManageableLifecycle

isRunning, start, stop

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getThisAs

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Constructor Detail

KafkaInboundGateway

public KafkaInboundGateway(org.springframework.kafka.listener.AbstractMessageListenerContainer<K,V> messageListenerContainer,
                           org.springframework.kafka.core.KafkaTemplate<K,R> kafkaTemplate)

Construct an instance with the provided container.

Parameters:

messageListenerContainer - the container.

kafkaTemplate - the kafka template.

Method Detail

setMessageConverter

public void setMessageConverter(org.springframework.kafka.support.converter.RecordMessageConverter messageConverter)

Set the message converter; must be a RecordMessageConverter or BatchMessageConverter depending on mode.

Parameters:

messageConverter - the converter.

setPayloadType

public void setPayloadType(Class<?> payloadType)

When using a type-aware message converter (such as StringJsonMessageConverter, set the payload type the converter should create. Defaults to Object.

Parameters:

payloadType - the type.

setRetryTemplate

public void setRetryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)

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

Parameters:

retryTemplate - the RetryTemplate to use.

setRecoveryCallback

public void setRecoveryCallback(org.springframework.retry.RecoveryCallback<?> recoveryCallback)

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

Parameters:

recoveryCallback - the recovery callback.

setOnPartitionsAssignedSeekCallback

public void setOnPartitionsAssignedSeekCallback(java.util.function.BiConsumer<Map<org.apache.kafka.common.TopicPartition,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. This is called from the internal MessagingMessageListenerAdapter implementation.

Parameters:

onPartitionsAssignedCallback - the BiConsumer to use

Since:

3.0.4

See Also:

ConsumerSeekAware.onPartitionsAssigned(java.util.Map<org.apache.kafka.common.TopicPartition, java.lang.Long>, org.springframework.kafka.listener.ConsumerSeekAware.ConsumerSeekCallback)

setBindSourceRecord

public void setBindSourceRecord(boolean bindSourceRecord)

Set to true to bind the source consumer record in the header named IntegrationMessageHeaderAccessor.SOURCE_DATA.

Parameters:

bindSourceRecord - true to bind.

Since:

3.1.4

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class MessagingGatewaySupport

doStart

protected void doStart()

Description copied from class: AbstractEndpoint

Subclasses must implement this method with the start behavior. This method will be invoked while holding the AbstractEndpoint.lifecycleLock.

Overrides:

doStart in class MessagingGatewaySupport

doStop

protected void doStop()

Description copied from class: AbstractEndpoint

Subclasses must implement this method with the stop behavior. This method will be invoked while holding the AbstractEndpoint.lifecycleLock.

Overrides:

doStop in class MessagingGatewaySupport

pause

public void pause()

Description copied from interface: Pausable

Pause the endpoint.

Specified by:

pause in interface Pausable

resume

public void resume()

Description copied from interface: Pausable

Resume the endpoint if paused.

Specified by:

resume in interface Pausable

isPaused

public boolean isPaused()

Description copied from interface: Pausable

Check if the endpoint is paused.

Specified by:

isPaused in interface Pausable

Returns:

true if paused.

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class MessagingGatewaySupport

beforeShutdown

public int beforeShutdown()

Description copied from interface: OrderlyShutdownCapable

Called before shutdown begins. Implementations should stop accepting new messages. Can optionally return the number of active messages in process.

Specified by:

beforeShutdown in interface OrderlyShutdownCapable

Returns:

The number of active messages if available.

afterShutdown

public int afterShutdown()

Description copied from interface: OrderlyShutdownCapable

Called after normal shutdown of schedulers, executors etc, and after the shutdown delay has elapsed, but before any forced shutdown of any remaining active scheduler/executor threads.Can optionally return the number of active messages still in process.

Specified by:

afterShutdown in interface OrderlyShutdownCapable

Returns:

The number of active messages if available.

getErrorMessageAttributes

protected AttributeAccessor getErrorMessageAttributes(Message<?> message)

Description copied from class: MessagingGatewaySupport

Populate an AttributeAccessor to be used when building an error message with the errorMessageStrategy.

Overrides:

getErrorMessageAttributes in class MessagingGatewaySupport

Parameters:

message - the message.

Returns:

the attributes.