org.mule.runtime.api.exception

Class ExceptionHelper

java.lang.Object

org.mule.runtime.api.exception.ExceptionHelper

public class ExceptionHelper
extends Object

ExceptionHelper provides a number of helper functions that can be useful for dealing with Mule exceptions. This class has 3 core functions -

1. ErrorCode lookup. A corresponding Mule error code can be found using for a given Mule exception 2. Additional Error information such as Java doc url for a given exception can be resolved using this class 3. Error code mappings can be looked up by providing the the protocol to map to and the Mule exception.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	DEFAULT_STACKTRACE_FILTER
static String[]	stackTraceFilter A comma-separated list of internal packages/classes which are removed from sanitized stacktraces.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExceptionHelper() Do not instantiate.

Method Summary

Modifier and Type	Method and Description
static Map<String,Object>	getExceptionInfo(Throwable t)
static ExceptionReader	getExceptionReader(Throwable t) Gets an exception reader for the exception.
static List<Throwable>	getExceptionsAsList(Throwable t)
static String	getExceptionStack(Throwable t)
static Throwable	getNonMuleException(Throwable t)
static Throwable	getRootException(Throwable t)
static MuleException	getRootMuleException(Throwable t)
static void	registerExceptionReader(ExceptionReader reader) Registers an exception reader on the Mule Runtime to be used only by the artifact it belongs to
static void	registerGlobalExceptionReader(ExceptionReader reader) Registers an exception reader on the Mule Runtime.
static Throwable	sanitize(Throwable t) Removes some internal Mule entries from the stacktrace.
static Throwable	summarise(Throwable t, int depth) Removes some internal Mule entries from the stacktrace.
static boolean	unregisterExceptionReader(ExceptionReader reader) Unregisters an exception reader from the Mule Runtime
static <T extends Throwable> T	unwrap(T t)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_STACKTRACE_FILTER

public static final String[] DEFAULT_STACKTRACE_FILTER

stackTraceFilter

public static String[] stackTraceFilter

A comma-separated list of internal packages/classes which are removed from sanitized stacktraces. Matching is done via string.startsWith().

See Also:

#fullStackTraces

Constructor Detail

ExceptionHelper

protected ExceptionHelper()

Do not instantiate.

Method Detail

unwrap

public static <T extends Throwable> T unwrap(T t)

getExceptionReader

public static ExceptionReader getExceptionReader(Throwable t)

Gets an exception reader for the exception. The currentThread's ClassLoader is used to determine the appropriate reader, querying only those registered by the same or an ancestor classloader.

Parameters:

t - the exception to get a reader for

Returns:

either a specific reader or an instance of DefaultExceptionReader. This method never returns null;

getRootMuleException

public static MuleException getRootMuleException(Throwable t)

getNonMuleException

public static Throwable getNonMuleException(Throwable t)

getExceptionInfo

public static Map<String,Object> getExceptionInfo(Throwable t)

getRootException

public static Throwable getRootException(Throwable t)

getExceptionStack

public static String getExceptionStack(Throwable t)

sanitize

public static Throwable sanitize(Throwable t)

Removes some internal Mule entries from the stacktrace. Modifies the passed-in throwable stacktrace.

summarise

public static Throwable summarise(Throwable t,
                                  int depth)

Removes some internal Mule entries from the stacktrace. Modifies the passed-in throwable stacktrace.

getExceptionsAsList

public static List<Throwable> getExceptionsAsList(Throwable t)

Parameters:

t -

Returns:

t and its recursive causes, ordered from outer to inner.

registerGlobalExceptionReader

public static void registerGlobalExceptionReader(ExceptionReader reader)

Registers an exception reader on the Mule Runtime.

Only the Runtime itself may register global readers.

Parameters:

reader - the reader to register.

registerExceptionReader

public static void registerExceptionReader(ExceptionReader reader)

Registers an exception reader on the Mule Runtime to be used only by the artifact it belongs to

Parameters:

reader - the reader to register.

unregisterExceptionReader

public static boolean unregisterExceptionReader(ExceptionReader reader)

Unregisters an exception reader from the Mule Runtime

Parameters:

reader - the reader to register.

Returns:

true if the passed reader is registered