Interface ClientResponseHeaders

All Superinterfaces:

Headers, Iterable<Header>

All Known Subinterfaces:

ServerResponseHeaders

public interface ClientResponseHeaders
extends Headers

HTTP Headers of a client response.

Method Summary

Modifier and Type	Method	Description
default List<HttpMediaType>	acceptPatches()	Accepted patches.
default List<HttpMediaType>	acceptQueries()	Media types supported by the resource for Method.QUERY request content.
static ClientResponseHeaders	create(Headers responseHeaders)	Create a new instance from headers parsed from client response.
static ClientResponseHeaders	create(Headers responseHeaders, ParserMode parserMode)	Create a new instance from headers parsed from client response.
default Optional<ZonedDateTime>	expires()	Optionally gets the value of HeaderNames.EXPIRES header.
default Optional<ZonedDateTime>	lastModified()	Optionally gets the value of HeaderNames.LAST_MODIFIED header.
default Optional<URI>	location()	Optionally gets the value of HeaderNames.LOCATION header.

Methods inherited from interface Headers

acceptedTypes, all, contains, contains, containsToken, contentLength, contentType, find, first, get, isAccepted, 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.
default boolean	isAccepted(MediaType... mediaTypes)	Whether this media type is accepted by these headers.
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

Method Details

create

static ClientResponseHeaders create(Headers responseHeaders)

Create a new instance from headers parsed from client response. Strict media type parsing mode is used for Content-Type header.

Parameters:

responseHeaders - client response headers

Returns:

immutable instance of client response HTTP headers

create

static ClientResponseHeaders create(Headers responseHeaders,
 ParserMode parserMode)

Create a new instance from headers parsed from client response.

Parameters:

responseHeaders - client response headers

parserMode - media type parsing mode

Returns:

immutable instance of client response HTTP headers

acceptPatches

default List<HttpMediaType> acceptPatches()

Accepted patches.

Returns:

list of accepted patches media types

acceptQueries

default List<HttpMediaType> acceptQueries()

Media types supported by the resource for Method.QUERY request content.

Returns:

list of accepted QUERY media types, or an empty list if the header is absent or invalid

location

default Optional<URI> location()

Optionally gets the value of HeaderNames.LOCATION header.

Used in redirection, or when a new resource has been created.

Returns:

Location header value.

lastModified

default Optional<ZonedDateTime> lastModified()

Optionally gets the value of HeaderNames.LAST_MODIFIED header.

The last modified date for the requested object.

Returns:

Last modified header value.

expires

default Optional<ZonedDateTime> expires()

Optionally gets the value of HeaderNames.EXPIRES header.

Gives the date/time after which the response is considered stale.

Returns:

Expires header value.