ContainerProperties (Spring Kafka 1.2.2.RELEASE API)

java.lang.Object
- org.springframework.kafka.listener.config.ContainerProperties

```
public class ContainerProperties
extends java.lang.Object
```
Contains runtime properties for a listener container.

Author:

Gary Russell, Artem Bilan, Artem Yakshin

Constructor Summary

Constructors
Constructor and Description
`ContainerProperties(java.util.regex.Pattern topicPattern)`
`ContainerProperties(java.lang.String... topics)`
`ContainerProperties(TopicPartitionInitialOffset... topicPartitions)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAckCount()`
`AbstractMessageListenerContainer.AckMode`	`getAckMode()`
`long`	`getAckTime()`
`org.apache.kafka.clients.consumer.OffsetCommitCallback`	`getCommitCallback()`
`org.apache.kafka.clients.consumer.ConsumerRebalanceListener`	`getConsumerRebalanceListener()`
`org.springframework.core.task.AsyncListenableTaskExecutor`	`getConsumerTaskExecutor()`
`GenericErrorHandler<?>`	`getGenericErrorHandler()`
`java.lang.Long`	`getIdleEventInterval()`
`org.springframework.core.task.AsyncListenableTaskExecutor`	`getListenerTaskExecutor()`
`java.lang.Object`	`getMessageListener()`
`long`	`getPauseAfter()`
`long`	`getPollTimeout()`
`int`	`getQueueDepth()`
`long`	`getShutdownTimeout()`
`TopicPartitionInitialOffset[]`	`getTopicPartitions()`
`java.util.regex.Pattern`	`getTopicPattern()`
`java.lang.String[]`	`getTopics()`
`boolean`	`isAckOnError()`
`boolean`	`isPauseEnabled()`
`boolean`	`isSyncCommits()`
`void`	`setAckCount(int count)` Set the number of outstanding record count after which offsets should be committed when `AbstractMessageListenerContainer.AckMode.COUNT` or `AbstractMessageListenerContainer.AckMode.COUNT_TIME` is being used.
`void`	`setAckMode(AbstractMessageListenerContainer.AckMode ackMode)` Set the ack mode to use when auto ack (in the configuration properties) is false.
`void`	`setAckOnError(boolean ackOnError)` Set whether or not the container should commit offsets (ack messages) where the listener throws exceptions.
`void`	`setAckTime(long ackTime)` Set the time (ms) after which outstanding offsets should be committed when `AbstractMessageListenerContainer.AckMode.TIME` or `AbstractMessageListenerContainer.AckMode.COUNT_TIME` is being used.
`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`	`setConsumerRebalanceListener(org.apache.kafka.clients.consumer.ConsumerRebalanceListener consumerRebalanceListener)` Set the user defined `ConsumerRebalanceListener` implementation.
`void`	`setConsumerTaskExecutor(org.springframework.core.task.AsyncListenableTaskExecutor consumerTaskExecutor)` Set the executor for threads that poll the consumer.
`void`	`setErrorHandler(ErrorHandler errorHandler)` Set the error handler to call when the listener throws an exception.
`void`	`setGenericErrorHandler(GenericErrorHandler<?> errorHandler)` Set the error handler to call when the listener throws an exception.
`void`	`setIdleEventInterval(java.lang.Long idleEventInterval)` Set the idle event interval; when set, an event is emitted if a poll returns no records and this interval has elapsed since a record was returned.
`void`	`setListenerTaskExecutor(org.springframework.core.task.AsyncListenableTaskExecutor listenerTaskExecutor)` Set the executor for threads that invoke the listener.
`void`	`setMessageListener(java.lang.Object messageListener)` Set the message listener; must be a `MessageListener` or `AcknowledgingMessageListener`.
`void`	`setPauseAfter(long pauseAfter)` When using Kafka group management and `setPauseEnabled(boolean)` is true, set the delay after which the consumer should be paused.
`void`	`setPauseEnabled(boolean pauseEnabled)` Set to true to avoid rebalancing when this consumer is slow or throws a qualifying exception - pause the consumer.
`void`	`setPollTimeout(long pollTimeout)` Set the max time to block in the consumer waiting for records.
`void`	`setQueueDepth(int queueDepth)` Set the queue depth for handoffs from the consumer thread to the listener thread.
`void`	`setShutdownTimeout(long shutdownTimeout)` Set the timeout for shutting down the container.
`void`	`setSyncCommits(boolean syncCommits)` Set whether or not to call consumer.commitSync() or commitAsync() when the container is responsible for commits.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ContainerProperties
```
public ContainerProperties(java.lang.String... topics)
```
  - ContainerProperties
```
public ContainerProperties(java.util.regex.Pattern topicPattern)
```
  - ContainerProperties
```
public ContainerProperties(TopicPartitionInitialOffset... topicPartitions)
```
- Method Detail
  - setMessageListener
```
public void setMessageListener(java.lang.Object messageListener)
```
    Set the message listener; must be a MessageListener or AcknowledgingMessageListener.
    
    Parameters:
    
    messageListener - the listener.
  - setAckMode
```
public void setAckMode(AbstractMessageListenerContainer.AckMode ackMode)
```
    Set the ack mode to use when auto ack (in the configuration properties) is false.
    - RECORD: Ack after each record has been passed to the listener.
    - BATCH: Ack after each batch of records received from the consumer has been passed to the listener
    - TIME: Ack after this number of milliseconds; (should be greater than #setPollTimeout(long) pollTimeout.
    - COUNT: Ack after at least this number of records have been received
    - MANUAL: Listener is responsible for acking - use a AcknowledgingMessageListener.
    Parameters:
    
    ackMode - the AbstractMessageListenerContainer.AckMode; default BATCH.
  - 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 1000.
  - setAckCount
```
public void setAckCount(int count)
```
    Set the number of outstanding record count after which offsets should be committed when AbstractMessageListenerContainer.AckMode.COUNT or AbstractMessageListenerContainer.AckMode.COUNT_TIME is being used.
    
    Parameters:
    
    count - the count
  - setAckTime
```
public void setAckTime(long ackTime)
```
    Set the time (ms) after which outstanding offsets should be committed when AbstractMessageListenerContainer.AckMode.TIME or AbstractMessageListenerContainer.AckMode.COUNT_TIME is being used. Should be larger than
    
    Parameters:
    
    ackTime - the time
  - setErrorHandler
```
public void setErrorHandler(ErrorHandler errorHandler)
```
    Set the error handler to call when the listener throws an exception.
    
    Parameters:
    
    errorHandler - the error handler.
    
    See Also:
    
    setGenericErrorHandler(GenericErrorHandler)
  - setGenericErrorHandler
```
public void setGenericErrorHandler(GenericErrorHandler<?> errorHandler)
```
    Set the error handler to call when the listener throws an exception.
    
    Parameters:
    
    errorHandler - the error handler.
  - setConsumerTaskExecutor
```
public void setConsumerTaskExecutor(org.springframework.core.task.AsyncListenableTaskExecutor consumerTaskExecutor)
```
    Set the executor for threads that poll the consumer.
    
    Parameters:
    
    consumerTaskExecutor - the executor
  - setListenerTaskExecutor
```
public void setListenerTaskExecutor(org.springframework.core.task.AsyncListenableTaskExecutor listenerTaskExecutor)
```
    Set the executor for threads that invoke the listener.
    
    Parameters:
    
    listenerTaskExecutor - the executor.
  - setPauseAfter
```
public void setPauseAfter(long pauseAfter)
```
    When using Kafka group management and setPauseEnabled(boolean) is true, set the delay after which the consumer should be paused. Default 10000.
    
    Parameters:
    
    pauseAfter - the delay.
  - setPauseEnabled
```
public void setPauseEnabled(boolean pauseEnabled)
```
    Set to true to avoid rebalancing when this consumer is slow or throws a qualifying exception - pause the consumer. Default: true.
    
    Parameters:
    
    pauseEnabled - true to pause.
    
    See Also:
    
    setPauseAfter(long)
  - setQueueDepth
```
public void setQueueDepth(int queueDepth)
```
    Set the queue depth for handoffs from the consumer thread to the listener thread. Default 1 (up to 2 in process).
    
    Parameters:
    
    queueDepth - the queue depth.
  - setShutdownTimeout
```
public void setShutdownTimeout(long shutdownTimeout)
```
    Set the timeout for shutting down the container. This is the maximum amount of time that the invocation to #stop(Runnable) will block for, before returning.
    
    Parameters:
    
    shutdownTimeout - the shutdown timeout.
  - setConsumerRebalanceListener
```
public void setConsumerRebalanceListener(org.apache.kafka.clients.consumer.ConsumerRebalanceListener consumerRebalanceListener)
```
    Set the user defined ConsumerRebalanceListener implementation.
    
    Parameters:
    
    consumerRebalanceListener - the ConsumerRebalanceListener instance
  - 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.
    
    Parameters:
    
    commitCallback - the callback.
  - 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. See https://github.com/spring-projects/spring-kafka/issues/62 At the time of writing, async commits are not entirely reliable.
    
    Parameters:
    
    syncCommits - true to use commitSync().
  - setIdleEventInterval
```
public void setIdleEventInterval(java.lang.Long idleEventInterval)
```
    Set the idle event interval; when set, an event is emitted if a poll returns no records and this interval has elapsed since a record was returned.
    
    Parameters:
    
    idleEventInterval - the interval.
  - setAckOnError
```
public void setAckOnError(boolean ackOnError)
```
    Set whether or not the container should commit offsets (ack messages) where the listener throws exceptions. This works in conjunction with ackMode and is effective only when the kafka property enable.auto.commit is false; it is not applicable to manual ack modes. When this property is set to true (the default), all messages handled will have their offset committed. When set to false, offsets will be committed only for successfully handled messages. Manual acks will always be applied. Bear in mind that, if the next message is successfully handled, its offset will be committed, effectively committing the offset of the failed message anyway, so this option has limited applicability. Perhaps useful for a component that starts throwing exceptions consistently; allowing it to resume when restarted from the last successfully processed message.
    
    Parameters:
    
    ackOnError - whether the container should acknowledge messages that throw exceptions.
  - getTopics
```
public java.lang.String[] getTopics()
```
  - getTopicPattern
```
public java.util.regex.Pattern getTopicPattern()
```
  - getTopicPartitions
```
public TopicPartitionInitialOffset[] getTopicPartitions()
```
  - getAckMode
```
public AbstractMessageListenerContainer.AckMode getAckMode()
```
  - getAckCount
```
public int getAckCount()
```
  - getAckTime
```
public long getAckTime()
```
  - getMessageListener
```
public java.lang.Object getMessageListener()
```
  - getPollTimeout
```
public long getPollTimeout()
```
  - getConsumerTaskExecutor
```
public org.springframework.core.task.AsyncListenableTaskExecutor getConsumerTaskExecutor()
```
  - getListenerTaskExecutor
```
public org.springframework.core.task.AsyncListenableTaskExecutor getListenerTaskExecutor()
```
  - getGenericErrorHandler
```
public GenericErrorHandler<?> getGenericErrorHandler()
```
  - getPauseAfter
```
public long getPauseAfter()
```
  - isPauseEnabled
```
public boolean isPauseEnabled()
```
  - getQueueDepth
```
public int getQueueDepth()
```
  - getShutdownTimeout
```
public long getShutdownTimeout()
```
  - getConsumerRebalanceListener
```
public org.apache.kafka.clients.consumer.ConsumerRebalanceListener getConsumerRebalanceListener()
```
  - getCommitCallback
```
public org.apache.kafka.clients.consumer.OffsetCommitCallback getCommitCallback()
```
  - isSyncCommits
```
public boolean isSyncCommits()
```
  - getIdleEventInterval
```
public java.lang.Long getIdleEventInterval()
```
  - isAckOnError
```
public boolean isAckOnError()
```

Class ContainerProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContainerProperties

ContainerProperties

ContainerProperties

Method Detail

setMessageListener

setAckMode

setPollTimeout

setAckCount

setAckTime

setErrorHandler

setGenericErrorHandler

setConsumerTaskExecutor

setListenerTaskExecutor

setPauseAfter

setPauseEnabled

setQueueDepth

setShutdownTimeout

setConsumerRebalanceListener

setCommitCallback

setSyncCommits

setIdleEventInterval

setAckOnError

getTopics

getTopicPattern

getTopicPartitions

getAckMode

getAckCount

getAckTime

getMessageListener

getPollTimeout

getConsumerTaskExecutor

getListenerTaskExecutor

getGenericErrorHandler

getPauseAfter

isPauseEnabled

getQueueDepth

getShutdownTimeout

getConsumerRebalanceListener

getCommitCallback

isSyncCommits

getIdleEventInterval

isAckOnError