org.mule.runtime.core.exception

Class ErrorTypeLocator

java.lang.Object

org.mule.runtime.core.exception.ErrorTypeLocator

public class ErrorTypeLocator
extends Object

Locator for error types. The locator is responsible for getting the error type of any exception. An exception can be a general exception or an exception thrown by a configured component. There's a default mapping that will be used when there's no specific mapping between a component and the exception type thrown. To create an ErrorTypeLocator you must use the Builder. An instance of the builder can be created using the static method #builder.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorTypeLocator.Builder Builder for ErrorTypeLocator

Method Summary

Modifier and Type	Method and Description
void	addComponentExceptionMapper(org.mule.runtime.api.component.ComponentIdentifier componentIdentifier, ExceptionMapper exceptionMapper) Adds an ExceptionMapper for a particular component identified by a ComponentIdentifier.
static ErrorTypeLocator.Builder	builder(ErrorTypeRepository errorTypeRepository) Builder for creating instances of ErrorTypeLocator.
org.mule.runtime.api.message.ErrorType	lookupComponentErrorType(org.mule.runtime.api.component.ComponentIdentifier componentIdentifier, Class<? extends Throwable> exception) Finds the ErrorType related to a component defined by the ComponentIdentifier based on the exception thrown by the component and the mappings configured in the ErrorTypeLocator.
org.mule.runtime.api.message.ErrorType	lookupComponentErrorType(org.mule.runtime.api.component.ComponentIdentifier componentIdentifier, Throwable exception) Finds the ErrorType related to a component defined by the ComponentIdentifier based on the exception thrown by the component and the mappings configured in the ErrorTypeLocator.
org.mule.runtime.api.message.ErrorType	lookupErrorType(Class<? extends Throwable> type) Finds the ErrorType related to the provided exception based on the general mapping rules of the runtime.
org.mule.runtime.api.message.ErrorType	lookupErrorType(Throwable exception) Finds the ErrorType related to the provided exception based on the general mapping rules of the runtime.

Methods inherited from class java.lang.Object

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

Method Detail

lookupErrorType

public org.mule.runtime.api.message.ErrorType lookupErrorType(Throwable exception)

Finds the ErrorType related to the provided exception based on the general mapping rules of the runtime.

Parameters:

exception - the exception related to the error type

Returns:

the error type related to the exception. If there's no mapping then the error type related to UNKNOWN will be returned.

lookupErrorType

public org.mule.runtime.api.message.ErrorType lookupErrorType(Class<? extends Throwable> type)

Finds the ErrorType related to the provided exception based on the general mapping rules of the runtime.

Parameters:

type - the exception Class related to the error type

Returns:

the error type related to the exception. If there's no mapping then the error type related to UNKNOWN will be returned.

lookupComponentErrorType

public org.mule.runtime.api.message.ErrorType lookupComponentErrorType(org.mule.runtime.api.component.ComponentIdentifier componentIdentifier,
                                                                       Class<? extends Throwable> exception)

Finds the ErrorType related to a component defined by the ComponentIdentifier based on the exception thrown by the component and the mappings configured in the ErrorTypeLocator. If no mapping is available then the lookupErrorType(Throwable) rules applies.

Parameters:

componentIdentifier - the identifier of the component that throw the exception.

exception - the exception thrown by the component.

Returns:

the error type related to the exception based on the component mappings. If there's no mapping then the error type related to UNKNOWN will be returned.

lookupComponentErrorType

public org.mule.runtime.api.message.ErrorType lookupComponentErrorType(org.mule.runtime.api.component.ComponentIdentifier componentIdentifier,
                                                                       Throwable exception)

Finds the ErrorType related to a component defined by the ComponentIdentifier based on the exception thrown by the component and the mappings configured in the ErrorTypeLocator. If no mapping is available then the lookupErrorType(Throwable) rules applies.

Parameters:

componentIdentifier - the identifier of the component that throw the exception.

exception - the exception thrown by the component.

Returns:

the error type related to the exception based on the component mappings. If there's no mapping then the error type related to UNKNOWN will be returned.

addComponentExceptionMapper

public void addComponentExceptionMapper(org.mule.runtime.api.component.ComponentIdentifier componentIdentifier,
                                        ExceptionMapper exceptionMapper)

Adds an ExceptionMapper for a particular component identified by a ComponentIdentifier.

Parameters:

componentIdentifier - identifier of a component.

exceptionMapper - exception mapper for the component.

builder

public static ErrorTypeLocator.Builder builder(ErrorTypeRepository errorTypeRepository)

Builder for creating instances of ErrorTypeLocator.

Parameters:

errorTypeRepository - repository of error types.

Returns:

a builder for creating an ErrorTypeLocator