org.mule.runtime.api.exception

Interface ErrorTypeRepository

@NoImplement
public interface ErrorTypeRepository

Method Summary

Modifier and Type	Method and Description
ErrorType	addErrorType(ComponentIdentifier errorTypeIdentifier, 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.
ErrorType	addInternalErrorType(ComponentIdentifier errorTypeIdentifier, 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.
ErrorType	getAnyErrorType() Gets the ErrorType instance for ANY error type.
ErrorType	getCriticalErrorType() Gets the ErrorType instance for CRITICAL error type.
Collection<String>	getErrorNamespaces() Returns the collection of current error namespaces.
Optional<ErrorType>	getErrorType(ComponentIdentifier errorTypeIdentifier) Returns the specified error's type if present.
Set<ErrorType>	getErrorTypes() Gets the ErrorType instances for handleable errors available in this repository.
Set<ErrorType>	getInternalErrorTypes() Gets the ErrorType instances for un-handleable errors available in this repository.
ErrorType	getSourceErrorType() Gets the ErrorType instance for SOURCE error type.
ErrorType	getSourceResponseErrorType() Gets the ErrorType instance for SOURCE_RESPONSE error type.
Optional<ErrorType>	lookupErrorType(ComponentIdentifier errorTypeComponentIdentifier) Looks up the specified error's type and returns it if found and available for general use (error handling).

Method Detail

addErrorType

ErrorType addErrorType(ComponentIdentifier errorTypeIdentifier,
                       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

ErrorType addInternalErrorType(ComponentIdentifier errorTypeIdentifier,
                               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

Optional<ErrorType> lookupErrorType(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

Optional<ErrorType> getErrorType(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

getErrorNamespaces

Collection<String> getErrorNamespaces()

Returns the collection of current error namespaces.

Returns:

a collection of all present namespaces

getAnyErrorType

ErrorType getAnyErrorType()

Gets the ErrorType instance for ANY error type.

Returns:

the ANY error type

getSourceErrorType

ErrorType getSourceErrorType()

Gets the ErrorType instance for SOURCE error type.

Returns:

the SOURCE error type

getSourceResponseErrorType

ErrorType getSourceResponseErrorType()

Gets the ErrorType instance for SOURCE_RESPONSE error type.

Returns:

the SOURCE_RESPONSE error type

getCriticalErrorType

ErrorType getCriticalErrorType()

Gets the ErrorType instance for CRITICAL error type.

Returns:

the CRITICAL error type

getErrorTypes

Set<ErrorType> getErrorTypes()

Gets the ErrorType instances for handleable errors available in this repository.

Returns:

all the available error types.

Since:

1.4

getInternalErrorTypes

Set<ErrorType> getInternalErrorTypes()

Gets the ErrorType instances for un-handleable errors available in this repository.

Returns:

all the available error types.

Since:

1.4