程序包 cn.taketoday.web.client

类 ExtractingResponseErrorHandler

java.lang.Object

cn.taketoday.web.client.DefaultResponseErrorHandler

cn.taketoday.web.client.ExtractingResponseErrorHandler

所有已实现的接口:

ResponseErrorHandler

public class ExtractingResponseErrorHandler
extends DefaultResponseErrorHandler

Implementation of ResponseErrorHandler that uses HttpMessageConverters to convert HTTP error responses to RestClientExceptions.

To use this error handler, you must specify a status mapping and/or a series mapping. If either of these mappings has a match for the status code of a given ClientHttpResponse, DefaultResponseErrorHandler.hasError(ClientHttpResponse) will return true, and DefaultResponseErrorHandler.handleError(ClientHttpResponse) will attempt to use the configured message converters to convert the response into the mapped subclass of RestClientException. Note that the status mapping takes precedence over series mapping.

If there is no match, this error handler will default to the behavior of DefaultResponseErrorHandler. Note that you can override this default behavior by specifying a series mapping from HttpStatus.Series#CLIENT_ERROR and/or HttpStatus.Series#SERVER_ERROR to null.

从以下版本开始:

4.0

作者:

Simon Galperin, Arjen Poutsma, Harry Yang

另请参阅:

• RestTemplate.setErrorHandler(ResponseErrorHandler)

字段概要

字段

修饰符和类型	字段	说明
private List<HttpMessageConverter<?>>	messageConverters
private final Map<HttpStatus.Series,Class<? extends RestClientException>>	seriesMapping
private final Map<HttpStatusCode,Class<? extends RestClientException>>	statusMapping

构造器概要

构造器

构造器	说明
ExtractingResponseErrorHandler()	Create a new, empty ExtractingResponseErrorHandler.
ExtractingResponseErrorHandler(List<HttpMessageConverter<?>> messageConverters)	Create a new ExtractingResponseErrorHandler with the given HttpMessageConverter instances.

方法概要

修饰符和类型	方法	说明
private void	extract(Class<? extends RestClientException> exceptionClass, ClientHttpResponse response)
void	handleError(ClientHttpResponse response, HttpStatusCode statusCode)	Handle the error based on the resolved status code.
protected boolean	hasError(HttpStatusCode statusCode)	Template method called from DefaultResponseErrorHandler.hasError(ClientHttpResponse).
void	setMessageConverters(List<HttpMessageConverter<?>> messageConverters)	Set the message converters to use by this extractor.
void	setSeriesMapping(Map<HttpStatus.Series,Class<? extends RestClientException>> seriesMapping)	Set the mapping from HTTP status series to RestClientException subclass.
void	setStatusMapping(Map<HttpStatusCode,Class<? extends RestClientException>> statusMapping)	Set the mapping from HTTP status code to RestClientException subclass.

从类继承的方法 cn.taketoday.web.client.DefaultResponseErrorHandler

getCharset, getResponseBody, handleError, hasError, initBodyConvertFunction

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

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

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

handleError

字段详细资料

messageConverters

private List<HttpMessageConverter<?>> messageConverters

statusMapping

private final Map<HttpStatusCode,Class<? extends RestClientException>> statusMapping

seriesMapping

private final Map<HttpStatus.Series,Class<? extends RestClientException>> seriesMapping

构造器详细资料

ExtractingResponseErrorHandler

public ExtractingResponseErrorHandler()

Create a new, empty ExtractingResponseErrorHandler.

Note that setMessageConverters(List) must be called when using this constructor.

ExtractingResponseErrorHandler

public ExtractingResponseErrorHandler(List<HttpMessageConverter<?>> messageConverters)

Create a new ExtractingResponseErrorHandler with the given HttpMessageConverter instances.

参数:

messageConverters - the message converters to use

方法详细资料

setMessageConverters

public void setMessageConverters(List<HttpMessageConverter<?>> messageConverters)

Set the message converters to use by this extractor.

覆盖:

setMessageConverters 在类中 DefaultResponseErrorHandler

setStatusMapping

public void setStatusMapping(Map<HttpStatusCode,Class<? extends RestClientException>> statusMapping)

Set the mapping from HTTP status code to RestClientException subclass. If this mapping has a match for the status code of a given ClientHttpResponse, DefaultResponseErrorHandler.hasError(ClientHttpResponse) will return true and DefaultResponseErrorHandler.handleError(ClientHttpResponse) will attempt to use the configured message converters to convert the response into the mapped subclass of RestClientException.

setSeriesMapping

public void setSeriesMapping(Map<HttpStatus.Series,Class<? extends RestClientException>> seriesMapping)

Set the mapping from HTTP status series to RestClientException subclass. If this mapping has a match for the status code of a given ClientHttpResponse, DefaultResponseErrorHandler.hasError(ClientHttpResponse) will return true and DefaultResponseErrorHandler.handleError(ClientHttpResponse) will attempt to use the configured message converters to convert the response into the mapped subclass of RestClientException.

hasError

protected boolean hasError(HttpStatusCode statusCode)

从类复制的说明: DefaultResponseErrorHandler

Template method called from DefaultResponseErrorHandler.hasError(ClientHttpResponse).

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

覆盖:

hasError 在类中 DefaultResponseErrorHandler

参数:

statusCode - the HTTP status code

返回:

true if the response indicates an error; false otherwise

另请参阅:

• HttpStatusCode.isError()

handleError

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

从类复制的说明: DefaultResponseErrorHandler

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.

覆盖:

handleError 在类中 DefaultResponseErrorHandler

抛出:

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)

extract

private void extract(@Nullable
 Class<? extends RestClientException> exceptionClass,
 ClientHttpResponse response)
              throws IOException

抛出:

IOException