org.apache.kafka.streams.errors

Interface DeserializationExceptionHandler

All Superinterfaces:

org.apache.kafka.common.Configurable

All Known Implementing Classes:

LogAndContinueExceptionHandler, LogAndFailExceptionHandler

public interface DeserializationExceptionHandler
extends org.apache.kafka.common.Configurable

Interface that specifies how an exception from source node deserialization (e.g., reading from Kafka) should be handled.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DeserializationExceptionHandler.DeserializationHandlerResponse Enumeration that describes the response from the exception handler.

Method Summary

Modifier and Type	Method and Description
default DeserializationExceptionHandler.DeserializationHandlerResponse	handle(ErrorHandlerContext context, org.apache.kafka.clients.consumer.ConsumerRecord<byte[],byte[]> record, Exception exception) Inspect a record and the exception received.
default DeserializationExceptionHandler.DeserializationHandlerResponse	handle(ProcessorContext context, org.apache.kafka.clients.consumer.ConsumerRecord<byte[],byte[]> record, Exception exception) Deprecated. Since 3.9. Use handle(ErrorHandlerContext, ConsumerRecord, Exception) instead.

Methods inherited from interface org.apache.kafka.common.Configurable

configure

Method Detail

handle

@Deprecated
default DeserializationExceptionHandler.DeserializationHandlerResponse handle(ProcessorContext context,
                                                                                          org.apache.kafka.clients.consumer.ConsumerRecord<byte[],byte[]> record,
                                                                                          Exception exception)

Deprecated. Since 3.9. Use handle(ErrorHandlerContext, ConsumerRecord, Exception) instead.

Inspect a record and the exception received.

Note, that the passed in ProcessorContext only allows to access metadata like the task ID. However, it cannot be used to emit records via ProcessorContext.forward(Object, Object); calling forward() (and some other methods) would result in a runtime exception.

Parameters:

context - processor context

record - record that failed deserialization

exception - the actual exception

handle

default DeserializationExceptionHandler.DeserializationHandlerResponse handle(ErrorHandlerContext context,
                                                                              org.apache.kafka.clients.consumer.ConsumerRecord<byte[],byte[]> record,
                                                                              Exception exception)

Inspect a record and the exception received.

Parameters:

context - error handler context

record - record that failed deserialization

exception - the actual exception