Top Description Inners Fields Constructors Methods
org.springframework.web.reactive.function.client

public Class WebClientResponseException

extends WebClientException
Class Inheritance
Known Direct Subclasses
org.springframework.web.reactive.function.client.WebClientResponseException.BadRequest, org.springframework.web.reactive.function.client.WebClientResponseException.Unauthorized, org.springframework.web.reactive.function.client.WebClientResponseException.Forbidden, org.springframework.web.reactive.function.client.WebClientResponseException.NotFound, org.springframework.web.reactive.function.client.WebClientResponseException.MethodNotAllowed, org.springframework.web.reactive.function.client.WebClientResponseException.NotAcceptable, org.springframework.web.reactive.function.client.WebClientResponseException.Conflict, org.springframework.web.reactive.function.client.WebClientResponseException.Gone, org.springframework.web.reactive.function.client.WebClientResponseException.UnsupportedMediaType, org.springframework.web.reactive.function.client.WebClientResponseException.UnprocessableEntity, org.springframework.web.reactive.function.client.WebClientResponseException.TooManyRequests, org.springframework.web.reactive.function.client.WebClientResponseException.InternalServerError, org.springframework.web.reactive.function.client.WebClientResponseException.NotImplemented, org.springframework.web.reactive.function.client.WebClientResponseException.BadGateway, org.springframework.web.reactive.function.client.WebClientResponseException.ServiceUnavailable, org.springframework.web.reactive.function.client.WebClientResponseException.GatewayTimeout, org.springframework.web.reactive.function.client.UnknownHttpStatusCodeException
Annotations
@SuppressWarnings:RedundantSuppression
Imports
java.nio.charset.Charset, .StandardCharsets, java.util.List, .Map, java.util.function.Function, org.springframework.core.ParameterizedTypeReference, .ResolvableType, org.springframework.http.HttpHeaders, .HttpRequest, .HttpStatus, .HttpStatusCode, org.springframework.lang.Nullable, org.springframework.util.Assert
Exceptions that contain actual HTTP response data.
Authors
Arjen Poutsma, Sebastien Deleuze
Since
5.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
WebClientResponseException.BadGateway

WebClientResponseException for HTTP status 502 Bad Gateway.

public static class
WebClientResponseException.BadRequest

WebClientResponseException for status HTTP 400 Bad Request.

public static class
WebClientResponseException.Conflict

WebClientResponseException for status HTTP 409 Conflict.

public static class
WebClientResponseException.Forbidden

WebClientResponseException for status HTTP 403 Forbidden.

public static class
WebClientResponseException.GatewayTimeout

WebClientResponseException for status HTTP 504 Gateway Timeout.

public static class
WebClientResponseException.Gone

WebClientResponseException for status HTTP 410 Gone.

public static class
WebClientResponseException.InternalServerError

WebClientResponseException for status HTTP 500 Internal Server Error.

public static class
WebClientResponseException.MethodNotAllowed

WebClientResponseException for status HTTP 405 Method Not Allowed.

public static class
WebClientResponseException.NotAcceptable

WebClientResponseException for status HTTP 406 Not Acceptable.

public static class
WebClientResponseException.NotFound

WebClientResponseException for status HTTP 404 Not Found.

public static class
WebClientResponseException.NotImplemented

WebClientResponseException for status HTTP 501 Not Implemented.

public static class
WebClientResponseException.ServiceUnavailable

WebClientResponseException for status HTTP 503 Service Unavailable.

public static class
WebClientResponseException.TooManyRequests

WebClientResponseException for status HTTP 429 Too Many Requests.

public static class
WebClientResponseException.Unauthorized

WebClientResponseException for status HTTP 401 Unauthorized.

public static class
WebClientResponseException.UnprocessableEntity

WebClientResponseException for status HTTP 422 Unprocessable Entity.

public static class
WebClientResponseException.UnsupportedMediaType

WebClientResponseException for status HTTP 415 Unsupported Media Type.

Field Summary

Modifier and TypeField and Description
private transient Function<ResolvableType, ?>
bodyDecodeFunction

private final HttpHeaders
headers

private final transient HttpRequest
request

private final byte[]
responseBody

private final Charset
responseCharset

private static final long
serialVersionUID

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

private final HttpStatusCode
statusCode

private final String
statusText

Constructor Summary

AccessConstructor and Description
public
WebClientResponseException(int statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset)

Constructor with response data only, and a default message.

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

Constructor with response data only, and a default message.

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

Constructor with response data only, and a default message.

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

Constructor with a prepared message.

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

Constructor with a prepared message.

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

Constructor with a prepared message.

Method Summary

Modifier and TypeMethod and Description
private static HttpHeaders
copy(HttpHeaders headers)

Not all HttpHeaders implementations are serializable, so we make a copy to ensure that WebClientResponseException is.

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

Create WebClientResponseException or an HTTP status specific subclass.

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

Create WebClientResponseException or an HTTP status specific subclass.

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

Create WebClientResponseException or an HTTP status specific subclass.

private <E> E
decodeBody(ResolvableType targetType)

public HttpHeaders
getHeaders()

Return the HTTP response headers.

public int
getRawStatusCode()
Deprecated since 6.0. as of 6.0, in favor of getStatusCode()

Return the raw HTTP status code value.

public HttpRequest
getRequest()

Return the corresponding request.

public <
the expected target type
E> E

Returns:

the decoded content, or null if there is no content
getResponseBodyAs(Class<E>
the type to decode to
targetType)

Decode the error content to the specified type.

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

Variant of getResponseBodyAs(Class) with ParameterizedTypeReference.

public byte[]
getResponseBodyAsByteArray()

Return the response body as a byte array.

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.

public String
getResponseBodyAsString(Charset
the charset to use if the Content-Type of the response does not specify one.
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.

public HttpStatusCode
getStatusCode()

Return the HTTP status code value.

public String
getStatusText()

Return the HTTP status text.

private static String
initMessage(HttpStatusCode status, String reasonPhrase, HttpRequest request)

public void
setBodyDecodeFunction(Function<ResolvableType, ?>
the function to find a decoder with
decoderFunction)

Provide a function to find a decoder the given target type.