org.mule.runtime.core.exception

Class ErrorTypeRepository

java.lang.Object

org.mule.runtime.core.exception.ErrorTypeRepository

public class ErrorTypeRepository
extends Object

Repository for the different ErrorTypes in a mule artifact. Only one instance of ErrorType must exists describing the same combination of error identifier and namespace.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.mule.runtime.api.message.ErrorType	ANY_ERROR_TYPE Error type that represents all of them that can be handled.
protected static org.mule.runtime.api.message.ErrorType	CRITICAL_ERROR_TYPE Error type for which there will be no handling since it represents an error so critical it should not be handled.
protected static org.mule.runtime.api.message.ErrorType	SOURCE_ERROR_TYPE Parent error type for errors that occur on the source of a flow.
protected static org.mule.runtime.api.message.ErrorType	SOURCE_RESPONSE_ERROR_TYPE Parent error type for errors that occur in a source processing a successful response of a flow.
protected static org.mule.runtime.api.message.ErrorType	UNKNOWN_ERROR_TYPE Error type for which there's no clear reason for failure.

Constructor Summary

Constructors

Constructor and Description
ErrorTypeRepository()

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.message.ErrorType	addErrorType(org.mule.runtime.api.component.ComponentIdentifier errorTypeIdentifier, org.mule.runtime.api.message.ErrorType parentErrorType) Adds and returns an ErrorType for a given identifier with the given parent that will be fully visible, meaning it will be available for use in on-error components.
org.mule.runtime.api.message.ErrorType	addInternalErrorType(org.mule.runtime.api.component.ComponentIdentifier errorTypeIdentifier, org.mule.runtime.api.message.ErrorType parentErrorType) Adds and returns an ErrorType for a given identifier with the given parent that will be only used internally, meaning it won't be available for use in on-error components.
org.mule.runtime.api.message.ErrorType	getAnyErrorType() Gets the ErrorType instance for ANY error type.
org.mule.runtime.api.message.ErrorType	getCriticalErrorType() Gets the ErrorType instance for CRITICAL error type.
Optional<org.mule.runtime.api.message.ErrorType>	getErrorType(org.mule.runtime.api.component.ComponentIdentifier errorTypeIdentifier) Returns the specified error's type if present.
org.mule.runtime.api.message.ErrorType	getSourceErrorType() Gets the ErrorType instance for SOURCE error type.
org.mule.runtime.api.message.ErrorType	getSourceResponseErrorType() Gets the ErrorType instance for SOURCE_RESPONSE error type.
Optional<org.mule.runtime.api.message.ErrorType>	lookupErrorType(org.mule.runtime.api.component.ComponentIdentifier errorTypeComponentIdentifier) Looks up the specified error's type and returns it if found and available for general use (error handling).

Methods inherited from class java.lang.Object

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

Field Detail

ANY_ERROR_TYPE

protected static final org.mule.runtime.api.message.ErrorType ANY_ERROR_TYPE

Error type that represents all of them that can be handled.

SOURCE_ERROR_TYPE

protected static final org.mule.runtime.api.message.ErrorType SOURCE_ERROR_TYPE

Parent error type for errors that occur on the source of a flow.

SOURCE_RESPONSE_ERROR_TYPE

protected static final org.mule.runtime.api.message.ErrorType SOURCE_RESPONSE_ERROR_TYPE

Parent error type for errors that occur in a source processing a successful response of a flow.

UNKNOWN_ERROR_TYPE

protected static final org.mule.runtime.api.message.ErrorType UNKNOWN_ERROR_TYPE

Error type for which there's no clear reason for failure. Will be used when no specific match is found.

CRITICAL_ERROR_TYPE

protected static final org.mule.runtime.api.message.ErrorType CRITICAL_ERROR_TYPE

Error type for which there will be no handling since it represents an error so critical it should not be handled. If such an error occurs it will always be propagated. Same for it's children.

Constructor Detail

ErrorTypeRepository

public ErrorTypeRepository()

Method Detail

addErrorType

public org.mule.runtime.api.message.ErrorType addErrorType(org.mule.runtime.api.component.ComponentIdentifier errorTypeIdentifier,
                                                           org.mule.runtime.api.message.ErrorType parentErrorType)

Adds and returns an ErrorType for a given identifier with the given parent that will be fully visible, meaning it will be available for use in on-error components.

Parameters:

errorTypeIdentifier - the ComponentIdentifier for the error

parentErrorType - the ErrorType that will act as parent

Returns:

the created ErrorType

addInternalErrorType

public org.mule.runtime.api.message.ErrorType addInternalErrorType(org.mule.runtime.api.component.ComponentIdentifier errorTypeIdentifier,
                                                                   org.mule.runtime.api.message.ErrorType parentErrorType)

Adds and returns an ErrorType for a given identifier with the given parent that will be only used internally, meaning it won't be available for use in on-error components.

Parameters:

errorTypeIdentifier - the ComponentIdentifier for the error

parentErrorType - the ErrorType that will act as parent

Returns:

the created ErrorType

lookupErrorType

public Optional<org.mule.runtime.api.message.ErrorType> lookupErrorType(org.mule.runtime.api.component.ComponentIdentifier errorTypeComponentIdentifier)

Looks up the specified error's type and returns it if found and available for general use (error handling).

Parameters:

errorTypeComponentIdentifier - the ComponentIdentifier for the error

Returns:

an Optional with the corresponding ErrorType or an empty one

getErrorType

public Optional<org.mule.runtime.api.message.ErrorType> getErrorType(org.mule.runtime.api.component.ComponentIdentifier errorTypeIdentifier)

Returns the specified error's type if present. Unlike lookupErrorType(ComponentIdentifier), this will return the ErrorType even if it's not available for general use (error handling).

Parameters:

errorTypeIdentifier - the ComponentIdentifier for the error

Returns:

an Optional with the corresponding ErrorType or an empty one

getAnyErrorType

public org.mule.runtime.api.message.ErrorType getAnyErrorType()

Gets the ErrorType instance for ANY error type.

Returns:

the ANY error type

getSourceErrorType

public org.mule.runtime.api.message.ErrorType getSourceErrorType()

Gets the ErrorType instance for SOURCE error type.

Returns:

the SOURCE error type

getSourceResponseErrorType

public org.mule.runtime.api.message.ErrorType getSourceResponseErrorType()

Gets the ErrorType instance for SOURCE_RESPONSE error type.

Returns:

the SOURCE_RESPONSE error type

getCriticalErrorType

public org.mule.runtime.api.message.ErrorType getCriticalErrorType()

Gets the ErrorType instance for CRITICAL error type.

Returns:

the CRITICAL error type