org.springframework.kafka.listener

Class ConsumerProperties

java.lang.Object

org.springframework.kafka.listener.ConsumerProperties

Direct Known Subclasses:

ContainerProperties

public class ConsumerProperties
extends java.lang.Object

Common consumer properties.

Since:

2.3

Author:

Gary Russell

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_POLL_TIMEOUT The default pollTimeout (ms).

Constructor Summary

Constructors

Constructor and Description
ConsumerProperties(java.util.regex.Pattern topicPattern) Create properties for a container that will subscribe to topics matching the specified pattern.
ConsumerProperties(java.lang.String... topics) Create properties for a container that will subscribe to the specified topics.
ConsumerProperties(TopicPartitionOffset... topicPartitions) Create properties for a container that will assign itself the provided topic partitions.

Method Summary

Modifier and Type	Method and Description
java.time.Duration	getAuthorizationExceptionRetryInterval()
java.lang.String	getClientId() Return the client id.
org.apache.kafka.clients.consumer.OffsetCommitCallback	getCommitCallback()
LogIfLevelEnabled.Level	getCommitLogLevel() The level at which to log offset commits.
int	getCommitRetries() The number of retries allowed when a RetriableCommitFailedException is thrown by the consumer.
org.apache.kafka.clients.consumer.ConsumerRebalanceListener	getConsumerRebalanceListener()
java.lang.String	getGroupId()
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.
long	getPollTimeout()
java.time.Duration	getSyncCommitTimeout()
TopicPartitionOffset[]	getTopicPartitionsToAssign()
java.util.regex.Pattern	getTopicPattern()
java.lang.String[]	getTopics()
boolean	isOnlyLogRecordMetadata()
boolean	isSyncCommits()
protected java.lang.String	renderProperties()
void	setAuthorizationExceptionRetryInterval(java.time.Duration authorizationExceptionRetryInterval) Set the interval between retries after AuthorizationException is thrown by KafkaConsumer.
void	setClientId(java.lang.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 a RetriableCommitFailedException is thrown by the consumer.
void	setConsumerRebalanceListener(org.apache.kafka.clients.consumer.ConsumerRebalanceListener consumerRebalanceListener) Set the user defined ConsumerRebalanceListener implementation.
void	setGroupId(java.lang.String groupId) Set the group id for this container.
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.
void	setOnlyLogRecordMetadata(boolean onlyLogRecordMetadata) Set to true to only log topic-partition@offset in log messages instead of record.toString().
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(java.time.Duration syncCommitTimeout) Set the timeout for commitSync operations (if isSyncCommits().
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_POLL_TIMEOUT

public static final long DEFAULT_POLL_TIMEOUT

The default pollTimeout (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()

getTopicPattern

@Nullable
public java.util.regex.Pattern getTopicPattern()

getTopicPartitionsToAssign

@Nullable
public TopicPartitionOffset[] getTopicPartitionsToAssign()

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 any group.id property 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 defined ConsumerRebalanceListener implementation.

Parameters:

consumerRebalanceListener - the ConsumerRebalanceListener instance

getConsumerRebalanceListener

public org.apache.kafka.clients.consumer.ConsumerRebalanceListener getConsumerRebalanceListener()

setSyncCommitTimeout

public void setSyncCommitTimeout(@Nullable
                                 java.time.Duration syncCommitTimeout)

Set the timeout for commitSync operations (if isSyncCommits(). 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 when syncCommits is 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. group.id and client.id are 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.id and client.id are ignored. Property values must be Strings; only properties returned by Properties.stringPropertyNames() will be applied.

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 after AuthorizationException is thrown by KafkaConsumer. By default the field is null and retries are disabled. In such case the container will be stopped. The interval must be less than max.poll.interval.ms consumer property.

Parameters:

authorizationExceptionRetryInterval - the duration between retries

Since:

2.3.5

getCommitRetries

public int getCommitRetries()

The number of retries allowed when a RetriableCommitFailedException is 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 a RetriableCommitFailedException is 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 log topic-partition@offset in log messages instead of record.toString().

Parameters:

onlyLogRecordMetadata - true to only log the topic/parrtition/offset.

Since:

2.2.14

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

renderProperties

protected final java.lang.String renderProperties()