Package io.helidon.webserver

Interface RequestHeaders

All Superinterfaces:

Headers, Parameters

public interface RequestHeaders
extends Headers

Extends Parameters interface by adding HTTP request headers oriented convenient methods. Use constants located in Http.Header as standard header names.

See Also:

Http.Header

Method Summary

Modifier and Type	Method	Description
java.util.Optional<java.time.ZonedDateTime>	acceptDatetime()	Optionally returns acceptedTypes version in time ("Accept-Datetime" header).
java.util.List<MediaType>	acceptedTypes()	Returns a list of acceptedTypes ("Accept" header) content types in quality factor order.
java.util.Optional<MediaType>	bestAccepted(MediaType... mediaTypes)	Optionally returns single media type from provided parameters which is best accepted by the client.
java.util.OptionalLong	contentLength()	Optionally returns the length of the request body in octets (8-bit bytes).
java.util.Optional<MediaType>	contentType()	Optionally returns the MIME type of the body of the request.
Parameters	cookies()	Returns cookies (parsed from 'Cookie:' header) based on RFC6265.
java.util.Optional<java.time.ZonedDateTime>	date()	Optionally returns request date ("Accept-Datetime" header).
java.util.Optional<java.time.ZonedDateTime>	ifModifiedSince()	Optionally returns a value of "If-Modified-Since" header.
java.util.Optional<java.time.ZonedDateTime>	ifUnmodifiedSince()	Optionally returns a value of "If-Unmodified-Since" header.
boolean	isAccepted(MediaType mediaType)	Test if provided type is acceptable as a response for this request.
java.util.Optional<java.net.URI>	referer()	Optionally returns the address of the previous web page (header "Referer") from which a link to the currently requested page was followed.

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

all, value, values

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

add, add, addAll, computeIfAbsent, computeSingleIfAbsent, first, put, put, putAll, putIfAbsent, putIfAbsent, remove, toMap, toUnmodifiableParameters

Method Detail

contentType

java.util.Optional<MediaType> contentType()

Optionally returns the MIME type of the body of the request.

Returns:

Media type of the content.

contentLength

java.util.OptionalLong contentLength()

Optionally returns the length of the request body in octets (8-bit bytes).

Returns:

Length of the body in octets.

cookies

Parameters cookies()

Returns cookies (parsed from 'Cookie:' header) based on RFC6265. It parse also older formats including RFC2965 but skips parameters. Only cookie name and value is returned.

Multiple cookies can be returned in a single headers and a single cookie-name can have multiple values. Note that base on RFC6265 an order of cookie values has no semantics.

Returns:

An unmodifiable cookies represented by Parameters interface where key is a name of the cookie and values are cookie values.

acceptedTypes

java.util.List<MediaType> acceptedTypes()

Returns a list of acceptedTypes ("Accept" header) content types in quality factor order. Never null.

Returns:

A list of acceptedTypes media types.

isAccepted

boolean isAccepted(MediaType mediaType)

Test if provided type is acceptable as a response for this request.

Parameters:

mediaType - a media type to test if it is acceptable.

Returns:

true if provided type is acceptable.

Throws:

java.lang.NullPointerException - if parameter mediaType is null.

bestAccepted

java.util.Optional<MediaType> bestAccepted(MediaType... mediaTypes)

Optionally returns single media type from provided parameters which is best accepted by the client. Method uses content negotiation "Accept" header parameter and returns an empty value in case that nothing match.

Parameters:

mediaTypes - Supported media type candidates.

Returns:

an accepted media type.

acceptDatetime

java.util.Optional<java.time.ZonedDateTime> acceptDatetime()

Optionally returns acceptedTypes version in time ("Accept-Datetime" header).

Returns:

Acceptable version in time.

date

java.util.Optional<java.time.ZonedDateTime> date()

Optionally returns request date ("Accept-Datetime" header).

Returns:

Request date.

ifModifiedSince

java.util.Optional<java.time.ZonedDateTime> ifModifiedSince()

Optionally returns a value of "If-Modified-Since" header.

Allows a 304 Not Modified to be returned if content is unchanged.

Returns:

Content of "If-Modified-Since" header.

ifUnmodifiedSince

java.util.Optional<java.time.ZonedDateTime> ifUnmodifiedSince()

Optionally returns a value of "If-Unmodified-Since" header.

Only send the response if the entity has not been modified since a specific time.

Returns:

Content of "If-Modified-Since" header.

referer

java.util.Optional<java.net.URI> referer()

Optionally returns the address of the previous web page (header "Referer") from which a link to the currently requested page was followed.

The word referrer has been misspelled in the RFC as well as in most implementations to the point that it has become standard usage and is considered correct terminology

Returns:

Referrers URI