Class ConsumerProperties
- java.lang.Object
-
- org.springframework.kafka.listener.ConsumerProperties
-
- Direct Known Subclasses:
ContainerProperties
public class ConsumerProperties extends java.lang.ObjectCommon consumer properties.- Since:
- 2.3
- Author:
- Gary Russell
-
-
Field Summary
Fields Modifier and Type Field Description static longDEFAULT_POLL_TIMEOUTThe defaultpollTimeout(ms).
-
Constructor Summary
Constructors Constructor Description ConsumerProperties(java.lang.String... topics)Create properties for a container that will subscribe to the specified topics.ConsumerProperties(java.util.regex.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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.time.DurationgetAuthorizationExceptionRetryInterval()java.lang.StringgetClientId()Return the client id.org.apache.kafka.clients.consumer.OffsetCommitCallbackgetCommitCallback()LogIfLevelEnabled.LevelgetCommitLogLevel()The level at which to log offset commits.intgetCommitRetries()The number of retries allowed when aRetriableCommitFailedExceptionis thrown by the consumer.org.apache.kafka.clients.consumer.ConsumerRebalanceListenergetConsumerRebalanceListener()java.lang.StringgetGroupId()java.util.PropertiesgetKafkaConsumerProperties()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.longgetPollTimeout()java.time.DurationgetSyncCommitTimeout()TopicPartitionOffset[]getTopicPartitions()Return the configuredTopicPartitionOffsets.TopicPartitionOffset[]getTopicPartitionsToAssign()Deprecated.in favor ofgetTopicPartitions().java.util.regex.PatterngetTopicPattern()Return the configured topic pattern.java.lang.String[]getTopics()Return the configured topics.booleanisFixTxOffsets()Whether or not to correct terminal transactional offsets.booleanisOnlyLogRecordMetadata()booleanisSyncCommits()protected java.lang.StringrenderProperties()voidsetAuthorizationExceptionRetryInterval(java.time.Duration authorizationExceptionRetryInterval)Set the interval between retries afterAuthorizationExceptionis thrown byKafkaConsumer.voidsetClientId(java.lang.String clientId)Set the client id; overrides the consumer factory client.id property.voidsetCommitCallback(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.voidsetCommitLogLevel(LogIfLevelEnabled.Level commitLogLevel)Set the level at which to log offset commits.voidsetCommitRetries(int commitRetries)Set number of retries allowed when aRetriableCommitFailedExceptionis thrown by the consumer.voidsetConsumerRebalanceListener(org.apache.kafka.clients.consumer.ConsumerRebalanceListener consumerRebalanceListener)Set the user definedConsumerRebalanceListenerimplementation.voidsetFixTxOffsets(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.voidsetGroupId(java.lang.String groupId)Set the group id for this container.voidsetKafkaConsumerProperties(java.util.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.voidsetOnlyLogRecordMetadata(boolean onlyLogRecordMetadata)Set to true to only logtopic-partition@offsetin log messages instead ofrecord.toString().voidsetPollTimeout(long pollTimeout)Set the max time to block in the consumer waiting for records.voidsetSyncCommits(boolean syncCommits)Set whether or not to call consumer.commitSync() or commitAsync() when the container is responsible for commits.voidsetSyncCommitTimeout(java.time.Duration syncCommitTimeout)Set the timeout for commitSync operations (ifisSyncCommits().java.lang.StringtoString()
-
-
-
Field Detail
-
DEFAULT_POLL_TIMEOUT
public static final long DEFAULT_POLL_TIMEOUT
The defaultpollTimeout(ms).- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ConsumerProperties
public ConsumerProperties(java.lang.String... topics)
Create properties for a container that will subscribe to the specified topics.- Parameters:
topics- the topics.
-
ConsumerProperties
public ConsumerProperties(java.util.regex.Pattern topicPattern)
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
public ConsumerProperties(TopicPartitionOffset... topicPartitions)
Create properties for a container that will assign itself the provided topic partitions.- Parameters:
topicPartitions- the topic partitions.
-
-
Method Detail
-
getTopics
@Nullable public java.lang.String[] getTopics()
Return the configured topics.- Returns:
- the topics.
-
getTopicPattern
@Nullable public java.util.regex.Pattern getTopicPattern()
Return the configured topic pattern.- Returns:
- the topic pattern.
-
getTopicPartitionsToAssign
@Deprecated @Nullable public TopicPartitionOffset[] getTopicPartitionsToAssign()
Deprecated.in favor ofgetTopicPartitions().Return the configuredTopicPartitionOffsets.- Returns:
- the topics/partitions.
-
getTopicPartitions
@Nullable public TopicPartitionOffset[] getTopicPartitions()
Return the configuredTopicPartitionOffsets.- 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
public void setGroupId(java.lang.String groupId)
Set the group id for this container. Overrides anygroup.idproperty provided by the consumer factory configuration.- Parameters:
groupId- the group id.
-
getGroupId
public java.lang.String getGroupId()
-
getClientId
public java.lang.String getClientId()
Return the client id.- Returns:
- the client id.
- See Also:
setClientId(String)
-
setClientId
public void setClientId(java.lang.String clientId)
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 definedConsumerRebalanceListenerimplementation.- Parameters:
consumerRebalanceListener- theConsumerRebalanceListenerinstance
-
getConsumerRebalanceListener
public org.apache.kafka.clients.consumer.ConsumerRebalanceListener getConsumerRebalanceListener()
-
setSyncCommitTimeout
public void setSyncCommitTimeout(@Nullable java.time.Duration syncCommitTimeout)Set the timeout for commitSync operations (ifisSyncCommits(). Overrides the default api timeout property.- Parameters:
syncCommitTimeout- the timeout.- See Also:
setSyncCommits(boolean)
-
getSyncCommitTimeout
public java.time.Duration getSyncCommitTimeout()
-
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 whensyncCommitsis false.- Parameters:
commitCallback- the callback.- See Also:
setSyncCommits(boolean)
-
getCommitCallback
public org.apache.kafka.clients.consumer.OffsetCommitCallback getCommitCallback()
-
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:
setSyncCommitTimeout(Duration),setCommitCallback(OffsetCommitCallback),setCommitLogLevel(org.springframework.kafka.support.LogIfLevelEnabled.Level)
-
isSyncCommits
public boolean isSyncCommits()
-
getCommitLogLevel
public LogIfLevelEnabled.Level getCommitLogLevel()
The level at which to log offset commits.- Returns:
- the level.
-
setCommitLogLevel
public void setCommitLogLevel(LogIfLevelEnabled.Level commitLogLevel)
Set the level at which to log offset commits. Default: DEBUG.- Parameters:
commitLogLevel- the level.
-
getKafkaConsumerProperties
public java.util.Properties 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.idandclient.idare ignored.- Returns:
- the properties.
- See Also:
ConsumerConfig,setGroupId(String),setClientId(String)
-
setKafkaConsumerProperties
public void setKafkaConsumerProperties(java.util.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.group.idandclient.idare ignored. Property keys must beStrings.- Parameters:
kafkaConsumerProperties- the properties.- See Also:
ConsumerConfig,setGroupId(String),setClientId(String)
-
getAuthorizationExceptionRetryInterval
public java.time.Duration getAuthorizationExceptionRetryInterval()
-
setAuthorizationExceptionRetryInterval
public void setAuthorizationExceptionRetryInterval(java.time.Duration authorizationExceptionRetryInterval)
Set the interval between retries afterAuthorizationExceptionis 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.msconsumer property.- Parameters:
authorizationExceptionRetryInterval- the duration between retries- Since:
- 2.3.5
-
getCommitRetries
public int getCommitRetries()
The number of retries allowed when aRetriableCommitFailedExceptionis thrown by the consumer.- Returns:
- the number of retries.
- Since:
- 2.3.9
-
setCommitRetries
public void setCommitRetries(int commitRetries)
Set number of retries allowed when aRetriableCommitFailedExceptionis thrown by the consumer. Default 3 (4 attempts total).- Parameters:
commitRetries- the commitRetries.- Since:
- 2.3.9
-
isOnlyLogRecordMetadata
public boolean isOnlyLogRecordMetadata()
-
setOnlyLogRecordMetadata
public void setOnlyLogRecordMetadata(boolean onlyLogRecordMetadata)
Set to true to only logtopic-partition@offsetin log messages instead ofrecord.toString().- Parameters:
onlyLogRecordMetadata- true to only log the topic/parrtition/offset.- Since:
- 2.2.14
-
isFixTxOffsets
public boolean isFixTxOffsets()
Whether or not to correct terminal transactional offsets.- Returns:
- true to fix.
- Since:
- 2.5.6
- See Also:
setFixTxOffsets(boolean)
-
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.- Parameters:
fixTxOffsets- true to correct the offset(s).- Since:
- 2.5.6
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
renderProperties
protected final java.lang.String renderProperties()
-
-