org.springframework.web.reactive.function.client

Interface WebClient.HeaderSpec

All Known Implementing Classes:

DefaultWebClient.DefaultHeaderSpec

Enclosing interface:

WebClient

public static interface WebClient.HeaderSpec

Contract for specifying request headers leading up to the exchange.

Method Summary

Modifier and Type	Method and Description
WebClient.HeaderSpec	accept(MediaType... acceptableMediaTypes) Set the list of acceptable media types, as specified by the Accept header.
WebClient.HeaderSpec	acceptCharset(java.nio.charset.Charset... acceptableCharsets) Set the list of acceptable charsets, as specified by the Accept-Charset header.
WebClient.HeaderSpec	contentLength(long contentLength) Set the length of the body in bytes, as specified by the Content-Length header.
WebClient.HeaderSpec	contentType(MediaType contentType) Set the media type of the body, as specified by the Content-Type header.
WebClient.HeaderSpec	cookie(java.lang.String name, java.lang.String value) Add a cookie with the given name and value.
WebClient.HeaderSpec	cookies(MultiValueMap<java.lang.String,java.lang.String> cookies) Copy the given cookies into the entity's cookies map.
<any>	exchange() Perform the request without a request body.
<T> <any>	exchange(BodyInserter<T,? super ClientHttpRequest> inserter) Set the body of the request to the given BodyInserter and perform the request.
<T,S extends <any>> <any>	exchange(S publisher, java.lang.Class<T> elementClass) Set the body of the request to the given Publisher and perform the request.
WebClient.HeaderSpec	header(java.lang.String headerName, java.lang.String... headerValues) Add the given, single header value under the given name.
WebClient.HeaderSpec	headers(HttpHeaders headers) Copy the given headers into the entity's headers map.
WebClient.HeaderSpec	ifModifiedSince(java.time.ZonedDateTime ifModifiedSince) Set the value of the If-Modified-Since header.
WebClient.HeaderSpec	ifNoneMatch(java.lang.String... ifNoneMatches) Set the values of the If-None-Match header.

Method Detail

accept

WebClient.HeaderSpec accept(MediaType... acceptableMediaTypes)

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

Parameters:

acceptableMediaTypes - the acceptable media types

Returns:

this builder

acceptCharset

WebClient.HeaderSpec acceptCharset(java.nio.charset.Charset... acceptableCharsets)

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

Parameters:

acceptableCharsets - the acceptable charsets

Returns:

this builder

contentLength

WebClient.HeaderSpec contentLength(long contentLength)

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

Parameters:

contentLength - the content length

Returns:

this builder

See Also:

HttpHeaders.setContentLength(long)

contentType

WebClient.HeaderSpec contentType(MediaType contentType)

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

Parameters:

contentType - the content type

Returns:

this builder

See Also:

HttpHeaders.setContentType(MediaType)

cookie

WebClient.HeaderSpec cookie(java.lang.String name,
                            java.lang.String value)

Add a cookie with the given name and value.

Parameters:

name - the cookie name

value - the cookie value

Returns:

this builder

cookies

WebClient.HeaderSpec cookies(MultiValueMap<java.lang.String,java.lang.String> cookies)

Copy the given cookies into the entity's cookies map.

Parameters:

cookies - the existing cookies to copy from

Returns:

this builder

ifModifiedSince

WebClient.HeaderSpec ifModifiedSince(java.time.ZonedDateTime ifModifiedSince)

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

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

Parameters:

ifModifiedSince - the new value of the header

Returns:

this builder

ifNoneMatch

WebClient.HeaderSpec ifNoneMatch(java.lang.String... ifNoneMatches)

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

Parameters:

ifNoneMatches - the new value of the header

Returns:

this builder

header

WebClient.HeaderSpec header(java.lang.String headerName,
                            java.lang.String... headerValues)

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

Parameters:

headerName - the header name

headerValues - the header value(s)

Returns:

this builder

headers

WebClient.HeaderSpec headers(HttpHeaders headers)

Copy the given headers into the entity's headers map.

Parameters:

headers - the existing headers to copy from

Returns:

this builder

exchange

<any> exchange()

Perform the request without a request body.

Returns:

a Mono with the response

exchange

<T> <any> exchange(BodyInserter<T,? super ClientHttpRequest> inserter)

Set the body of the request to the given BodyInserter and perform the request.

Type Parameters:

T - the type contained in the body

Parameters:

inserter - the BodyInserter that writes to the request

Returns:

a Mono with the response

exchange

<T,S extends <any>> <any> exchange(S publisher,
                                   java.lang.Class<T> elementClass)

Set the body of the request to the given Publisher and perform the request.

Type Parameters:

T - the type of the elements contained in the publisher

S - the type of the Publisher

Parameters:

publisher - the Publisher to write to the request

elementClass - the class of elements contained in the publisher

Returns:

a Mono with the response