Interface WebTestClient.RequestHeadersSpec<S extends WebTestClient.RequestHeadersSpec<S>>
- Type Parameters:
S
- a self reference to the spec type
- All Known Subinterfaces:
WebTestClient.RequestBodySpec
,WebTestClient.RequestBodyUriSpec
,WebTestClient.RequestHeadersUriSpec<S>
- Enclosing interface:
- WebTestClient
public static interface WebTestClient.RequestHeadersSpec<S extends WebTestClient.RequestHeadersSpec<S>>
Specification for adding request headers and performing an exchange.
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description S
accept(MediaType... acceptableMediaTypes)
Set the list of acceptable media types, as specified by theAccept
header.S
acceptCharset(Charset... acceptableCharsets)
Set the list of acceptable charsets, as specified by theAccept-Charset
header.S
attribute(String name, Object value)
Set the attribute with the given name to the given value.S
attributes(Consumer<Map<String,Object>> attributesConsumer)
Manipulate the request attributes with the given consumer.S
cookie(String name, String value)
Add a cookie with the given name and value.S
cookies(Consumer<MultiValueMap<String,String>> cookiesConsumer)
Manipulate this request's cookies with the given consumer.WebTestClient.ResponseSpec
exchange()
Perform the exchange without a request body.S
header(String headerName, String... headerValues)
Add the given, single header value under the given name.S
headers(Consumer<HttpHeaders> headersConsumer)
Manipulate the request's headers with the given consumer.S
ifModifiedSince(ZonedDateTime ifModifiedSince)
Set the value of theIf-Modified-Since
header.S
ifNoneMatch(String... ifNoneMatches)
Set the values of theIf-None-Match
header.
Method Detail
accept
S accept(MediaType... acceptableMediaTypes)
Set the list of acceptable media types, as specified by theAccept
header.- Parameters:
acceptableMediaTypes
- the acceptable media types- Returns:
- the same instance
acceptCharset
S acceptCharset(Charset... acceptableCharsets)
Set the list of acceptable charsets, as specified by theAccept-Charset
header.- Parameters:
acceptableCharsets
- the acceptable charsets- Returns:
- the same instance
cookie
S cookie(String name, String value)
Add a cookie with the given name and value.- Parameters:
name
- the cookie namevalue
- the cookie value- Returns:
- the same instance
cookies
S cookies(Consumer<MultiValueMap<String,String>> cookiesConsumer)
Manipulate this request's cookies with the given consumer. The map provided to the consumer is "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the otherMultiValueMap
methods.- Parameters:
cookiesConsumer
- a function that consumes the cookies map- Returns:
- this builder
ifModifiedSince
S ifModifiedSince(ZonedDateTime ifModifiedSince)
Set the value of theIf-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:
- the same instance
ifNoneMatch
S ifNoneMatch(String... ifNoneMatches)
Set the values of theIf-None-Match
header.- Parameters:
ifNoneMatches
- the new value of the header- Returns:
- the same instance
header
S header(String headerName, String... headerValues)
Add the given, single header value under the given name.- Parameters:
headerName
- the header nameheaderValues
- the header value(s)- Returns:
- the same instance
headers
S headers(Consumer<HttpHeaders> headersConsumer)
Manipulate the request's headers with the given consumer. The headers provided to the consumer are "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the otherHttpHeaders
methods.- Parameters:
headersConsumer
- a function that consumes theHttpHeaders
- Returns:
- this builder
attribute
S attribute(String name, Object value)
Set the attribute with the given name to the given value.- Parameters:
name
- the name of the attribute to addvalue
- the value of the attribute to add- Returns:
- this builder
attributes
S attributes(Consumer<Map<String,Object>> attributesConsumer)
Manipulate the request attributes with the given consumer. The attributes provided to the consumer are "live", so that the consumer can be used to inspect attributes, remove attributes, or use any of the other map-provided methods.- Parameters:
attributesConsumer
- a function that consumes the attributes- Returns:
- this builder
exchange
WebTestClient.ResponseSpec exchange()
Perform the exchange without a request body.- Returns:
- spec for decoding the response