Package io.awspring.cloud.sqs.listener

Class ListenerExecutionFailedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.awspring.cloud.sqs.listener.ListenerExecutionFailedException

All Implemented Interfaces:

MessageProcessingException, Serializable

public class ListenerExecutionFailedException
extends RuntimeException
implements MessageProcessingException

Exception thrown when the AsyncMessageListener completes with an exception. Contains the Message instance or instances which execution failed, as well as some convenience methods for handling such messages.

Since:

3.0

Author:

Tomaz Fernandes

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ListenerExecutionFailedException(String message, Throwable cause, Collection<Message<T>> failedMessages)
ListenerExecutionFailedException(String message, Throwable cause, Message<?> failedMessage)

Method Summary

Modifier and Type	Method	Description
Message<?>	getFailedMessage()	Return the message which listener execution failed.
Collection<Message<?>>	getFailedMessages()	Return the messages which listener execution failed.
static boolean	hasListenerException(Throwable t)	Deprecated. use MessageProcessingException.hasProcessingException(Throwable) instead.
static <T> @Nullable Message<T>	unwrapMessage(Throwable t)	Deprecated. use MessageProcessingException.unwrapMessage(Throwable) instead.
static <T> @Nullable Collection<Message<T>>	unwrapMessages(Throwable t)	Deprecated. use MessageProcessingException.unwrapMessages(Throwable) instead.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

ListenerExecutionFailedException

public ListenerExecutionFailedException(String message,
 Throwable cause,
 Message<?> failedMessage)

ListenerExecutionFailedException

public ListenerExecutionFailedException(String message,
 Throwable cause,
 Collection<Message<T>> failedMessages)

Method Details

getFailedMessage

public Message<?> getFailedMessage()

Return the message which listener execution failed.

Returns:

the message.

getFailedMessages

public Collection<Message<?>> getFailedMessages()

Return the messages which listener execution failed.

Specified by:

getFailedMessages in interface MessageProcessingException

Returns:

the messages.

unwrapMessage

@Deprecated
public static <T> @Nullable Message<T> unwrapMessage(Throwable t)

Deprecated.

use MessageProcessingException.unwrapMessage(Throwable) instead.

Look for a potentially nested MessageProcessingException in the cause chain and if found return the wrapped Message instance.

Type Parameters:

T - the message type.

Parameters:

t - the throwable

Returns:

the message.

unwrapMessages

@Deprecated
public static <T> @Nullable Collection<Message<T>> unwrapMessages(Throwable t)

Deprecated.

use MessageProcessingException.unwrapMessages(Throwable) instead.

Look for a potentially nested MessageProcessingException in the cause chain and if found return the wrapped Message instances.

Type Parameters:

T - the message type.

Parameters:

t - the throwable

Returns:

the messages.

hasListenerException

@Deprecated
public static boolean hasListenerException(Throwable t)

Deprecated.

use MessageProcessingException.hasProcessingException(Throwable) instead.

Check whether a MessageProcessingException is present anywhere in the cause chain of t.

Parameters:

t - the throwable.

Returns:

whether a MessageProcessingException is present.