Spring Framework 6.1.4 · org.springframework.web.client.DefaultResponseErrorHandler

Modifier and Type	Field and Description
private List<HttpMessageConverter<?>>	messageConverters

Access	Constructor and Description
public	DefaultResponseErrorHandler()

Method Summary

Modifier and Type	Method and Description
protected Charset	Returns: the associated charset, or `null` if none getCharset(ClientHttpResponse the response to inspect response) Determine the charset of the response (for inclusion in a status exception).
private String	getErrorMessage(int rawStatusCode, String statusText, byte[] responseBody, Charset charset) Return error message with details from the response body.
protected byte[]	Returns: the response body as a byte array, or an empty byte array if the body could not be read getResponseBody(ClientHttpResponse the response to inspect response) Read the body of the given response (for inclusion in a status exception).
public void	handleError(ClientHttpResponse the response with the error response) Implements org.springframework.web.client.ResponseErrorHandler.handleError. Handle the error in the given response with the given resolved status code.
protected void	handleError(ClientHttpResponse response, HttpStatusCode statusCode) Handle the error based on the resolved status code.
public boolean	hasError(ClientHttpResponse the response to inspect response) Implements org.springframework.web.client.ResponseErrorHandler.hasError. Delegates to `hasError(HttpStatusCode)` with the response status code.
protected boolean	Returns: `true` if the response indicates an error; `false` otherwise hasError(HttpStatusCode the HTTP status code statusCode) Template method called from `hasError(ClientHttpResponse)`.
protected boolean	Returns: `true` if the response indicates an error; `false` otherwise hasError(int the HTTP status code as raw value statusCode) Deprecated in favor of `hasError(HttpStatusCode)` Template method called from `hasError(ClientHttpResponse)`.
protected Function<ResolvableType, ?>	initBodyConvertFunction(ClientHttpResponse response, byte[] body) Return a function for decoding the error content.
pack-priv void	setMessageConverters(List<HttpMessageConverter<?>> converters) For internal use from the RestTemplate, to pass the message converters to use to decode error content.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

messageConverters	back to summary
private List<HttpMessageConverter<?>> messageConverters Annotations @Nullable

DefaultResponseErrorHandler	back to summary
public DefaultResponseErrorHandler()

Method Detail

getCharset back to summary

getCharset	back to summary
protected Charset getCharset(ClientHttpResponse response) Determine the charset of the response (for inclusion in a status exception). Parameters response:ClientHttpResponse the response to inspect Returns:Charset the associated charset, or `null` if none Annotations @Nullable Since 4.3.8

protected Charset getCharset(ClientHttpResponse response)

Determine the charset of the response (for inclusion in a status exception).

Parameters

response:ClientHttpResponse: the response to inspect

Returns:Charset

the associated charset, or null if none

Annotations

@Nullable

Since

4.3.8

getErrorMessage	back to summary
private String getErrorMessage(int rawStatusCode, String statusText, byte[] responseBody, Charset charset) Return error message with details from the response body. For example: 404 Not Found: [{'id': 123, 'message': 'my message'}]

getErrorMessage

back to summary

private String getErrorMessage(int rawStatusCode, String statusText, byte[] responseBody, Charset charset)

Return error message with details from the response body. For example:

404 Not Found: [{'id': 123, 'message': 'my message'}]

getResponseBody	back to summary
protected byte[] getResponseBody(ClientHttpResponse response) Read the body of the given response (for inclusion in a status exception). Parameters response:ClientHttpResponse the response to inspect Returns:byte[] the response body as a byte array, or an empty byte array if the body could not be read Since 4.3.8

getResponseBody

back to summary

protected byte[] getResponseBody(ClientHttpResponse response)

Read the body of the given response (for inclusion in a status exception).

Parameters

response:ClientHttpResponse: the response to inspect

Returns:byte[]

the response body as a byte array, or an empty byte array if the body could not be read

Since

4.3.8

handleError back to summary

handleError	back to summary
public void handleError(ClientHttpResponse response) throws IOException Implements org.springframework.web.client.ResponseErrorHandler.handleError. Handle the error in the given response with the given resolved status code. The default implementation throws: `HttpClientErrorException` if the status code is in the 4xx series, or one of its sub-classes such as `HttpClientErrorException.BadRequest` and others. `HttpServerErrorException` if the status code is in the 5xx series, or one of its sub-classes such as `HttpServerErrorException.InternalServerError` and others. `UnknownHttpStatusCodeException` for error status codes not in the `HttpStatus` enum range. Parameters response:ClientHttpResponse Doc from org.springframework.web.client.ResponseErrorHandler.handleError. the response with the error Annotations @Override Exceptions IOException: Doc from org.springframework.web.client.ResponseErrorHandler.handleError. in case of I/O errors UnknownHttpStatusCodeException: in case of an unresolvable status code See Also `handleError(ClientHttpResponse, HttpStatusCode)`

public void handleError(ClientHttpResponse response) throws IOException

Implements org.springframework.web.client.ResponseErrorHandler.handleError.

Handle the error in the given response with the given resolved status code.

The default implementation throws:

HttpClientErrorException if the status code is in the 4xx series, or one of its sub-classes such as HttpClientErrorException.BadRequest and others.
HttpServerErrorException if the status code is in the 5xx series, or one of its sub-classes such as HttpServerErrorException.InternalServerError and others.
UnknownHttpStatusCodeException for error status codes not in the HttpStatus enum range.

Parameters

response:ClientHttpResponse

Doc from org.springframework.web.client.ResponseErrorHandler.handleError.

the response with the error

Annotations

@Override

Exceptions

IOException:

Doc from org.springframework.web.client.ResponseErrorHandler.handleError.

in case of I/O errors

UnknownHttpStatusCodeException:

in case of an unresolvable status code

handleError back to summary

handleError	back to summary
protected void handleError(ClientHttpResponse response, HttpStatusCode statusCode) throws IOException Handle the error based on the resolved status code. The default implementation delegates to `HttpClientErrorException#create` for errors in the 4xx range, to `HttpServerErrorException#create` for errors in the 5xx range, or otherwise raises `UnknownHttpStatusCodeException`. Since 5.0 See Also `HttpClientErrorException#create`, `HttpServerErrorException#create`

protected void handleError(ClientHttpResponse response, HttpStatusCode statusCode) throws IOException

Handle the error based on the resolved status code.

The default implementation delegates to HttpClientErrorException#create for errors in the 4xx range, to HttpServerErrorException#create for errors in the 5xx range, or otherwise raises UnknownHttpStatusCodeException.

Since: 5.0
See Also: HttpClientErrorException#create, HttpServerErrorException#create

hasError back to summary

hasError	back to summary
public boolean hasError(ClientHttpResponse response) throws IOException Implements org.springframework.web.client.ResponseErrorHandler.hasError. Delegates to `hasError(HttpStatusCode)` with the response status code. Parameters response:ClientHttpResponse Doc from org.springframework.web.client.ResponseErrorHandler.hasError. the response to inspect Returns:boolean Doc from org.springframework.web.client.ResponseErrorHandler.hasError. `true` if the response indicates an error; `false` otherwise Annotations @Override Exceptions IOException: Doc from org.springframework.web.client.ResponseErrorHandler.hasError. in case of I/O errors See Also `ClientHttpResponse#getStatusCode()`, `hasError(HttpStatusCode)`

public boolean hasError(ClientHttpResponse response) throws IOException

Implements org.springframework.web.client.ResponseErrorHandler.hasError.

Delegates to hasError(HttpStatusCode) with the response status code.

Parameters

response:ClientHttpResponse

Doc from org.springframework.web.client.ResponseErrorHandler.hasError.

the response to inspect

Returns:boolean

Doc from org.springframework.web.client.ResponseErrorHandler.hasError.

true if the response indicates an error; false otherwise

Annotations

@Override

Exceptions

IOException:

Doc from org.springframework.web.client.ResponseErrorHandler.hasError.

in case of I/O errors

hasError back to summary

hasError	back to summary
protected boolean hasError(HttpStatusCode statusCode) Template method called from `hasError(ClientHttpResponse)`. The default implementation checks `HttpStatusCode#isError()`. Can be overridden in subclasses. Parameters statusCode:HttpStatusCode the HTTP status code Returns:boolean `true` if the response indicates an error; `false` otherwise See Also `HttpStatusCode#isError()`

protected boolean hasError(HttpStatusCode statusCode)

Template method called from hasError(ClientHttpResponse).

The default implementation checks HttpStatusCode#isError(). Can be overridden in subclasses.

Parameters

statusCode:HttpStatusCode: the HTTP status code

Returns:boolean

true if the response indicates an error; false otherwise

See Also

HttpStatusCode#isError()

hasError back to summary

hasError	back to summary
protected boolean hasError(int statusCode) Deprecated in favor of `hasError(HttpStatusCode)` Template method called from `hasError(ClientHttpResponse)`. The default implementation checks if the given status code is `CLIENT_ERROR` or `SERVER_ERROR`. Can be overridden in subclasses. Parameters statusCode:int the HTTP status code as raw value Returns:boolean `true` if the response indicates an error; `false` otherwise Annotations @Deprecated Since 4.3.21 See Also `org.springframework.http.HttpStatus.Series#CLIENT_ERROR`, `org.springframework.http.HttpStatus.Series#SERVER_ERROR`

protected boolean hasError(int statusCode)

Deprecated

in favor of hasError(HttpStatusCode)

Template method called from hasError(ClientHttpResponse).

The default implementation checks if the given status code is CLIENT_ERROR or SERVER_ERROR. Can be overridden in subclasses.

Parameters

statusCode:int: the HTTP status code as raw value

Returns:boolean

true if the response indicates an error; false otherwise

Annotations

@Deprecated

Since

4.3.21

initBodyConvertFunction back to summary

initBodyConvertFunction	back to summary
protected Function<ResolvableType, ?> initBodyConvertFunction(ClientHttpResponse response, byte[] body) Return a function for decoding the error content. This can be passed to `RestClientResponseException#setBodyConvertFunction(Function)`. Since 6.0

protected Function<ResolvableType, ?> initBodyConvertFunction(ClientHttpResponse response, byte[] body)

Return a function for decoding the error content. This can be passed to RestClientResponseException#setBodyConvertFunction(Function).

Since: 6.0

setMessageConverters	back to summary
pack-priv void setMessageConverters(List<HttpMessageConverter<?>> converters) For internal use from the RestTemplate, to pass the message converters to use to decode error content. Since 6.0

setMessageConverters

back to summary

pack-priv void setMessageConverters(List<HttpMessageConverter<?>> converters)

For internal use from the RestTemplate, to pass the message converters to use to decode error content.

Since: 6.0

public Class DefaultResponseErrorHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail