Module io.helidon.reactive.webclient

Package io.helidon.reactive.webclient

Interface WebClientRequestHeaders

All Superinterfaces:

ClientRequestHeaders, Headers, Iterable<Http.HeaderValue>, ServerRequestHeaders, WritableHeaders<ClientRequestHeaders>

public interface WebClientRequestHeaders
extends ClientRequestHeaders

Headers that can be modified (until request is sent) for outbound request.

Field Summary

Fields inherited from interface io.helidon.common.http.ServerRequestHeaders

HUC_ACCEPT_DEFAULT, HUC_ACCEPT_DEFAULT_TYPES

Method Summary

Modifier and Type	Method	Description
default WebClientRequestHeaders	add(Http.HeaderName key, String... values)	Add header values.
WebClientRequestHeaders	add(String key, String... values)	Deprecated. use add(io.helidon.common.http.Http.HeaderName, String...)
WebClientRequestHeaders	addAccept(HttpMediaType mediaType)	Add accepted HttpMediaType.
WebClientRequestHeaders	addAll(Headers parameters)	Add each header, combining values if header already exists.
WebClientRequestHeaders	addCookie(String name, String value)	Add a cookie to the request.
WebClientRequestHeaders	contentLength(long length)	Set a content length.
WebClientRequestHeaders	contentType(HttpMediaType contentType)	Set a content type.
List<String>	ifMatch()	Returns value of header Http.Header.IF_MATCH.
WebClientRequestHeaders	ifMatch(String... etags)	Sets Http.Header.IF_MATCH header to specific etags.
WebClientRequestHeaders	ifModifiedSince(ZonedDateTime time)	Sets Http.Header.IF_MODIFIED_SINCE header to specific time.
List<String>	ifNoneMatch()	Returns value of header Http.Header.IF_NONE_MATCH.
WebClientRequestHeaders	ifNoneMatch(String... etags)	Sets Http.Header.IF_NONE_MATCH header to specific etags.
WebClientRequestHeaders	ifRange(String etag)	Sets Http.Header.IF_RANGE header to specific etag.
WebClientRequestHeaders	ifRange(ZonedDateTime time)	Sets Http.Header.IF_RANGE header to specific time.
Optional<ZonedDateTime>	ifRangeDate()	Returns value of header Http.Header.IF_RANGE as a ZonedDateTime.
Optional<String>	ifRangeString()	Returns value of header Http.Header.IF_RANGE as a String.
WebClientRequestHeaders	ifUnmodifiedSince(ZonedDateTime time)	Sets Http.Header.IF_UNMODIFIED_SINCE header to specific time.
WebClientRequestHeaders	putAll(Headers parameters)	Add each header, replacing values if header already exists.
WebClientRequestHeaders	unsetHeader(Http.HeaderName name)	Remove a header if set.
default WebClientRequestHeaders	unsetHeader(String name)	Deprecated. use unsetHeader(io.helidon.common.http.Http.HeaderName)

Methods inherited from interface io.helidon.common.http.ClientRequestHeaders

accept

Methods inherited from interface io.helidon.common.http.Headers

acceptedTypes, all, all, contains, contains, contentLength, contentType, first, get, size, toMap, value, values

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface io.helidon.common.http.ServerRequestHeaders

acceptDatetime, bestAccepted, cookies, date, ifModifiedSince, ifUnmodifiedSince, isAccepted, referer

Methods inherited from interface io.helidon.common.http.WritableHeaders

add, clear, contentType, remove, remove, set, set, set, setIfAbsent

Method Details

unsetHeader

@Deprecated
default WebClientRequestHeaders unsetHeader(String name)

Deprecated.

use unsetHeader(io.helidon.common.http.Http.HeaderName)

Remove a header if set.

Parameters:

name - header name

Returns:

updated headers instance

unsetHeader

WebClientRequestHeaders unsetHeader(Http.HeaderName name)

Remove a header if set.

Parameters:

name - header name

Returns:

updated headers instance

addCookie

WebClientRequestHeaders addCookie(String name,
 String value)

Add a cookie to the request.

Parameters:

name - cookie name

value - cookie value

Returns:

updated headers instance

contentType

WebClientRequestHeaders contentType(HttpMediaType contentType)

Set a content type. This method is optional if you use a writer for a specific type. If the content type is explicitly defined, writer will NOT override it.

Specified by:

contentType in interface WritableHeaders<ClientRequestHeaders>

Parameters:

contentType - content type of the request

Returns:

updated headers instance

contentLength

WebClientRequestHeaders contentLength(long length)

Set a content length. This method is optional. Use only when you know the exact length of entity in bytes.

Specified by:

contentLength in interface WritableHeaders<ClientRequestHeaders>

Parameters:

length - content length of entity

Returns:

updated headers instance

addAccept

WebClientRequestHeaders addAccept(HttpMediaType mediaType)

Add accepted HttpMediaType. Supports quality factor and wildcards. Ordered by invocation order.

Parameters:

mediaType - media type to accept, with optional quality factor

Returns:

updated headers instance

ifModifiedSince

WebClientRequestHeaders ifModifiedSince(ZonedDateTime time)

Sets Http.Header.IF_MODIFIED_SINCE header to specific time.

Parameters:

time - zoned date time

Returns:

updated headers instance

ifUnmodifiedSince

WebClientRequestHeaders ifUnmodifiedSince(ZonedDateTime time)

Sets Http.Header.IF_UNMODIFIED_SINCE header to specific time.

Parameters:

time - zoned date time

Returns:

updated headers instance

ifNoneMatch

WebClientRequestHeaders ifNoneMatch(String... etags)

Sets Http.Header.IF_NONE_MATCH header to specific etags.

Parameters:

etags - etags

Returns:

updated headers instance

ifMatch

WebClientRequestHeaders ifMatch(String... etags)

Sets Http.Header.IF_MATCH header to specific etags.

Parameters:

etags - etags

Returns:

updated headers instance

ifRange

WebClientRequestHeaders ifRange(ZonedDateTime time)

Sets Http.Header.IF_RANGE header to specific time.

Parameters:

time - zoned date time

Returns:

updated headers instance

ifRange

WebClientRequestHeaders ifRange(String etag)

Sets Http.Header.IF_RANGE header to specific etag.

Parameters:

etag - etag

Returns:

updated headers instance

ifNoneMatch

List<String> ifNoneMatch()

Returns value of header Http.Header.IF_NONE_MATCH. Empty List is returned if this header is not set.

Returns:

A list of etags.

ifMatch

List<String> ifMatch()

Returns value of header Http.Header.IF_MATCH. Empty List is returned if this header is not set.

Returns:

A list of etags.

ifRangeDate

Optional<ZonedDateTime> ifRangeDate()

Returns value of header Http.Header.IF_RANGE as a ZonedDateTime.

Returns:

formatted header IF_RANGE as ZonedDateTime

ifRangeString

Optional<String> ifRangeString()

Returns value of header Http.Header.IF_RANGE as a String.

Returns:

formatted header IF_RANGE as String

putAll

WebClientRequestHeaders putAll(Headers parameters)

Add each header, replacing values if header already exists.

Parameters:

parameters - headers

Returns:

updated headers

add

@Deprecated
WebClientRequestHeaders add(String key,
 String... values)

Deprecated.

use add(io.helidon.common.http.Http.HeaderName, String...)

Add header values.

Parameters:

key - header name

values - header values

Returns:

updated headers

add

default WebClientRequestHeaders add(Http.HeaderName key,
 String... values)

Add header values.

Specified by:

add in interface WritableHeaders<ClientRequestHeaders>

Parameters:

key - header name

values - header values

Returns:

updated headers

addAll

WebClientRequestHeaders addAll(Headers parameters)

Add each header, combining values if header already exists.

Parameters:

parameters - headers

Returns:

updated headers