Package org.springframework.web.reactive.function.client

Class WebClientResponseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.core.NestedRuntimeException

org.springframework.web.reactive.function.client.WebClientException

org.springframework.web.reactive.function.client.WebClientResponseException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

UnknownHttpStatusCodeException, WebClientResponseException.BadGateway, WebClientResponseException.BadRequest, WebClientResponseException.Conflict, WebClientResponseException.Forbidden, WebClientResponseException.GatewayTimeout, WebClientResponseException.Gone, WebClientResponseException.InternalServerError, WebClientResponseException.MethodNotAllowed, WebClientResponseException.NotAcceptable, WebClientResponseException.NotFound, WebClientResponseException.NotImplemented, WebClientResponseException.ServiceUnavailable, WebClientResponseException.TooManyRequests, WebClientResponseException.Unauthorized, WebClientResponseException.UnprocessableEntity, WebClientResponseException.UnsupportedMediaType

public class WebClientResponseException
extends WebClientException

Exceptions that contain actual HTTP response data.

Since:

5.0

Author:

Arjen Poutsma, Sebastien Deleuze

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebClientResponseException.BadGateway	WebClientResponseException for HTTP status 502 Bad Gateway.
static class	WebClientResponseException.BadRequest	WebClientResponseException for status HTTP 400 Bad Request.
static class	WebClientResponseException.Conflict	WebClientResponseException for status HTTP 409 Conflict.
static class	WebClientResponseException.Forbidden	WebClientResponseException for status HTTP 403 Forbidden.
static class	WebClientResponseException.GatewayTimeout	WebClientResponseException for status HTTP 504 Gateway Timeout.
static class	WebClientResponseException.Gone	WebClientResponseException for status HTTP 410 Gone.
static class	WebClientResponseException.InternalServerError	WebClientResponseException for status HTTP 500 Internal Server Error.
static class	WebClientResponseException.MethodNotAllowed	WebClientResponseException for status HTTP 405 Method Not Allowed.
static class	WebClientResponseException.NotAcceptable	WebClientResponseException for status HTTP 406 Not Acceptable.
static class	WebClientResponseException.NotFound	WebClientResponseException for status HTTP 404 Not Found.
static class	WebClientResponseException.NotImplemented	WebClientResponseException for status HTTP 501 Not Implemented.
static class	WebClientResponseException.ServiceUnavailable	WebClientResponseException for status HTTP 503 Service Unavailable.
static class	WebClientResponseException.TooManyRequests	WebClientResponseException for status HTTP 429 Too Many Requests.
static class	WebClientResponseException.Unauthorized	WebClientResponseException for status HTTP 401 Unauthorized.
static class	WebClientResponseException.UnprocessableEntity	WebClientResponseException for status HTTP 422 Unprocessable Entity.
static class	WebClientResponseException.UnsupportedMediaType	WebClientResponseException for status HTTP 415 Unsupported Media Type.

Constructor Summary

Constructors

Constructor	Description
WebClientResponseException(int statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset)	Constructor with response data only, and a default message.
WebClientResponseException(int status, String reasonPhrase, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request)	Constructor with response data only, and a default message.
WebClientResponseException(String message, int statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset charset)	Constructor with a prepared message.
WebClientResponseException(String message, int statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset charset, HttpRequest request)	Constructor with a prepared message.
WebClientResponseException(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset charset, HttpRequest request)	Constructor with a prepared message.
WebClientResponseException(HttpStatusCode statusCode, String reasonPhrase, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request)	Constructor with response data only, and a default message.

Method Summary

Modifier and Type	Method	Description
static WebClientResponseException	create(int statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset)	Create WebClientResponseException or an HTTP status specific subclass.
static WebClientResponseException	create(int statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request)	Create WebClientResponseException or an HTTP status specific subclass.
static WebClientResponseException	create(HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request)	Create WebClientResponseException or an HTTP status specific subclass.
HttpHeaders	getHeaders()	Return the HTTP response headers.
String	getMessage()
int	getRawStatusCode()	Deprecated. in favor of getStatusCode(), for removal in 7.0
HttpRequest	getRequest()	Return the corresponding request.
<E> E	getResponseBodyAs(Class<E> targetType)	Decode the error content to the specified type.
<E> E	getResponseBodyAs(ParameterizedTypeReference<E> targetType)	Variant of getResponseBodyAs(Class) with ParameterizedTypeReference.
byte[]	getResponseBodyAsByteArray()	Return the response body as a byte array.
String	getResponseBodyAsString()	Return the response content as a String using the charset of media type for the response, if available, or otherwise falling back on UTF-8.
String	getResponseBodyAsString(Charset defaultCharset)	Variant of getResponseBodyAsString() that allows specifying the charset to fall back on, if a charset is not available from the media type for the response.
HttpStatusCode	getStatusCode()	Return the HTTP status code value.
String	getStatusText()	Return the HTTP status text.
void	setBodyDecodeFunction(Function<ResolvableType,?> decoderFunction)	Provide a function to find a decoder the given target type.

Methods inherited from class org.springframework.core.NestedRuntimeException

contains, getMostSpecificCause, getRootCause

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

WebClientResponseException

public WebClientResponseException(int statusCode,
 String statusText,
 @Nullable
 HttpHeaders headers,
 @Nullable
 byte[] body,
 @Nullable
 Charset charset)

Constructor with response data only, and a default message.

Since:

5.1

WebClientResponseException

public WebClientResponseException(int status,
 String reasonPhrase,
 @Nullable
 HttpHeaders headers,
 @Nullable
 byte[] body,
 @Nullable
 Charset charset,
 @Nullable
 HttpRequest request)

Constructor with response data only, and a default message.

Since:

5.1.4

WebClientResponseException

public WebClientResponseException(HttpStatusCode statusCode,
 String reasonPhrase,
 @Nullable
 HttpHeaders headers,
 @Nullable
 byte[] body,
 @Nullable
 Charset charset,
 @Nullable
 HttpRequest request)

Constructor with response data only, and a default message.

Since:

6.0

WebClientResponseException

public WebClientResponseException(String message,
 int statusCode,
 String statusText,
 @Nullable
 HttpHeaders headers,
 @Nullable
 byte[] responseBody,
 @Nullable
 Charset charset)

Constructor with a prepared message.

WebClientResponseException

public WebClientResponseException(String message,
 int statusCode,
 String statusText,
 @Nullable
 HttpHeaders headers,
 @Nullable
 byte[] responseBody,
 @Nullable
 Charset charset,
 @Nullable
 HttpRequest request)

Constructor with a prepared message.

Since:

5.1.4

WebClientResponseException

public WebClientResponseException(String message,
 HttpStatusCode statusCode,
 String statusText,
 @Nullable
 HttpHeaders headers,
 @Nullable
 byte[] responseBody,
 @Nullable
 Charset charset,
 @Nullable
 HttpRequest request)

Constructor with a prepared message.

Since:

6.0

Method Details

getStatusCode

public HttpStatusCode getStatusCode()

Return the HTTP status code value.

Throws:

IllegalArgumentException - in case of an unknown HTTP status code

getRawStatusCode

@Deprecated(since="6.0")
public int getRawStatusCode()

Deprecated.

in favor of getStatusCode(), for removal in 7.0

Return the raw HTTP status code value.

getStatusText

public String getStatusText()

Return the HTTP status text.

getHeaders

public HttpHeaders getHeaders()

Return the HTTP response headers.

getResponseBodyAsByteArray

public byte[] getResponseBodyAsByteArray()

Return the response body as a byte array.

getResponseBodyAsString

public String getResponseBodyAsString()

Return the response content as a String using the charset of media type for the response, if available, or otherwise falling back on UTF-8. Use getResponseBodyAsString(Charset) if you want to fall back on a different, default charset.

getResponseBodyAsString

public String getResponseBodyAsString(Charset defaultCharset)

Variant of getResponseBodyAsString() that allows specifying the charset to fall back on, if a charset is not available from the media type for the response.

Parameters:

defaultCharset - the charset to use if the Content-Type of the response does not specify one.

Since:

5.3.7

getResponseBodyAs

@Nullable
public <E> E getResponseBodyAs(Class<E> targetType)

Decode the error content to the specified type.

Type Parameters:

E - the expected target type

Parameters:

targetType - the type to decode to

Returns:

the decoded content, or null if there is no content

Throws:

IllegalStateException - if a Decoder cannot be found

DecodingException - if decoding fails

Since:

6.0

getResponseBodyAs

@Nullable
public <E> E getResponseBodyAs(ParameterizedTypeReference<E> targetType)

Variant of getResponseBodyAs(Class) with ParameterizedTypeReference.

Since:

6.0

getRequest

@Nullable
public HttpRequest getRequest()

Return the corresponding request.

Since:

5.1.4

setBodyDecodeFunction

public void setBodyDecodeFunction(Function<ResolvableType,?> decoderFunction)

Provide a function to find a decoder the given target type. For use with getResponseBodyAs(Class).

Parameters:

decoderFunction - the function to find a decoder with

Since:

6.0

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

create

public static WebClientResponseException create(int statusCode,
 String statusText,
 HttpHeaders headers,
 byte[] body,
 @Nullable
 Charset charset)

Create WebClientResponseException or an HTTP status specific subclass.

Since:

5.1

create

public static WebClientResponseException create(int statusCode,
 String statusText,
 HttpHeaders headers,
 byte[] body,
 @Nullable
 Charset charset,
 @Nullable
 HttpRequest request)

Create WebClientResponseException or an HTTP status specific subclass.

Since:

5.1.4

create

public static WebClientResponseException create(HttpStatusCode statusCode,
 String statusText,
 HttpHeaders headers,
 byte[] body,
 @Nullable
 Charset charset,
 @Nullable
 HttpRequest request)

Create WebClientResponseException or an HTTP status specific subclass.

Since:

6.0