程序包 cn.taketoday.web.client

类 DefaultRestClient.DefaultRequestBodyUriSpec

java.lang.Object

cn.taketoday.web.client.DefaultRestClient.DefaultRequestBodyUriSpec

所有已实现的接口:

RestClient.RequestBodySpec, RestClient.RequestBodyUriSpec, RestClient.RequestHeadersSpec<RestClient.RequestBodySpec>, RestClient.RequestHeadersUriSpec<RestClient.RequestBodySpec>, RestClient.UriSpec<RestClient.RequestBodySpec>

封闭类:

DefaultRestClient

private class DefaultRestClient.DefaultRequestBodyUriSpec
extends Object
implements RestClient.RequestBodyUriSpec

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static interface	DefaultRestClient.DefaultRequestBodyUriSpec.InternalBody

从接口继承的嵌套类/接口 cn.taketoday.web.client.RestClient.RequestHeadersSpec

RestClient.RequestHeadersSpec.ExchangeFunction<T>

字段概要

字段

修饰符和类型	字段	说明
private final Map<String,Object>	attributes
private DefaultRestClient.DefaultRequestBodyUriSpec.InternalBody	body
private HttpHeaders	headers
private final HttpMethod	httpMethod
private Consumer<ClientHttpRequest>	httpRequestConsumer
private URI	uri

构造器概要

构造器

构造器	说明
DefaultRequestBodyUriSpec(HttpMethod httpMethod)

方法概要

修饰符和类型	方法	说明
DefaultRestClient.DefaultRequestBodyUriSpec	accept(MediaType... acceptableMediaTypes)	Set the list of acceptable media types, as specified by the Accept header.
DefaultRestClient.DefaultRequestBodyUriSpec	acceptCharset(Charset... acceptableCharsets)	Set the list of acceptable charsets, as specified by the Accept-Charset header.
RestClient.RequestBodySpec	attribute(String name, Object value)	Set the attribute with the given name to the given value.
RestClient.RequestBodySpec	attributes(Consumer<Map<String,Object>> attributesConsumer)	Provides access to every attribute declared so far with the possibility to add, replace, or remove values.
RestClient.RequestBodySpec	body(StreamingHttpOutputMessage.Body body)	Set the body of the response to the given function that writes to an OutputStream.
RestClient.RequestBodySpec	body(Object body)	Set the body of the request to the given Object.
<T> RestClient.RequestBodySpec	body(T body, cn.taketoday.core.ParameterizedTypeReference<T> bodyType)	Set the body of the response to the given Object.
DefaultRestClient.DefaultRequestBodyUriSpec	contentLength(long contentLength)	Set the length of the body in bytes, as specified by the Content-Length header.
DefaultRestClient.DefaultRequestBodyUriSpec	contentType(MediaType contentType)	Set the media type of the body, as specified by the Content-Type header.
private ClientHttpRequest	createRequest(URI uri)
private static ResourceAccessException	createResourceAccessException(URI url, HttpMethod method, IOException ex)
<T> T	exchange(RestClient.RequestHeadersSpec.ExchangeFunction<T> exchangeFunction, boolean close)	Exchange the ClientHttpResponse for a type T.
private <T> T	exchangeInternal(RestClient.RequestHeadersSpec.ExchangeFunction<T> exchangeFunction, boolean close)
void	execute()	Execute the HTTP request:
void	execute(boolean close)	Execute the HTTP request:
private HttpHeaders	getHeaders()
DefaultRestClient.DefaultRequestBodyUriSpec	header(String headerName, String... headerValues)	Add the given, single header value under the given name.
DefaultRestClient.DefaultRequestBodyUriSpec	headers(Consumer<HttpHeaders> headersConsumer)	Provides access to every header declared so far with the possibility to add, replace, or remove values.
RestClient.RequestBodySpec	httpRequest(Consumer<ClientHttpRequest> requestConsumer)	Callback for access to the ClientHttpRequest that in turn provides access to the native request of the underlying HTTP library.
DefaultRestClient.DefaultRequestBodyUriSpec	ifModifiedSince(ZonedDateTime ifModifiedSince)	Set the value of the If-Modified-Since header.
DefaultRestClient.DefaultRequestBodyUriSpec	ifNoneMatch(String... ifNoneMatches)	Set the values of the If-None-Match header.
private HttpHeaders	initHeaders()
private URI	initUri()
private void	logBody(Object body, MediaType mediaType, HttpMessageConverter<?> converter)
RestClient.ResponseSpec	retrieve()	Proceed to declare how to extract the response.
RestClient.RequestBodySpec	uri(String uriTemplate, Object... uriVariables)	Specify the URI for the request using a URI template and URI variables.
RestClient.RequestBodySpec	uri(String uriTemplate, Function<UriBuilder,URI> uriFunction)	Specify the URI starting with a URI template and finishing off with a UriBuilder created from the template.
RestClient.RequestBodySpec	uri(String uriTemplate, Map<String,?> uriVariables)	Specify the URI for the request using a URI template and URI variables.
RestClient.RequestBodySpec	uri(URI uri)	Specify the URI using an absolute, fully constructed URI.
RestClient.RequestBodySpec	uri(Function<UriBuilder,URI> uriFunction)	Specify the URI by through a UriBuilder.
private void	writeWithMessageConverters(Object body, Type bodyType, ClientHttpRequest clientRequest)

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

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

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

exchange

字段详细资料

httpMethod

private final HttpMethod httpMethod

uri

@Nullable
private URI uri

headers

@Nullable
private HttpHeaders headers

body

@Nullable
private DefaultRestClient.DefaultRequestBodyUriSpec.InternalBody body

attributes

private final Map<String,Object> attributes

httpRequestConsumer

@Nullable
private Consumer<ClientHttpRequest> httpRequestConsumer

构造器详细资料

DefaultRequestBodyUriSpec

public DefaultRequestBodyUriSpec(HttpMethod httpMethod)

方法详细资料

uri

public RestClient.RequestBodySpec uri(String uriTemplate,
 Object... uriVariables)

从接口复制的说明: RestClient.UriSpec

Specify the URI for the request using a URI template and URI variables.

If a UriBuilderFactory was configured for the client (e.g. with a base URI) it will be used to expand the URI template.

指定者:

uri 在接口中 RestClient.UriSpec<RestClient.RequestBodySpec>

uri

public RestClient.RequestBodySpec uri(String uriTemplate,
 Map<String,?> uriVariables)

从接口复制的说明: RestClient.UriSpec

Specify the URI for the request using a URI template and URI variables.

If a UriBuilderFactory was configured for the client (e.g. with a base URI) it will be used to expand the URI template.

指定者:

uri 在接口中 RestClient.UriSpec<RestClient.RequestBodySpec>

uri

public RestClient.RequestBodySpec uri(String uriTemplate,
 Function<UriBuilder,URI> uriFunction)

从接口复制的说明: RestClient.UriSpec

Specify the URI starting with a URI template and finishing off with a UriBuilder created from the template.

指定者:

uri 在接口中 RestClient.UriSpec<RestClient.RequestBodySpec>

uri

public RestClient.RequestBodySpec uri(Function<UriBuilder,URI> uriFunction)

从接口复制的说明: RestClient.UriSpec

Specify the URI by through a UriBuilder.

指定者:

uri 在接口中 RestClient.UriSpec<RestClient.RequestBodySpec>

另请参阅:

• RestClient.UriSpec.uri(String, Function)

uri

public RestClient.RequestBodySpec uri(URI uri)

从接口复制的说明: RestClient.UriSpec

Specify the URI using an absolute, fully constructed URI.

指定者:

uri 在接口中 RestClient.UriSpec<RestClient.RequestBodySpec>

getHeaders

private HttpHeaders getHeaders()

header

public DefaultRestClient.DefaultRequestBodyUriSpec header(String headerName,
 String... headerValues)

从接口复制的说明: RestClient.RequestHeadersSpec

Add the given, single header value under the given name.

指定者:

header 在接口中 RestClient.RequestHeadersSpec<RestClient.RequestBodySpec>

参数:

headerName - the header name

headerValues - the header value(s)

返回:

this builder

headers

public DefaultRestClient.DefaultRequestBodyUriSpec headers(Consumer<HttpHeaders> headersConsumer)

从接口复制的说明: RestClient.RequestHeadersSpec

Provides access to every header declared so far with the possibility to add, replace, or remove values.

指定者:

headers 在接口中 RestClient.RequestHeadersSpec<RestClient.RequestBodySpec>

参数:

headersConsumer - the consumer to provide access to

返回:

this builder

accept

public DefaultRestClient.DefaultRequestBodyUriSpec accept(MediaType... acceptableMediaTypes)

从接口复制的说明: RestClient.RequestHeadersSpec

Set the list of acceptable media types, as specified by the Accept header.

指定者:

accept 在接口中 RestClient.RequestHeadersSpec<RestClient.RequestBodySpec>

参数:

acceptableMediaTypes - the acceptable media types

返回:

this builder

acceptCharset

public DefaultRestClient.DefaultRequestBodyUriSpec acceptCharset(Charset... acceptableCharsets)

从接口复制的说明: RestClient.RequestHeadersSpec

Set the list of acceptable charsets, as specified by the Accept-Charset header.

指定者:

acceptCharset 在接口中 RestClient.RequestHeadersSpec<RestClient.RequestBodySpec>

参数:

acceptableCharsets - the acceptable charsets

返回:

this builder

contentType

public DefaultRestClient.DefaultRequestBodyUriSpec contentType(MediaType contentType)

从接口复制的说明: RestClient.RequestBodySpec

Set the media type of the body, as specified by the Content-Type header.

指定者:

contentType 在接口中 RestClient.RequestBodySpec

参数:

contentType - the content type

返回:

this builder

另请参阅:

• HttpHeaders.setContentType(MediaType)

contentLength

public DefaultRestClient.DefaultRequestBodyUriSpec contentLength(long contentLength)

从接口复制的说明: RestClient.RequestBodySpec

Set the length of the body in bytes, as specified by the Content-Length header.

指定者:

contentLength 在接口中 RestClient.RequestBodySpec

参数:

contentLength - the content length

返回:

this builder

另请参阅:

• HttpHeaders.setContentLength(long)

ifModifiedSince

public DefaultRestClient.DefaultRequestBodyUriSpec ifModifiedSince(ZonedDateTime ifModifiedSince)

从接口复制的说明: RestClient.RequestHeadersSpec

Set the value of the If-Modified-Since header.

The date should be specified as the number of milliseconds since January 1, 1970 GMT.

指定者:

ifModifiedSince 在接口中 RestClient.RequestHeadersSpec<RestClient.RequestBodySpec>

参数:

ifModifiedSince - the new value of the header

返回:

this builder

ifNoneMatch

public DefaultRestClient.DefaultRequestBodyUriSpec ifNoneMatch(String... ifNoneMatches)

从接口复制的说明: RestClient.RequestHeadersSpec

Set the values of the If-None-Match header.

指定者:

ifNoneMatch 在接口中 RestClient.RequestHeadersSpec<RestClient.RequestBodySpec>

参数:

ifNoneMatches - the new value of the header

返回:

this builder

attribute

public RestClient.RequestBodySpec attribute(String name,
 Object value)

从接口复制的说明: RestClient.RequestHeadersSpec

Set the attribute with the given name to the given value.

指定者:

attribute 在接口中 RestClient.RequestHeadersSpec<RestClient.RequestBodySpec>

参数:

name - the name of the attribute to add

value - the value of the attribute to add

返回:

this builder

attributes

public RestClient.RequestBodySpec attributes(Consumer<Map<String,Object>> attributesConsumer)

从接口复制的说明: RestClient.RequestHeadersSpec

Provides access to every attribute declared so far with the possibility to add, replace, or remove values.

指定者:

attributes 在接口中 RestClient.RequestHeadersSpec<RestClient.RequestBodySpec>

参数:

attributesConsumer - the consumer to provide access to

返回:

this builder

httpRequest

public RestClient.RequestBodySpec httpRequest(Consumer<ClientHttpRequest> requestConsumer)

从接口复制的说明: RestClient.RequestHeadersSpec

Callback for access to the ClientHttpRequest that in turn provides access to the native request of the underlying HTTP library.

This could be useful for setting advanced, per-request options that are exposed by the underlying library.

指定者:

httpRequest 在接口中 RestClient.RequestHeadersSpec<RestClient.RequestBodySpec>

参数:

requestConsumer - a consumer to access the ClientHttpRequest with

返回:

this builder

body

public RestClient.RequestBodySpec body(Object body)

从接口复制的说明: RestClient.RequestBodySpec

Set the body of the request to the given Object. For example:

 Person person = ... ;
 ResponseEntity<Void> response = client.post()
     .uri("/persons/{id}", id)
     .contentType(MediaType.APPLICATION_JSON)
     .body(person)
     .retrieve()
     .toBodilessEntity();
 

指定者:

body 在接口中 RestClient.RequestBodySpec

参数:

body - the body of the response

返回:

the built response

body

public <T> RestClient.RequestBodySpec body(T body,
 cn.taketoday.core.ParameterizedTypeReference<T> bodyType)

从接口复制的说明: RestClient.RequestBodySpec

Set the body of the response to the given Object. The parameter bodyType is used to capture the generic type.

指定者:

body 在接口中 RestClient.RequestBodySpec

参数:

body - the body of the response

bodyType - the type of the body, used to capture the generic type

返回:

the built response

body

public RestClient.RequestBodySpec body(StreamingHttpOutputMessage.Body body)

从接口复制的说明: RestClient.RequestBodySpec

Set the body of the response to the given function that writes to an OutputStream.

指定者:

body 在接口中 RestClient.RequestBodySpec

参数:

body - a function that takes an OutputStream and can throw an IOException

返回:

the built response

writeWithMessageConverters

private void writeWithMessageConverters(Object body,
 Type bodyType,
 ClientHttpRequest clientRequest)
                                 throws IOException

抛出:

IOException

logBody

private void logBody(Object body,
 @Nullable
 MediaType mediaType,
 HttpMessageConverter<?> converter)

retrieve

public RestClient.ResponseSpec retrieve()

从接口复制的说明: RestClient.RequestHeadersSpec

Proceed to declare how to extract the response. For example to extract a ResponseEntity with status, headers, and body:

 ResponseEntity<Person> entity = client.get()
     .uri("/persons/1")
     .accept(MediaType.APPLICATION_JSON)
     .retrieve()
     .toEntity(Person.class);
 

Or if interested only in the body:

 Person person = client.get()
     .uri("/persons/1")
     .accept(MediaType.APPLICATION_JSON)
     .retrieve()
     .body(Person.class);
 

By default, 4xx response code result in a HttpClientErrorException and 5xx response codes in a HttpServerErrorException. To customize error handling, use onStatus handlers.

指定者:

retrieve 在接口中 RestClient.RequestHeadersSpec<RestClient.RequestBodySpec>

返回:

ResponseSpec to specify how to decode the body

execute

public void execute()

从接口复制的说明: RestClient.RequestHeadersSpec

Execute the HTTP request:

 client.delete()
     .uri("/persons/1")
     .execute();
 

Or if interested only in the body:

  client.put()
     .uri("/persons/1")
     .body(persons)
     .execute();
 

By default, 4xx response code result in a HttpClientErrorException and 5xx response codes in a HttpServerErrorException. To customize error handling, use onStatus handlers.

指定者:

execute 在接口中 RestClient.RequestHeadersSpec<RestClient.RequestBodySpec>

execute

public void execute(boolean close)

从接口复制的说明: RestClient.RequestHeadersSpec

Execute the HTTP request:

 client.delete()
     .uri("/persons/1")
     .execute();
 

Or if interested only in the body:

  client.put()
     .uri("/persons/1")
     .body(persons)
     .execute();
 

By default, 4xx response code result in a HttpClientErrorException and 5xx response codes in a HttpServerErrorException. To customize error handling, use onStatus handlers.

指定者:

execute 在接口中 RestClient.RequestHeadersSpec<RestClient.RequestBodySpec>

参数:

close - true to close the response

exchange

public <T> T exchange(RestClient.RequestHeadersSpec.ExchangeFunction<T> exchangeFunction,
 boolean close)

从接口复制的说明: RestClient.RequestHeadersSpec

Exchange the ClientHttpResponse for a type T. This can be useful for advanced scenarios, for example to decode the response differently depending on the response status:

 Person person = client.get()
     .uri("/people/1")
     .accept(MediaType.APPLICATION_JSON)
     .exchange((request, response) -> {
         if (response.getStatusCode().equals(HttpStatus.OK)) {
             return deserialize(response.getBody());
         }
         else {
             throw new BusinessException();
         }
     });
 

Note: If close is true, then the response is closed after the exchange function has been invoked. When set to false, the caller is responsible for closing the response.

指定者:

exchange 在接口中 RestClient.RequestHeadersSpec<RestClient.RequestBodySpec>

类型参数:

T - the type the response will be transformed to

参数:

exchangeFunction - the function to handle the response with

close - true to close the response after exchangeFunction is invoked, false to keep it open

返回:

the value returned from the exchange function

exchangeInternal

private <T> T exchangeInternal(RestClient.RequestHeadersSpec.ExchangeFunction<T> exchangeFunction,
 boolean close)

initUri

private URI initUri()

initHeaders

private HttpHeaders initHeaders()

createRequest

private ClientHttpRequest createRequest(URI uri)
                                 throws IOException

抛出:

IOException

createResourceAccessException

private static ResourceAccessException createResourceAccessException(URI url,
 HttpMethod method,
 IOException ex)