DefaultWebClient.DefaultRequestBodyUriSpec

java.lang.Object
- org.springframework.web.reactive.function.client.DefaultWebClient.DefaultRequestBodyUriSpec

All Implemented Interfaces:

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

Enclosing class:

DefaultWebClient
```
private class DefaultWebClient.DefaultRequestBodyUriSpec
extends java.lang.Object
implements WebClient.RequestBodyUriSpec
```

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.Map<java.lang.String,java.lang.Object>`	`attributes`
`private MultiValueMap<java.lang.String,java.lang.String>`	`cookies`
`private HttpHeaders`	`headers`
`private HttpMethod`	`httpMethod`
`private BodyInserter<?,? super ClientHttpRequest>`	`inserter`
`private java.net.URI`	`uri`

Constructor Summary

Constructors
Constructor and Description

DefaultRequestBodyUriSpec(HttpMethod httpMethod)

Constructors
Constructor and Description
`DefaultRequestBodyUriSpec(HttpMethod httpMethod)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DefaultWebClient.DefaultRequestBodyUriSpec`	`accept(MediaType... acceptableMediaTypes)` Set the list of acceptable media types, as specified by the `Accept` header.
`DefaultWebClient.DefaultRequestBodyUriSpec`	`acceptCharset(java.nio.charset.Charset... acceptableCharsets)` Set the list of acceptable charsets, as specified by the `Accept-Charset` header.
`WebClient.RequestBodySpec`	`attribute(java.lang.String name, java.lang.Object value)` Set the attribute with the given name to the given value.
`WebClient.RequestBodySpec`	`attributes(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> attributesConsumer)` Provides access to every attribute declared so far with the possibility to add, replace, or remove values.
`WebClient.RequestHeadersSpec<?>`	`body(BodyInserter<?,? super ClientHttpRequest> inserter)` Set the body of the request using the given body inserter.
`<T,P extends <any>> WebClient.RequestHeadersSpec<?>`	`body(P publisher, java.lang.Class<T> elementClass)` A shortcut for `WebClient.RequestBodySpec.body(BodyInserter)` with a Publisher inserter.
`<T,P extends <any>> WebClient.RequestHeadersSpec<?>`	`body(P publisher, ParameterizedTypeReference<T> typeReference)` A variant of `#body(Publisher, Class)` that allows providing element type information that includes generics via a `ParameterizedTypeReference`.
`DefaultWebClient.DefaultRequestBodyUriSpec`	`contentLength(long contentLength)` Set the length of the body in bytes, as specified by the `Content-Length` header.
`DefaultWebClient.DefaultRequestBodyUriSpec`	`contentType(MediaType contentType)` Set the media type of the body, as specified by the `Content-Type` header.
`DefaultWebClient.DefaultRequestBodyUriSpec`	`cookie(java.lang.String name, java.lang.String value)` Add a cookie with the given name and value.
`DefaultWebClient.DefaultRequestBodyUriSpec`	`cookies(java.util.function.Consumer<MultiValueMap<java.lang.String,java.lang.String>> cookiesConsumer)` Provides access to every cookie declared so far with the possibility to add, replace, or remove values.
`private HttpRequest`	`createRequest()`
`<any>`	`exchange()` Perform the HTTP request and return a `ClientResponse` with the response status and headers.
`private MultiValueMap<java.lang.String,java.lang.String>`	`getCookies()`
`private HttpHeaders`	`getHeaders()`
`DefaultWebClient.DefaultRequestBodyUriSpec`	`header(java.lang.String headerName, java.lang.String... headerValues)` Add the given, single header value under the given name.
`DefaultWebClient.DefaultRequestBodyUriSpec`	`headers(java.util.function.Consumer<HttpHeaders> headersConsumer)` Provides access to every header declared so far with the possibility to add, replace, or remove values.
`DefaultWebClient.DefaultRequestBodyUriSpec`	`ifModifiedSince(java.time.ZonedDateTime ifModifiedSince)` Set the value of the `If-Modified-Since` header.
`DefaultWebClient.DefaultRequestBodyUriSpec`	`ifNoneMatch(java.lang.String... ifNoneMatches)` Set the values of the `If-None-Match` header.
`private MultiValueMap<java.lang.String,java.lang.String>`	`initCookies()`
`private HttpHeaders`	`initHeaders()`
`private ClientRequest.Builder`	`initRequestBuilder()`
`private java.net.URI`	`initUri()`
`WebClient.ResponseSpec`	`retrieve()` Perform the HTTP request and retrieve the response body:
`WebClient.RequestHeadersSpec<?>`	`syncBody(java.lang.Object body)` A shortcut for `WebClient.RequestBodySpec.body(BodyInserter)` with an Object inserter.
`WebClient.RequestBodySpec`	`uri(java.util.function.Function<UriBuilder,java.net.URI> uriFunction)` Build the URI for the request using the `UriBuilderFactory` configured for this client.
`WebClient.RequestBodySpec`	`uri(java.lang.String uriTemplate, java.util.Map<java.lang.String,?> uriVariables)` Specify the URI for the request using a URI template and URI variables.
`WebClient.RequestBodySpec`	`uri(java.lang.String uriTemplate, java.lang.Object... uriVariables)` Specify the URI for the request using a URI template and URI variables.
`WebClient.RequestBodySpec`	`uri(java.net.URI uri)` Specify the URI using an absolute, fully constructed `URI`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - httpMethod
```
private final HttpMethod httpMethod
```
  - uri
```
@Nullable
private java.net.URI uri
```
  - headers
```
@Nullable
private HttpHeaders headers
```
  - cookies
```
@Nullable
private MultiValueMap<java.lang.String,java.lang.String> cookies
```
  - inserter
```
@Nullable
private BodyInserter<?,? super ClientHttpRequest> inserter
```
  - attributes
```
private final java.util.Map<java.lang.String,java.lang.Object> attributes
```
- Constructor Detail
  - DefaultRequestBodyUriSpec
```
DefaultRequestBodyUriSpec(HttpMethod httpMethod)
```
- Method Detail
  - uri
```
public WebClient.RequestBodySpec uri(java.lang.String uriTemplate,
                                     java.lang.Object... uriVariables)
```
    Description copied from interface: WebClient.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.
    
    Specified by:
    
    uri in interface WebClient.UriSpec<WebClient.RequestBodySpec>
  - uri
```
public WebClient.RequestBodySpec uri(java.lang.String uriTemplate,
                                     java.util.Map<java.lang.String,?> uriVariables)
```
    Description copied from interface: WebClient.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.
    
    Specified by:
    
    uri in interface WebClient.UriSpec<WebClient.RequestBodySpec>
  - uri
```
public WebClient.RequestBodySpec uri(java.util.function.Function<UriBuilder,java.net.URI> uriFunction)
```
    Description copied from interface: WebClient.UriSpec
    
    Build the URI for the request using the UriBuilderFactory configured for this client.
    
    Specified by:
    
    uri in interface WebClient.UriSpec<WebClient.RequestBodySpec>
  - uri
```
public WebClient.RequestBodySpec uri(java.net.URI uri)
```
    Description copied from interface: WebClient.UriSpec
    
    Specify the URI using an absolute, fully constructed URI.
    
    Specified by:
    
    uri in interface WebClient.UriSpec<WebClient.RequestBodySpec>
  - getHeaders
```
private HttpHeaders getHeaders()
```
  - getCookies
```
private MultiValueMap<java.lang.String,java.lang.String> getCookies()
```
  - header
```
public DefaultWebClient.DefaultRequestBodyUriSpec header(java.lang.String headerName,
                                                         java.lang.String... headerValues)
```
    Description copied from interface: WebClient.RequestHeadersSpec
    
    Add the given, single header value under the given name.
    
    Specified by:
    
    header in interface WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>
    
    Parameters:
    
    headerName - the header name
    
    headerValues - the header value(s)
    
    Returns:
    
    this builder
  - headers
```
public DefaultWebClient.DefaultRequestBodyUriSpec headers(java.util.function.Consumer<HttpHeaders> headersConsumer)
```
    Description copied from interface: WebClient.RequestHeadersSpec
    
    Provides access to every header declared so far with the possibility to add, replace, or remove values.
    
    Specified by:
    
    headers in interface WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>
    
    Parameters:
    
    headersConsumer - the consumer to provide access to
    
    Returns:
    
    this builder
  - attribute
```
public WebClient.RequestBodySpec attribute(java.lang.String name,
                                           java.lang.Object value)
```
    Description copied from interface: WebClient.RequestHeadersSpec
    
    Set the attribute with the given name to the given value.
    
    Specified by:
    
    attribute in interface WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>
    
    Parameters:
    
    name - the name of the attribute to add
    
    value - the value of the attribute to add
    
    Returns:
    
    this builder
  - attributes
```
public WebClient.RequestBodySpec attributes(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> attributesConsumer)
```
    Description copied from interface: WebClient.RequestHeadersSpec
    
    Provides access to every attribute declared so far with the possibility to add, replace, or remove values.
    
    Specified by:
    
    attributes in interface WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>
    
    Parameters:
    
    attributesConsumer - the consumer to provide access to
    
    Returns:
    
    this builder
  - accept
```
public DefaultWebClient.DefaultRequestBodyUriSpec accept(MediaType... acceptableMediaTypes)
```
    Description copied from interface: WebClient.RequestHeadersSpec
    
    Set the list of acceptable media types, as specified by the Accept header.
    
    Specified by:
    
    accept in interface WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>
    
    Parameters:
    
    acceptableMediaTypes - the acceptable media types
    
    Returns:
    
    this builder
  - acceptCharset
```
public DefaultWebClient.DefaultRequestBodyUriSpec acceptCharset(java.nio.charset.Charset... acceptableCharsets)
```
    Description copied from interface: WebClient.RequestHeadersSpec
    
    Set the list of acceptable charsets, as specified by the Accept-Charset header.
    
    Specified by:
    
    acceptCharset in interface WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>
    
    Parameters:
    
    acceptableCharsets - the acceptable charsets
    
    Returns:
    
    this builder
  - contentType
```
public DefaultWebClient.DefaultRequestBodyUriSpec contentType(MediaType contentType)
```
    Description copied from interface: WebClient.RequestBodySpec
    
    Set the media type of the body, as specified by the Content-Type header.
    
    Specified by:
    
    contentType in interface WebClient.RequestBodySpec
    
    Parameters:
    
    contentType - the content type
    
    Returns:
    
    this builder
    
    See Also:
    
    HttpHeaders.setContentType(MediaType)
  - contentLength
```
public DefaultWebClient.DefaultRequestBodyUriSpec contentLength(long contentLength)
```
    Description copied from interface: WebClient.RequestBodySpec
    
    Set the length of the body in bytes, as specified by the Content-Length header.
    
    Specified by:
    
    contentLength in interface WebClient.RequestBodySpec
    
    Parameters:
    
    contentLength - the content length
    
    Returns:
    
    this builder
    
    See Also:
    
    HttpHeaders.setContentLength(long)
  - cookie
```
public DefaultWebClient.DefaultRequestBodyUriSpec cookie(java.lang.String name,
                                                         java.lang.String value)
```
    Description copied from interface: WebClient.RequestHeadersSpec
    
    Add a cookie with the given name and value.
    
    Specified by:
    
    cookie in interface WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>
    
    Parameters:
    
    name - the cookie name
    
    value - the cookie value
    
    Returns:
    
    this builder
  - cookies
```
public DefaultWebClient.DefaultRequestBodyUriSpec cookies(java.util.function.Consumer<MultiValueMap<java.lang.String,java.lang.String>> cookiesConsumer)
```
    Description copied from interface: WebClient.RequestHeadersSpec
    
    Provides access to every cookie declared so far with the possibility to add, replace, or remove values.
    
    Specified by:
    
    cookies in interface WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>
    
    Parameters:
    
    cookiesConsumer - the consumer to provide access to
    
    Returns:
    
    this builder
  - ifModifiedSince
```
public DefaultWebClient.DefaultRequestBodyUriSpec ifModifiedSince(java.time.ZonedDateTime ifModifiedSince)
```
    Description copied from interface: WebClient.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.
    
    Specified by:
    
    ifModifiedSince in interface WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>
    
    Parameters:
    
    ifModifiedSince - the new value of the header
    
    Returns:
    
    this builder
  - ifNoneMatch
```
public DefaultWebClient.DefaultRequestBodyUriSpec ifNoneMatch(java.lang.String... ifNoneMatches)
```
    Description copied from interface: WebClient.RequestHeadersSpec
    
    Set the values of the If-None-Match header.
    
    Specified by:
    
    ifNoneMatch in interface WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>
    
    Parameters:
    
    ifNoneMatches - the new value of the header
    
    Returns:
    
    this builder
  - body
```
public WebClient.RequestHeadersSpec<?> body(BodyInserter<?,? super ClientHttpRequest> inserter)
```
    Description copied from interface: WebClient.RequestBodySpec
    
    Set the body of the request using the given body inserter. BodyInserters provides access to built-in implementations of BodyInserter.
    
    Specified by:
    
    body in interface WebClient.RequestBodySpec
    
    Parameters:
    
    inserter - the body inserter to use for the request body
    
    Returns:
    
    this builder
    
    See Also:
    
    BodyInserters
  - body
```
public <T,P extends <any>> WebClient.RequestHeadersSpec<?> body(P publisher,
                                                                ParameterizedTypeReference<T> typeReference)
```
    Description copied from interface: WebClient.RequestBodySpec
    
    A variant of #body(Publisher, Class) that allows providing element type information that includes generics via a ParameterizedTypeReference.
    
    Specified by:
    
    body in interface WebClient.RequestBodySpec
    
    Type Parameters:
    
    T - the type of the elements contained in the publisher
    
    P - the type of the Publisher
    
    Parameters:
    
    publisher - the Publisher to write to the request
    
    typeReference - the type reference of elements contained in the publisher
    
    Returns:
    
    this builder
  - body
```
public <T,P extends <any>> WebClient.RequestHeadersSpec<?> body(P publisher,
                                                                java.lang.Class<T> elementClass)
```
    Description copied from interface: WebClient.RequestBodySpec
    A shortcut for WebClient.RequestBodySpec.body(BodyInserter) with a Publisher inserter. For example:
```
 Mono<Person> personMono = ... ;

 Mono<Void> result = client.post()
     .uri("/persons/{id}", id)
     .contentType(MediaType.APPLICATION_JSON)
     .body(personMono, Person.class)
     .retrieve()
     .bodyToMono(Void.class);
 
```
    Specified by:
    
    body in interface WebClient.RequestBodySpec
    
    Type Parameters:
    
    T - the type of the elements contained in the publisher
    
    P - the type of the Publisher
    
    Parameters:
    
    publisher - the Publisher to write to the request
    
    elementClass - the class of elements contained in the publisher
    
    Returns:
    
    this builder
  - syncBody
```
public WebClient.RequestHeadersSpec<?> syncBody(java.lang.Object body)
```
    Description copied from interface: WebClient.RequestBodySpec
    A shortcut for WebClient.RequestBodySpec.body(BodyInserter) with an Object inserter. For example:
```
 Person person = ... ;

 Mono<Void> result = client.post()
     .uri("/persons/{id}", id)
     .contentType(MediaType.APPLICATION_JSON)
     .syncBody(person)
     .retrieve()
     .bodyToMono(Void.class);
 
```
    For multipart requests, provide a MultiValueMap. The values in the MultiValueMap can be any Object representing the body of the part, or an HttpEntity representing a part with body and headers. The MultiValueMap can be built with MultipartBodyBuilder.
    Specified by:
    
    syncBody in interface WebClient.RequestBodySpec
    
    Parameters:
    
    body - the Object to write to the request
    
    Returns:
    
    this builder
  - exchange
```
public <any> exchange()
```
    Description copied from interface: WebClient.RequestHeadersSpec
    Perform the HTTP request and return a ClientResponse with the response status and headers. You can then use methods of the response to consume the body:
```
 Mono<Person> mono = client.get()
     .uri("/persons/1")
     .accept(MediaType.APPLICATION_JSON)
     .exchange()
     .flatMap(response -> response.bodyToMono(Person.class));

 Flux<Person> flux = client.get()
     .uri("/persons")
     .accept(MediaType.APPLICATION_STREAM_JSON)
     .exchange()
     .flatMapMany(response -> response.bodyToFlux(Person.class));
 
```
    NOTE: You must always use one of the body or entity methods of the response to ensure resources are released. See ClientResponse for more details.
    Specified by:
    
    exchange in interface WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>
    
    Returns:
    
    a Mono for the response
    
    See Also:
    
    WebClient.RequestHeadersSpec.retrieve()
  - initRequestBuilder
```
private ClientRequest.Builder initRequestBuilder()
```
  - initUri
```
private java.net.URI initUri()
```
  - initHeaders
```
private HttpHeaders initHeaders()
```
  - initCookies
```
private MultiValueMap<java.lang.String,java.lang.String> initCookies()
```
  - retrieve
```
public WebClient.ResponseSpec retrieve()
```
    Description copied from interface: WebClient.RequestHeadersSpec
    Perform the HTTP request and retrieve the response body:
```
 Mono<Person> bodyMono = client.get()
     .uri("/persons/1")
     .accept(MediaType.APPLICATION_JSON)
     .retrieve()
     .bodyToMono(Person.class);
 
```
    This method is a shortcut to using WebClient.RequestHeadersSpec.exchange() and decoding the response body through ClientResponse.
    Specified by:
    
    retrieve in interface WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>
    
    Returns:
    
    ResponseSpec to specify how to decode the body
    
    See Also:
    
    WebClient.RequestHeadersSpec.exchange()
  - createRequest
```
private HttpRequest createRequest()
```

Class DefaultWebClient.DefaultRequestBodyUriSpec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

httpMethod

uri

headers

cookies

inserter

attributes

Constructor Detail

DefaultRequestBodyUriSpec

Method Detail

uri

uri

uri

uri

getHeaders

getCookies

header

headers

attribute

attributes

accept

acceptCharset

contentType

contentLength

cookie

cookies

ifModifiedSince

ifNoneMatch

body

body

body

syncBody

exchange

initRequestBuilder

initUri

initHeaders

initCookies

retrieve

createRequest