Package org.springframework.integration.kafka.channel

Class PollableKafkaChannel

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.channel.AbstractMessageChannel

org.springframework.integration.kafka.channel.AbstractKafkaChannel

org.springframework.integration.kafka.channel.PollableKafkaChannel

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ExecutorChannelInterceptorAware, ComponentSourceAware, ExpressionCapable, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageChannel, PollableChannel, InterceptableChannel

public class PollableKafkaChannel
extends AbstractKafkaChannel
implements PollableChannel, ExecutorChannelInterceptorAware

Pollable channel backed by an Apache Kafka topic.

Since:

5.4

Author:

Gary Russell, Artem Bilan, Ngoc Nhan

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.channel.AbstractMessageChannel

AbstractMessageChannel.ChannelInterceptorList

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

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.kafka.channel.AbstractKafkaChannel

topic

Fields inherited from class org.springframework.integration.channel.AbstractMessageChannel

interceptors, meters

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.messaging.MessageChannel

INDEFINITE_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
PollableKafkaChannel(org.springframework.kafka.core.KafkaOperations<?,?> template, KafkaMessageSource<?,?> source)	Construct an instance with the provided parameters.

Method Summary

Modifier and Type	Method	Description
void	addInterceptor(int index, ChannelInterceptor interceptor)	Add a channel interceptor to the specified index of the list.
void	addInterceptor(ChannelInterceptor interceptor)	Add a channel interceptor to the end of the list.
protected Message<?>	doReceive()
boolean	hasExecutorInterceptors()
protected void	onInit()	Subclasses may implement this for initialization logic.
Message<?>	receive()
Message<?>	receive(long timeout)
ChannelInterceptor	removeInterceptor(int index)
boolean	removeInterceptor(ChannelInterceptor interceptor)
void	setInterceptors(List<ChannelInterceptor> interceptors)	Set the list of channel interceptors.

Methods inherited from class org.springframework.integration.kafka.channel.AbstractKafkaChannel

doSend, getGroupId, setGroupId

Methods inherited from class org.springframework.integration.channel.AbstractMessageChannel

destroy, getComponentType, getFullChannelName, getIChannelInterceptorList, getIntegrationPatternType, getInterceptors, getMetricsCaptor, getOverrides, isLoggingEnabled, isObserved, registerMetricsCaptor, registerObservationRegistry, send, send, setDatatypes, setLoggingEnabled, setMessageConverter, setObservationConvention, setShouldTrack

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

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, 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.IntegrationManagement

getManagedName, getManagedType, getThisAs, setManagedName, setManagedType

Methods inherited from interface org.springframework.messaging.support.InterceptableChannel

getInterceptors

Methods inherited from interface org.springframework.messaging.MessageChannel

send, send

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

getBeanName, getComponentName

Constructor Details

PollableKafkaChannel

public PollableKafkaChannel(org.springframework.kafka.core.KafkaOperations<?,?> template,
 KafkaMessageSource<?,?> source)

Construct an instance with the provided parameters.

Parameters:

template - the template for sending.

source - the source for receiving.

Method Details

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractMessageChannel

receive

@Nullable
public Message<?> receive()

Specified by:

receive in interface PollableChannel

receive

@Nullable
public Message<?> receive(long timeout)

Specified by:

receive in interface PollableChannel

doReceive

@Nullable
protected Message<?> doReceive()

setInterceptors

public void setInterceptors(List<ChannelInterceptor> interceptors)

Description copied from class: AbstractMessageChannel

Set the list of channel interceptors. This will clear any existing interceptors.

Specified by:

setInterceptors in interface InterceptableChannel

Overrides:

setInterceptors in class AbstractMessageChannel

Parameters:

interceptors - The list of interceptors.

addInterceptor

public void addInterceptor(ChannelInterceptor interceptor)

Description copied from class: AbstractMessageChannel

Add a channel interceptor to the end of the list.

Specified by:

addInterceptor in interface InterceptableChannel

Overrides:

addInterceptor in class AbstractMessageChannel

Parameters:

interceptor - The interceptor.

addInterceptor

public void addInterceptor(int index,
 ChannelInterceptor interceptor)

Description copied from class: AbstractMessageChannel

Add a channel interceptor to the specified index of the list.

Specified by:

addInterceptor in interface InterceptableChannel

Overrides:

addInterceptor in class AbstractMessageChannel

Parameters:

index - The index to add interceptor.

interceptor - The interceptor.

removeInterceptor

public boolean removeInterceptor(ChannelInterceptor interceptor)

Specified by:

removeInterceptor in interface InterceptableChannel

Overrides:

removeInterceptor in class AbstractMessageChannel

removeInterceptor

@Nullable
public ChannelInterceptor removeInterceptor(int index)

Specified by:

removeInterceptor in interface InterceptableChannel

Overrides:

removeInterceptor in class AbstractMessageChannel

hasExecutorInterceptors

public boolean hasExecutorInterceptors()

Specified by:

hasExecutorInterceptors in interface ExecutorChannelInterceptorAware