org.mule.runtime.api.message

Interface Error

All Superinterfaces:

Serializable

@NoImplement
public interface Error
extends Serializable

Method Summary

Modifier and Type	Method and Description
Throwable	getCause() The Java exception thrown by the failing component.
List<Error>	getChildErrors() Lists any child Errors, if any.
String	getDescription() Concise description of the error.
String	getDetailedDescription() Detailed description of the error.
Message	getErrorMessage() This is an error response generated by the component that failed to process the message.
ErrorType	getErrorType() Returns the type of the error.
default String	getFailingComponent()

Method Detail

getDescription

String getDescription()

Concise description of the error. For more information getDetailedDescription()

Returns:

a concise description of the error.

getDetailedDescription

String getDetailedDescription()

Detailed description of the error. This message may include Java exception specific information.

Returns:

a details description of the error.

getFailingComponent

default String getFailingComponent()

Returns:

The component where this error was generated

Since:

1.3

getErrorType

ErrorType getErrorType()

Returns the type of the error. @see ErrorType.

Returns:

the type of the error

getCause

Throwable getCause()

The Java exception thrown by the failing component.

Returns:

the exception thrown by the failing component.

getErrorMessage

Message getErrorMessage()

This is an error response generated by the component that failed to process the message. For instance, HTTP connector may generate an error response with the content of the HTTP response if the failure was because of an invalid status code. Not all failing components generate an error response so this field may be null.

Returns:

the message with the error data.

getChildErrors

List<Error> getChildErrors()

Lists any child Errors, if any. For instance, the scatter-gather router may throw an error aggregating all of its routes errors as children. Not all failing components aggregate errors so this may return an empty collection.

Returns:

a list with all the aggregated errors