程序包 cn.taketoday.web.client

类 DefaultResponseErrorHandler

java.lang.Object

cn.taketoday.web.client.DefaultResponseErrorHandler

所有已实现的接口:

ResponseErrorHandler

直接已知子类:

ExtractingResponseErrorHandler

public class DefaultResponseErrorHandler
extends Object
implements ResponseErrorHandler

Default implementation of the ResponseErrorHandler interface.

This error handler checks for the status code on the ClientHttpResponse. Any code in the 4xx or 5xx series is considered to be an error. This behavior can be changed by overriding hasError(HttpStatusCode). Unknown status codes will be ignored by hasError(ClientHttpResponse).

See handleError(ClientHttpResponse) for more details on specific exception types.

从以下版本开始:

4.0

作者:

Arjen Poutsma, Rossen Stoyanchev, Juergen Hoeller

另请参阅:

• RestTemplate.setErrorHandler(cn.taketoday.web.client.ResponseErrorHandler)

字段概要

字段

修饰符和类型	字段	说明
private List<HttpMessageConverter<?>>	messageConverters

构造器概要

构造器

构造器	说明
DefaultResponseErrorHandler()

方法概要

修饰符和类型	方法	说明
protected Charset	getCharset(ClientHttpResponse 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[]	getResponseBody(ClientHttpResponse response)	Read the body of the given response (for inclusion in a status exception).
void	handleError(ClientHttpResponse response)	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.
boolean	hasError(ClientHttpResponse response)	Delegates to hasError(HttpStatusCode) with the response status code.
protected boolean	hasError(HttpStatusCode statusCode)	Template method called from hasError(ClientHttpResponse).
protected Function<cn.taketoday.core.ResolvableType,?>	initBodyConvertFunction(ClientHttpResponse response, byte[] body)	Return a function for decoding the error content.
(专用程序包) void	setMessageConverters(List<HttpMessageConverter<?>> converters)	For internal use from the RestTemplate, to pass the message converters to use to decode error content.

从类继承的方法 java.lang.Object

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

从接口继承的方法 cn.taketoday.web.client.ResponseErrorHandler

handleError

字段详细资料

messageConverters

@Nullable
private List<HttpMessageConverter<?>> messageConverters

构造器详细资料

DefaultResponseErrorHandler

public DefaultResponseErrorHandler()

方法详细资料

setMessageConverters

void setMessageConverters(List<HttpMessageConverter<?>> converters)

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

hasError

public boolean hasError(ClientHttpResponse response)
                 throws IOException

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

指定者:

hasError 在接口中 ResponseErrorHandler

参数:

response - the response to inspect

返回:

true if the response indicates an error; false otherwise

抛出:

IOException - in case of I/O errors

另请参阅:

• ClientHttpResponse.getStatusCode()
• hasError(HttpStatusCode)

hasError

protected boolean hasError(HttpStatusCode statusCode)

Template method called from hasError(ClientHttpResponse).

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

参数:

statusCode - the HTTP status code

返回:

true if the response indicates an error; false otherwise

另请参阅:

• HttpStatusCode.isError()

handleError

public void handleError(ClientHttpResponse response)
                 throws IOException

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.

指定者:

handleError 在接口中 ResponseErrorHandler

参数:

response - the response with the error

抛出:

UnknownHttpStatusCodeException - in case of an unresolvable status code

IOException - in case of I/O errors

另请参阅:

• handleError(ClientHttpResponse, HttpStatusCode)

getErrorMessage

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

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

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

handleError

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(cn.taketoday.http.HttpStatusCode, java.lang.String, cn.taketoday.http.HttpHeaders, byte[], java.nio.charset.Charset) for errors in the 4xx range, to HttpServerErrorException.create(cn.taketoday.http.HttpStatus, java.lang.String, cn.taketoday.http.HttpHeaders, byte[], java.nio.charset.Charset) for errors in the 5xx range, or otherwise raises UnknownHttpStatusCodeException.

抛出:

IOException

另请参阅:

• HttpClientErrorException.create(cn.taketoday.http.HttpStatusCode, java.lang.String, cn.taketoday.http.HttpHeaders, byte[], java.nio.charset.Charset)
• HttpServerErrorException.create(cn.taketoday.http.HttpStatus, java.lang.String, cn.taketoday.http.HttpHeaders, byte[], java.nio.charset.Charset)

initBodyConvertFunction

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

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

getResponseBody

protected byte[] getResponseBody(ClientHttpResponse response)

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

参数:

response - the response to inspect

返回:

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

getCharset

@Nullable
protected Charset getCharset(ClientHttpResponse response)

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

参数:

response - the response to inspect

返回:

the associated charset, or null if none