K
- the key type.V
- the value type.public class KafkaMessageSource<K,V>
extends org.springframework.integration.endpoint.AbstractMessageSource<java.lang.Object>
implements org.springframework.beans.factory.DisposableBean, org.springframework.context.Lifecycle
NOTE: If the application acknowledges messages out of order, the acks will be deferred until all messages prior to the offset are ack'd. If multiple records are retrieved and an earlier offset is requeued, records from the subsequent offsets will be redelivered - even if they were processed successfully. Applications should therefore implement idempotency.
Modifier and Type | Class and Description |
---|---|
static class |
KafkaMessageSource.KafkaAckCallback<K,V>
AcknowledgmentCallback for Kafka.
|
static class |
KafkaMessageSource.KafkaAckCallbackFactory<K,V>
AcknowledgmentCallbackFactory for KafkaAckInfo.
|
static interface |
KafkaMessageSource.KafkaAckInfo<K,V>
Information for building an KafkaAckCallback.
|
class |
KafkaMessageSource.KafkaAckInfoImpl
Information for building an KafkaAckCallback.
|
Constructor and Description |
---|
KafkaMessageSource(org.springframework.kafka.core.ConsumerFactory<K,V> consumerFactory,
KafkaMessageSource.KafkaAckCallbackFactory<K,V> ackCallbackFactory,
java.lang.String... topics) |
KafkaMessageSource(org.springframework.kafka.core.ConsumerFactory<K,V> consumerFactory,
java.lang.String... topics) |
Modifier and Type | Method and Description |
---|---|
protected void |
createConsumer() |
void |
destroy() |
protected java.lang.Object |
doReceive() |
protected java.lang.String |
getClientId() |
java.lang.String |
getComponentType() |
protected java.lang.String |
getGroupId() |
protected org.springframework.kafka.support.converter.RecordMessageConverter |
getMessageConverter() |
protected java.lang.reflect.Type |
getPayloadType() |
protected long |
getPollTimeout() |
protected org.apache.kafka.clients.consumer.ConsumerRebalanceListener |
getRebalanceListener() |
protected boolean |
isRawMessageHeader() |
boolean |
isRunning() |
void |
setClientId(java.lang.String clientId)
Set the client.id property for the consumer.
|
void |
setGroupId(java.lang.String groupId)
Set the group.id property for the consumer.
|
void |
setMessageConverter(org.springframework.kafka.support.converter.RecordMessageConverter messageConverter)
Set the message converter to replace the default
MessagingMessageConverter . |
void |
setPayloadType(java.lang.reflect.Type payloadType)
Set the payload type.
|
void |
setPollTimeout(long pollTimeout)
Set the pollTimeout for the poll() operations; default 50ms.
|
void |
setRawMessageHeader(boolean rawMessageHeader)
Set to true to include the raw
ConsumerRecord as a header
with key KafkaHeaders.RAW_DATA ,
enabling callers to have access to the record to process errors. |
void |
setRebalanceListener(org.apache.kafka.clients.consumer.ConsumerRebalanceListener rebalanceListener)
Set a rebalance listener.
|
void |
start() |
void |
stop() |
buildMessage, getComponentName, getManagedName, getManagedType, getMessageCount, getMessageCountLong, getOverrides, isCountsEnabled, isLoggingEnabled, receive, registerMetricsCaptor, reset, setBeanName, setCountsEnabled, setHeaderExpressions, setLoggingEnabled, setManagedName, setManagedType
afterPropertiesSet, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, getBeanFactory, getEvaluationContext, getEvaluationContext, getMessageBuilderFactory, onInit, setBeanFactory, setConversionService
public KafkaMessageSource(org.springframework.kafka.core.ConsumerFactory<K,V> consumerFactory, java.lang.String... topics)
public KafkaMessageSource(org.springframework.kafka.core.ConsumerFactory<K,V> consumerFactory, KafkaMessageSource.KafkaAckCallbackFactory<K,V> ackCallbackFactory, java.lang.String... topics)
protected java.lang.String getGroupId()
public void setGroupId(java.lang.String groupId)
groupId
- the group id.protected java.lang.String getClientId()
public void setClientId(java.lang.String clientId)
clientId
- the client id.protected long getPollTimeout()
public void setPollTimeout(long pollTimeout)
pollTimeout
- the poll timeout.protected org.springframework.kafka.support.converter.RecordMessageConverter getMessageConverter()
public void setMessageConverter(org.springframework.kafka.support.converter.RecordMessageConverter messageConverter)
MessagingMessageConverter
.messageConverter
- the converter.protected java.lang.reflect.Type getPayloadType()
public void setPayloadType(java.lang.reflect.Type payloadType)
payloadType
- the type to convert to.protected org.apache.kafka.clients.consumer.ConsumerRebalanceListener getRebalanceListener()
public void setRebalanceListener(org.apache.kafka.clients.consumer.ConsumerRebalanceListener rebalanceListener)
rebalanceListener
- the rebalance listener.public java.lang.String getComponentType()
getComponentType
in interface org.springframework.integration.support.context.NamedComponent
protected boolean isRawMessageHeader()
public void setRawMessageHeader(boolean rawMessageHeader)
ConsumerRecord
as a header
with key KafkaHeaders.RAW_DATA
,
enabling callers to have access to the record to process errors.rawMessageHeader
- true to include the header.public boolean isRunning()
isRunning
in interface org.springframework.context.Lifecycle
public void start()
start
in interface org.springframework.context.Lifecycle
public void stop()
stop
in interface org.springframework.context.Lifecycle
protected java.lang.Object doReceive()
doReceive
in class org.springframework.integration.endpoint.AbstractMessageSource<java.lang.Object>
protected void createConsumer()
public void destroy()
destroy
in interface org.springframework.beans.factory.DisposableBean