com.mulesoft.connectivity.rest.commons.api.error

Enum RestError

java.lang.Object

java.lang.Enum<RestError>

com.mulesoft.connectivity.rest.commons.api.error.RestError

All Implemented Interfaces:

Serializable, Comparable<RestError>, org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError>

public enum RestError
extends Enum<RestError>
implements org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError>

Represents an error that can happen in an HTTP operation.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_REQUEST
CLIENT_ERROR
CONNECTIVITY
INTERNAL_SERVER_ERROR
NOT_ACCEPTABLE
NOT_FOUND
SERVER_ERROR
SERVICE_UNAVAILABLE
TIMEOUT
TOO_MANY_REQUESTS
UNAUTHORIZED
UNSUPPORTED_MEDIA_TYPE

Method Summary

Modifier and Type	Method and Description
static Optional<RestError>	getErrorByCode(int statusCode) Returns the RestError corresponding to a given status code.
String	getErrorMessage(org.mule.runtime.http.api.domain.message.request.HttpRequest request) Returns the custom error message for this RestError based on the HttpRequest that triggered it.
static Optional<org.mule.runtime.http.api.HttpConstants.HttpStatus>	getHttpStatus(RestError error) Returns an HttpConstants.HttpStatus corresponding to a given RestError.
Optional<org.mule.runtime.extension.api.error.ErrorTypeDefinition<? extends Enum<?>>>	getParent()
static RestError	valueOf(String name) Returns the enum constant of this type with the specified name.
static RestError[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.mule.runtime.extension.api.error.ErrorTypeDefinition

getType

Enum Constant Detail

CONNECTIVITY

public static final RestError CONNECTIVITY

CLIENT_ERROR

public static final RestError CLIENT_ERROR

TIMEOUT

public static final RestError TIMEOUT

UNAUTHORIZED

public static final RestError UNAUTHORIZED

NOT_FOUND

public static final RestError NOT_FOUND

TOO_MANY_REQUESTS

public static final RestError TOO_MANY_REQUESTS

BAD_REQUEST

public static final RestError BAD_REQUEST

UNSUPPORTED_MEDIA_TYPE

public static final RestError UNSUPPORTED_MEDIA_TYPE

NOT_ACCEPTABLE

public static final RestError NOT_ACCEPTABLE

SERVER_ERROR

public static final RestError SERVER_ERROR

INTERNAL_SERVER_ERROR

public static final RestError INTERNAL_SERVER_ERROR

SERVICE_UNAVAILABLE

public static final RestError SERVICE_UNAVAILABLE

Method Detail

values

public static RestError[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RestError c : RestError.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RestError valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getParent

public Optional<org.mule.runtime.extension.api.error.ErrorTypeDefinition<? extends Enum<?>>> getParent()

Specified by:

getParent in interface org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError>

getErrorByCode

public static Optional<RestError> getErrorByCode(int statusCode)

Returns the RestError corresponding to a given status code. A match is found if there's an RestError with the same name as the status code's corresponding HttpConstants.HttpStatus.

Parameters:

statusCode - the HTTP status code to search for

Returns:

an Optional with the error that matches the statusCode

getHttpStatus

public static Optional<org.mule.runtime.http.api.HttpConstants.HttpStatus> getHttpStatus(RestError error)

Returns an HttpConstants.HttpStatus corresponding to a given RestError. A match is found if there's an HttpConstants.HttpStatus with the same name as the RestError.

Parameters:

error - the RestError to match

Returns:

an Optional with the status that matches the error

getErrorMessage

public String getErrorMessage(org.mule.runtime.http.api.domain.message.request.HttpRequest request)

Returns the custom error message for this RestError based on the HttpRequest that triggered it.

Parameters:

request - the HttpRequest that caused the error

Returns:

the custom error message associated to the error