Package org.springframework.kafka.listener

Class CommonContainerStoppingErrorHandler

java.lang.Object

org.springframework.kafka.listener.KafkaExceptionLogLevelAware

org.springframework.kafka.listener.CommonContainerStoppingErrorHandler

All Implemented Interfaces:

CommonErrorHandler, DeliveryAttemptAware

public class CommonContainerStoppingErrorHandler
extends KafkaExceptionLogLevelAware
implements CommonErrorHandler

A CommonErrorHandler that stops the container when an error occurs. Replaces the legacy ContainerStoppingErrorHandler and ContainerStoppingBatchErrorHandler.

Since:

2.8

Constructor Summary

Constructors

Constructor	Description
CommonContainerStoppingErrorHandler()	Construct an instance with a default SimpleAsyncTaskExecutor.
CommonContainerStoppingErrorHandler(java.util.concurrent.Executor executor)	Construct an instance with the provided Executor.

Method Summary

Modifier and Type	Method	Description
void	handleBatch(java.lang.Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?,?> data, org.apache.kafka.clients.consumer.Consumer<?,?> consumer, MessageListenerContainer container, java.lang.Runnable invokeListener)	Handle the exception for a batch listener.
void	handleOtherException(java.lang.Exception thrownException, org.apache.kafka.clients.consumer.Consumer<?,?> consumer, MessageListenerContainer container, boolean batchListener)	Called when an exception is thrown with no records available, e.g.
void	handleRemaining(java.lang.Exception thrownException, java.util.List<org.apache.kafka.clients.consumer.ConsumerRecord<?,?>> records, org.apache.kafka.clients.consumer.Consumer<?,?> consumer, MessageListenerContainer container)	Handle the exception for a record listener when CommonErrorHandler.remainingRecords() returns true.
boolean	remainingRecords()	Deprecated.
boolean	seeksAfterHandling()	Return true if this error handler performs seeks on the failed record and remaining records (or just the remaining records after a failed record is recovered).
void	setStopContainerAbnormally(boolean stopContainerAbnormally)	Set to false to stop the container normally.

Methods inherited from class org.springframework.kafka.listener.KafkaExceptionLogLevelAware

getLogLevel, setLogLevel

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.kafka.listener.CommonErrorHandler

clearThreadState, deliveryAttempt, deliveryAttemptHeader, handleBatchAndReturnRemaining, handleOne, handleRecord, isAckAfterHandle, onPartitionsAssigned, onPartitionsAssigned, setAckAfterHandle

Constructor Detail

CommonContainerStoppingErrorHandler

public CommonContainerStoppingErrorHandler()

Construct an instance with a default SimpleAsyncTaskExecutor.

CommonContainerStoppingErrorHandler

public CommonContainerStoppingErrorHandler(java.util.concurrent.Executor executor)

Construct an instance with the provided Executor.

Parameters:

executor - the executor.

Method Detail

setStopContainerAbnormally

public void setStopContainerAbnormally(boolean stopContainerAbnormally)

Set to false to stop the container normally. By default, the container is stopped abnormally, so that container.isInExpectedState() returns false. If you want to container to remain "healthy" when using this error handler, set the property to false.

Parameters:

stopContainerAbnormally - false for normal stop.

Since:

2.8

remainingRecords

@Deprecated
public boolean remainingRecords()

Deprecated.

Description copied from interface: CommonErrorHandler

Return false if this error handler should only receive the current failed record; remaining records will be passed to the listener after the error handler returns. When true (default), all remaining records including the failed record are passed to the error handler.

Specified by:

remainingRecords in interface CommonErrorHandler

Returns:

false to receive only the failed record.

See Also:

CommonErrorHandler.handleRecord(Exception, ConsumerRecord, Consumer, MessageListenerContainer), CommonErrorHandler.handleRemaining(Exception, List, Consumer, MessageListenerContainer)

seeksAfterHandling

public boolean seeksAfterHandling()

Description copied from interface: CommonErrorHandler

Return true if this error handler performs seeks on the failed record and remaining records (or just the remaining records after a failed record is recovered).

Specified by:

seeksAfterHandling in interface CommonErrorHandler

Returns:

true if the next poll should fetch records.

handleOtherException

public void handleOtherException(java.lang.Exception thrownException,
                                 org.apache.kafka.clients.consumer.Consumer<?,?> consumer,
                                 MessageListenerContainer container,
                                 boolean batchListener)

Description copied from interface: CommonErrorHandler

Called when an exception is thrown with no records available, e.g. if the consumer poll throws an exception.

Specified by:

handleOtherException in interface CommonErrorHandler

Parameters:

thrownException - the exception.

consumer - the consumer.

container - the container.

batchListener - true if the listener is a batch listener.

handleRemaining

public void handleRemaining(java.lang.Exception thrownException,
                            java.util.List<org.apache.kafka.clients.consumer.ConsumerRecord<?,?>> records,
                            org.apache.kafka.clients.consumer.Consumer<?,?> consumer,
                            MessageListenerContainer container)

Description copied from interface: CommonErrorHandler

Handle the exception for a record listener when CommonErrorHandler.remainingRecords() returns true. The failed record and all the remaining records from the poll are passed in. Usually used when the error handler performs seeks so that the remaining records will be redelivered on the next poll.

Specified by:

handleRemaining in interface CommonErrorHandler

Parameters:

thrownException - the exception.

records - the remaining records including the one that failed.

consumer - the consumer.

container - the container.

See Also:

CommonErrorHandler.remainingRecords()

handleBatch

public void handleBatch(java.lang.Exception thrownException,
                        org.apache.kafka.clients.consumer.ConsumerRecords<?,?> data,
                        org.apache.kafka.clients.consumer.Consumer<?,?> consumer,
                        MessageListenerContainer container,
                        java.lang.Runnable invokeListener)

Description copied from interface: CommonErrorHandler

Handle the exception for a batch listener. The complete ConsumerRecords from the poll is supplied. The error handler needs to perform seeks if you wish to reprocess the records in the batch.

Specified by:

handleBatch in interface CommonErrorHandler

Parameters:

thrownException - the exception.

data - the consumer records.

consumer - the consumer.

container - the container.

invokeListener - a callback to re-invoke the listener.