Class ConsumerProperties
java.lang.Object
org.springframework.kafka.listener.ConsumerProperties
- Direct Known Subclasses:
ContainerProperties
Common consumer properties.
- Since:
- 2.3
- Author:
- Gary Russell, Sagnhyeok An
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConsumerProperties
(String... topics) Create properties for a container that will subscribe to the specified topics.ConsumerProperties
(Pattern topicPattern) Create properties for a container that will subscribe to topics matching the specified pattern.ConsumerProperties
(TopicPartitionOffset... topicPartitions) Create properties for a container that will assign itself the provided topic partitions. -
Method Summary
Modifier and TypeMethodDescriptionGet the authentication/authorization retry interval.Return the client id.org.apache.kafka.clients.consumer.OffsetCommitCallback
Return the commit callback.The level at which to log offset commits.int
The number of retries allowed when aRetriableCommitFailedException
is thrown by the consumer when usingsetSyncCommits(boolean)
set to true.org.apache.kafka.clients.consumer.ConsumerRebalanceListener
Return the rebalance listener.Return the container's group id.Get the consumer properties that will be merged with the consumer properties provided by the consumer factory; properties here will supersede any with the same name(s) in the consumer factory.Return the offset and metadata provider.long
Return the sync commit timeout.Return the configuredTopicPartitionOffset
s.Return the configured topic pattern.String[]
Return the configured topics.boolean
Always check for a deserialization exception header with a null key.boolean
Always check for a deserialization exception header with a null value.boolean
Whether or not to correct terminal transactional offsets.boolean
protected final String
void
setAuthExceptionRetryInterval
(Duration authExceptionRetryInterval) Set the interval between retries after andAuthenticationException
ororg.apache.kafka.common.errors.AuthorizationException
is thrown byKafkaConsumer
.void
setCheckDeserExWhenKeyNull
(boolean checkDeserExWhenKeyNull) Set to true to always check forDeserializationException
header when a null key is received.void
setCheckDeserExWhenValueNull
(boolean checkDeserExWhenValueNull) Set to true to always check forDeserializationException
header when a null value is received.void
setClientId
(String clientId) Set the client id; overrides the consumer factory client.id property.void
setCommitCallback
(org.apache.kafka.clients.consumer.OffsetCommitCallback commitCallback) Set the commit callback; by default a simple logging callback is used to log success at DEBUG level and failures at ERROR level.void
setCommitLogLevel
(LogIfLevelEnabled.Level commitLogLevel) Set the level at which to log offset commits.void
setCommitRetries
(int commitRetries) Set number of retries allowed when aRetriableCommitFailedException
is thrown by the consumer when usingsetSyncCommits(boolean)
set to true.void
setConsumerRebalanceListener
(org.apache.kafka.clients.consumer.ConsumerRebalanceListener consumerRebalanceListener) Set the user definedConsumerRebalanceListener
implementation.void
setFixTxOffsets
(boolean fixTxOffsets) When consuming records produced by a transactional producer, and the consumer is positioned at the end of a partition, the lag can incorrectly be reported as greater than zero, due to the pseudo record used to indicate transaction commit/rollback and, possibly, the presence of rolled-back records.void
setGroupId
(String groupId) Set the group id for this container.void
setKafkaConsumerProperties
(Properties kafkaConsumerProperties) Set the consumer properties that will be merged with the consumer properties provided by the consumer factory; properties here will supersede any with the same name(s) in the consumer factory.void
setOffsetAndMetadataProvider
(OffsetAndMetadataProvider offsetAndMetadataProvider) Set the offset and metadata provider associated to a commit callback.void
setPollTimeout
(long pollTimeout) Set the max time to block in the consumer waiting for records.void
setSyncCommits
(boolean syncCommits) Set whether or not to call consumer.commitSync() or commitAsync() when the container is responsible for commits.void
setSyncCommitTimeout
(Duration syncCommitTimeout) Set the timeout for commitSync operations (ifisSyncCommits()
.toString()
-
Field Details
-
DEFAULT_POLL_TIMEOUT
public static final long DEFAULT_POLL_TIMEOUTThe defaultpollTimeout
(ms).- See Also:
-
-
Constructor Details
-
ConsumerProperties
Create properties for a container that will subscribe to the specified topics.- Parameters:
topics
- the topics.
-
ConsumerProperties
Create properties for a container that will subscribe to topics matching the specified pattern. The framework will create a container that subscribes to all topics matching the specified pattern to get dynamically assigned partitions. The pattern matching will be performed periodically against topics existing at the time of check.- Parameters:
topicPattern
- the pattern.- See Also:
-
CommonClientConfigs.METADATA_MAX_AGE_CONFIG
-
ConsumerProperties
Create properties for a container that will assign itself the provided topic partitions.- Parameters:
topicPartitions
- the topic partitions.
-
-
Method Details
-
getTopics
Return the configured topics.- Returns:
- the topics.
-
getTopicPattern
Return the configured topic pattern.- Returns:
- the topic pattern.
-
getTopicPartitions
Return the configuredTopicPartitionOffset
s.- Returns:
- the topics/partitions.
- Since:
- 2.5
-
setPollTimeout
public void setPollTimeout(long pollTimeout) Set the max time to block in the consumer waiting for records.- Parameters:
pollTimeout
- the timeout in ms; default 5000L.
-
getPollTimeout
public long getPollTimeout() -
setGroupId
Set the group id for this container. Overrides anygroup.id
property provided by the consumer factory configuration.- Parameters:
groupId
- the group id.
-
getGroupId
Return the container's group id.- Returns:
- the group id.
-
getClientId
Return the client id.- Returns:
- the client id.
- See Also:
-
setClientId
Set the client id; overrides the consumer factory client.id property. When used in a concurrent container, will be suffixed with '-n' to provide a unique value for each consumer.- Parameters:
clientId
- the client id.
-
setConsumerRebalanceListener
public void setConsumerRebalanceListener(org.apache.kafka.clients.consumer.ConsumerRebalanceListener consumerRebalanceListener) Set the user definedConsumerRebalanceListener
implementation.- Parameters:
consumerRebalanceListener
- theConsumerRebalanceListener
instance
-
getConsumerRebalanceListener
@Nullable public org.apache.kafka.clients.consumer.ConsumerRebalanceListener getConsumerRebalanceListener()Return the rebalance listener.- Returns:
- the listener.
-
setSyncCommitTimeout
Set the timeout for commitSync operations (ifisSyncCommits()
. Overrides the default api timeout property.- Parameters:
syncCommitTimeout
- the timeout.- See Also:
-
getSyncCommitTimeout
Return the sync commit timeout.- Returns:
- the timeout.
-
setCommitCallback
public void setCommitCallback(org.apache.kafka.clients.consumer.OffsetCommitCallback commitCallback) Set the commit callback; by default a simple logging callback is used to log success at DEBUG level and failures at ERROR level. Used whensyncCommits
is false.- Parameters:
commitCallback
- the callback.- See Also:
-
setOffsetAndMetadataProvider
Set the offset and metadata provider associated to a commit callback.- Parameters:
offsetAndMetadataProvider
- an offset and metadata provider.- Since:
- 2.8.5
- See Also:
-
getCommitCallback
Return the commit callback.- Returns:
- the callback.
-
getOffsetAndMetadataProvider
Return the offset and metadata provider.- Returns:
- the offset and metadata provider.
-
setSyncCommits
public void setSyncCommits(boolean syncCommits) Set whether or not to call consumer.commitSync() or commitAsync() when the container is responsible for commits. Default true.- Parameters:
syncCommits
- true to use commitSync().- See Also:
-
isSyncCommits
public boolean isSyncCommits() -
getCommitLogLevel
The level at which to log offset commits.- Returns:
- the level.
-
setCommitLogLevel
Set the level at which to log offset commits. Default: DEBUG.- Parameters:
commitLogLevel
- the level.
-
getKafkaConsumerProperties
Get the consumer properties that will be merged with the consumer properties provided by the consumer factory; properties here will supersede any with the same name(s) in the consumer factory. You can add non-String-valued properties, but the property name (hashtable key) must be String; all others will be ignored.group.id
andclient.id
are ignored.- Returns:
- the properties.
- See Also:
-
ConsumerConfig
setGroupId(String)
setClientId(String)
-
setKafkaConsumerProperties
Set the consumer properties that will be merged with the consumer properties provided by the consumer factory; properties here will supersede any with the same name(s) in the consumer factory.group.id
andclient.id
are ignored. Property keys must beString
s.- Parameters:
kafkaConsumerProperties
- the properties.- See Also:
-
ConsumerConfig
setGroupId(String)
setClientId(String)
-
getAuthExceptionRetryInterval
Get the authentication/authorization retry interval.- Returns:
- the interval.
-
setAuthExceptionRetryInterval
Set the interval between retries after andAuthenticationException
ororg.apache.kafka.common.errors.AuthorizationException
is thrown byKafkaConsumer
. By default the field is null and retries are disabled. In such case the container will be stopped. The interval must be less thanmax.poll.interval.ms
consumer property.- Parameters:
authExceptionRetryInterval
- the duration between retries- Since:
- 2.8
-
getCommitRetries
public int getCommitRetries()The number of retries allowed when aRetriableCommitFailedException
is thrown by the consumer when usingsetSyncCommits(boolean)
set to true.- Returns:
- the number of retries.
- Since:
- 2.3.9
- See Also:
-
setCommitRetries
public void setCommitRetries(int commitRetries) Set number of retries allowed when aRetriableCommitFailedException
is thrown by the consumer when usingsetSyncCommits(boolean)
set to true. Default 3 (4 attempts total).- Parameters:
commitRetries
- the commitRetries.- Since:
- 2.3.9
- See Also:
-
isFixTxOffsets
public boolean isFixTxOffsets()Whether or not to correct terminal transactional offsets.- Returns:
- true to fix.
- Since:
- 2.5.6
- See Also:
-
setFixTxOffsets
public void setFixTxOffsets(boolean fixTxOffsets) When consuming records produced by a transactional producer, and the consumer is positioned at the end of a partition, the lag can incorrectly be reported as greater than zero, due to the pseudo record used to indicate transaction commit/rollback and, possibly, the presence of rolled-back records. This does not functionally affect the consumer but some users have expressed concern that the "lag" is non-zero. Set this to true and the container will correct such mis-reported offsets. The check is performed before the next poll to avoid adding significant complexity to the commit processing. IMPORTANT: At the time of writing, the lag will only be corrected if the consumer is configured withisolation.level=read_committed
andmax.poll.records
is greater than 1. See https://issues.apache.org/jira/browse/KAFKA-10683 for more information.- Parameters:
fixTxOffsets
- true to correct the offset(s).- Since:
- 2.5.6
-
isCheckDeserExWhenKeyNull
public boolean isCheckDeserExWhenKeyNull()Always check for a deserialization exception header with a null key.- Returns:
- true to check.
- Since:
- 2.8.1
-
setCheckDeserExWhenKeyNull
public void setCheckDeserExWhenKeyNull(boolean checkDeserExWhenKeyNull) Set to true to always check forDeserializationException
header when a null key is received. Useful when the consumer code cannot determine that anErrorHandlingDeserializer
has been configured, such as when using a delegating deserializer.- Parameters:
checkDeserExWhenKeyNull
- true to always check.- Since:
- 2.8.1
-
isCheckDeserExWhenValueNull
public boolean isCheckDeserExWhenValueNull()Always check for a deserialization exception header with a null value.- Returns:
- true to check.
- Since:
- 2.8.1
-
setCheckDeserExWhenValueNull
public void setCheckDeserExWhenValueNull(boolean checkDeserExWhenValueNull) Set to true to always check forDeserializationException
header when a null value is received. Useful when the consumer code cannot determine that anErrorHandlingDeserializer
has been configured, such as when using a delegating deserializer.- Parameters:
checkDeserExWhenValueNull
- true to always check.- Since:
- 2.8.1
-
toString
-
renderProperties
-