Package org.springframework.kafka.listener

Class BatchListenerFailedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.core.NestedRuntimeException

org.springframework.kafka.KafkaException

org.springframework.kafka.listener.BatchListenerFailedException

All Implemented Interfaces:

Serializable

public class BatchListenerFailedException
extends KafkaException

An exception thrown by user code to inform the framework which record in a batch has failed.

Since:

2.5

Author:

Gary Russell

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.kafka.KafkaException

KafkaException.Level

Constructor Summary

Constructors

Constructor	Description
BatchListenerFailedException(String message, int index)	Construct an instance with the provided properties.
BatchListenerFailedException(String message, Throwable cause, int index)	Construct an instance with the provided properties.
BatchListenerFailedException(String message, Throwable cause, org.apache.kafka.clients.consumer.ConsumerRecord<?,?> record)	Construct an instance with the provided properties.
BatchListenerFailedException(String message, org.apache.kafka.clients.consumer.ConsumerRecord<?,?> record)	Construct an instance with the provided properties.

Method Summary

Modifier and Type	Method	Description
int	getIndex()	Return the index in the batch of the failed record.
String	getMessage()
org.apache.kafka.clients.consumer.ConsumerRecord<?,?>	getRecord()	Return the failed record.

Methods inherited from class org.springframework.kafka.KafkaException

selfLog

Methods inherited from class org.springframework.core.NestedRuntimeException

contains, getMostSpecificCause, getRootCause

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

BatchListenerFailedException

public BatchListenerFailedException(String message,
 int index)

Construct an instance with the provided properties.

Parameters:

message - the message.

index - the index in the batch of the failed record.

BatchListenerFailedException

public BatchListenerFailedException(String message,
 @Nullable
 Throwable cause,
 int index)

Construct an instance with the provided properties.

Parameters:

message - the message.

cause - the cause.

index - the index in the batch of the failed record.

BatchListenerFailedException

public BatchListenerFailedException(String message,
 org.apache.kafka.clients.consumer.ConsumerRecord<?,?> record)

Construct an instance with the provided properties.

Parameters:

message - the message.

record - the failed record.

BatchListenerFailedException

public BatchListenerFailedException(String message,
 @Nullable
 Throwable cause,
 org.apache.kafka.clients.consumer.ConsumerRecord<?,?> record)

Construct an instance with the provided properties.

Parameters:

message - the message.

cause - the cause.

record - the failed record.

Method Details

getRecord

@Nullable
public org.apache.kafka.clients.consumer.ConsumerRecord<?,?> getRecord()

Return the failed record.

Returns:

the record.

getIndex

public int getIndex()

Return the index in the batch of the failed record.

Returns:

the index.

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable