org.apache.kafka.streams.errors

Interface ProductionExceptionHandler

All Superinterfaces:

org.apache.kafka.common.Configurable

All Known Implementing Classes:

DefaultProductionExceptionHandler

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

Interface that specifies how an exception when attempting to produce a result to Kafka should be handled.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ProductionExceptionHandler.ProductionExceptionHandlerResponse
static class	ProductionExceptionHandler.SerializationExceptionOrigin

Method Summary

Modifier and Type	Method and Description
default ProductionExceptionHandler.ProductionExceptionHandlerResponse	handle(ErrorHandlerContext context, org.apache.kafka.clients.producer.ProducerRecord<byte[],byte[]> record, Exception exception) Inspect a record that we attempted to produce, and the exception that resulted from attempting to produce it and determine whether or not to continue processing.
default ProductionExceptionHandler.ProductionExceptionHandlerResponse	handle(org.apache.kafka.clients.producer.ProducerRecord<byte[],byte[]> record, Exception exception) Deprecated. Since 3.9. Use handle(ErrorHandlerContext, ProducerRecord, Exception) instead.
default ProductionExceptionHandler.ProductionExceptionHandlerResponse	handleSerializationException(ErrorHandlerContext context, org.apache.kafka.clients.producer.ProducerRecord record, Exception exception, ProductionExceptionHandler.SerializationExceptionOrigin origin) Handles serialization exception and determine if the process should continue.
default ProductionExceptionHandler.ProductionExceptionHandlerResponse	handleSerializationException(org.apache.kafka.clients.producer.ProducerRecord record, Exception exception) Deprecated. Since 3.9. Use handleSerializationException(ErrorHandlerContext, ProducerRecord, Exception, SerializationExceptionOrigin) instead.

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

configure

Method Detail

handle

@Deprecated
default ProductionExceptionHandler.ProductionExceptionHandlerResponse handle(org.apache.kafka.clients.producer.ProducerRecord<byte[],byte[]> record,
                                                                                         Exception exception)

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

Inspect a record that we attempted to produce, and the exception that resulted from attempting to produce it and determine whether or not to continue processing.

Parameters:

record - The record that failed to produce

exception - The exception that occurred during production

handle

default ProductionExceptionHandler.ProductionExceptionHandlerResponse handle(ErrorHandlerContext context,
                                                                             org.apache.kafka.clients.producer.ProducerRecord<byte[],byte[]> record,
                                                                             Exception exception)

Inspect a record that we attempted to produce, and the exception that resulted from attempting to produce it and determine whether or not to continue processing.

Parameters:

context - The error handler context metadata

record - The record that failed to produce

exception - The exception that occurred during production

handleSerializationException

@Deprecated
default ProductionExceptionHandler.ProductionExceptionHandlerResponse handleSerializationException(org.apache.kafka.clients.producer.ProducerRecord record,
                                                                                                               Exception exception)

Deprecated. Since 3.9. Use handleSerializationException(ErrorHandlerContext, ProducerRecord, Exception, SerializationExceptionOrigin) instead.

Handles serialization exception and determine if the process should continue. The default implementation is to fail the process.

Parameters:

record - the record that failed to serialize

exception - the exception that occurred during serialization

handleSerializationException

default ProductionExceptionHandler.ProductionExceptionHandlerResponse handleSerializationException(ErrorHandlerContext context,
                                                                                                   org.apache.kafka.clients.producer.ProducerRecord record,
                                                                                                   Exception exception,
                                                                                                   ProductionExceptionHandler.SerializationExceptionOrigin origin)

Handles serialization exception and determine if the process should continue. The default implementation is to fail the process.

Parameters:

context - the error handler context metadata

record - the record that failed to serialize

exception - the exception that occurred during serialization

origin - the origin of the serialization exception