Package org.springframework.kafka.listener

Class ListenerExecutionFailedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.core.NestedRuntimeException

org.springframework.kafka.KafkaException

org.springframework.kafka.listener.ListenerExecutionFailedException

All Implemented Interfaces:

java.io.Serializable

public class ListenerExecutionFailedException
extends KafkaException

The listener specific KafkaException extension.

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
ListenerExecutionFailedException(java.lang.String message)	Construct an instance with the provided properties.
ListenerExecutionFailedException(java.lang.String message, java.lang.String groupId, java.lang.Throwable cause)	Construct an instance with the provided properties.
ListenerExecutionFailedException(java.lang.String message, java.lang.Throwable cause)	Construct an instance with the provided properties.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getGroupId()	Return the consumer group.id property of the container that threw this exception.

Methods inherited from class org.springframework.kafka.KafkaException

selfLog

Methods inherited from class org.springframework.core.NestedRuntimeException

contains, getMessage, 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 Detail

ListenerExecutionFailedException

public ListenerExecutionFailedException(java.lang.String message)

Construct an instance with the provided properties.

Parameters:

message - the exception message.

ListenerExecutionFailedException

public ListenerExecutionFailedException(java.lang.String message,
                                        @Nullable
                                        java.lang.Throwable cause)

Construct an instance with the provided properties.

Parameters:

message - the exception message.

cause - the cause.

ListenerExecutionFailedException

public ListenerExecutionFailedException(java.lang.String message,
                                        @Nullable
                                        java.lang.String groupId,
                                        @Nullable
                                        java.lang.Throwable cause)

Construct an instance with the provided properties.

Parameters:

message - the exception message.

groupId - the container's group.id property.

cause - the cause.

Since:

2.2.4

Method Detail

getGroupId

@Nullable
public java.lang.String getGroupId()

Return the consumer group.id property of the container that threw this exception.

Returns:

the group id; may be null, but not when the exception is passed to an error handler by a listener container.

Since:

2.2.4