Interface ClientRequestHeaders

All Superinterfaces:

Headers, Iterable<Header>, ServerRequestHeaders, WritableHeaders<ClientRequestHeaders>

public interface ClientRequestHeaders
extends ServerRequestHeaders, WritableHeaders<ClientRequestHeaders>

Mutable headers of a client request.

Field Summary

Fields inherited from interface ServerRequestHeaders

HUC_ACCEPT_DEFAULT, HUC_ACCEPT_DEFAULT_TYPES

Modifier and Type	Field	Description
static final Header	HUC_ACCEPT_DEFAULT	Header value of the non compliant Accept header sent by HttpURLConnection when none is set.
static final List<HttpMediaType>	HUC_ACCEPT_DEFAULT_TYPES	Accepted types for ServerRequestHeaders.HUC_ACCEPT_DEFAULT.

Method Summary

Modifier and Type	Method	Description
default ClientRequestHeaders	accept(MediaType... accepted)	Accepted media types.
static ClientRequestHeaders	create(Headers headers)	Create client request headers from headers.
static ClientRequestHeaders	create(WritableHeaders<?> delegate)	Create client request headers from writable headers.

Methods inherited from interface Headers

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

Modifier and Type	Method	Description
List<HttpMediaType>	acceptedTypes()	Returns a list of acceptedTypes (HeaderNames.ACCEPT header) content discoveryTypes in quality factor order.
List<String>	all(HeaderName name, Supplier<List<String>> defaultSupplier)	Get all values of a header.
boolean	contains(Header value)	Whether these headers contain a header with the provided name and value.
boolean	contains(HeaderName name)	Whether these headers contain a header with the provided name.
default boolean	containsToken(Header value)	Whether these headers contain all tokenized values from the provided header.
default OptionalLong	contentLength()	Content length if defined.
default Optional<HttpMediaType>	contentType()	Content type (if defined).
default Optional<Header>	find(HeaderName headerName)	Find the first header.
default Optional<String>	first(HeaderName headerName)	Returns a first header value.
Header	get(HeaderName name)	Get a header value.
int	size()	Number of headers in these headers.
default Stream<Header>	stream()	A sequential stream with these headers as the source.
default Map<String, List<String>>	toMap()	Deprecated. use other methods to handle headers, preferably using pull approach
default Optional<String>	value(HeaderName headerName)	Returns a header value as a single String potentially concatenated using comma character from Headers.all(HeaderName, java.util.function.Supplier) header fields.
default List<String>	values(HeaderName headerName)	Returns an unmodifiable List of all comma separated header value parts - Such segmentation is NOT valid for all header semantics, however it is very common.

Methods inherited from interface Iterable

forEach, iterator, spliterator

Methods inherited from interface ServerRequestHeaders

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

Modifier and Type	Method	Description
default Optional<ZonedDateTime>	acceptDatetime()	Optionally returns acceptedTypes version in time (HeaderNames.ACCEPT_DATETIME header).
default Optional<MediaType>	bestAccepted(MediaType... mediaTypes)	Optionally returns a single media type from the given media types that is the best one accepted by the client.
default Parameters	cookies()	Returns cookies (parsed from 'Cookie:' header) based on RFC6265.
default Optional<ZonedDateTime>	date()	Optionally returns request date (HeaderNames.DATE header).
default Optional<ZonedDateTime>	ifModifiedSince()	Optionally returns a value of HeaderNames.IF_MODIFIED_SINCE header.
default Optional<ZonedDateTime>	ifUnmodifiedSince()	Optionally returns a value of HeaderNames.IF_UNMODIFIED_SINCE header.
default boolean	isAccepted(MediaType... mediaTypes)	Test if the given media type is acceptable as a response for this request.
default Optional<URI>	referer()	Optionally returns the address of the previous web page (header HeaderNames.REFERER) from which a link to the currently requested page was followed.
default boolean	testContentType(MediaType... mediaTypes)	Check if the content type provided over the network matches one of the content types.

Methods inherited from interface WritableHeaders

add, add, add, add, clear, contentLength, contentType, from, remove, remove, set, set, set, set, set, setIfAbsent

Modifier and Type	Method	Description
ClientRequestHeaders	add(Header header)	Add a header or add a header value if the header is already present.
default ClientRequestHeaders	add(HeaderName header, int value)	Add a header or add a header value if the header is already present.
default ClientRequestHeaders	add(HeaderName header, long value)	Add a header or add a header value if the header is already present.
default ClientRequestHeaders	add(HeaderName header, String... value)	Add a header or add a header value if the header is already present.
ClientRequestHeaders	clear()	Clear all current headers.
default ClientRequestHeaders	contentLength(long length)	Content length of the entity in bytes.
default ClientRequestHeaders	contentType(MediaType contentType)	Sets the MIME type of the response body.
ClientRequestHeaders	from(Headers headers)	For each header from the provided headers, set its value on these headers.
ClientRequestHeaders	remove(HeaderName name)	Remove a header.
ClientRequestHeaders	remove(HeaderName name, Consumer<Header> removedConsumer)	Remove a header.
ClientRequestHeaders	set(Header header)	Set a header and replace it if it already existed.
default ClientRequestHeaders	set(HeaderName name, int value)	Set a header and replace it if it already existed.
default ClientRequestHeaders	set(HeaderName name, long value)	Set a header and replace it if it already existed.
default ClientRequestHeaders	set(HeaderName name, String... values)	Set a header and replace it if it already existed.
default ClientRequestHeaders	set(HeaderName name, Collection<String> values)	Set a header and replace it if it already existed.
ClientRequestHeaders	setIfAbsent(Header header)	Set a value of a header unless it is already present.

Method Details

create

static ClientRequestHeaders create(WritableHeaders<?> delegate)

Create client request headers from writable headers.

Parameters:

delegate - headers

Returns:

client request headers

create

static ClientRequestHeaders create(Headers headers)

Create client request headers from headers.

Parameters:

headers - headers

Returns:

client request headers

accept

default ClientRequestHeaders accept(MediaType... accepted)

Accepted media types. Supports quality factor and wildcards.

Parameters:

accepted - media types to accept

Returns:

updated headers