Package io.micronaut.http

Interface HttpHeaders

All Superinterfaces:

ConversionServiceProvider, ConvertibleMultiValues<String>, ConvertibleValues<List<String>>, Headers, Iterable<Map.Entry<String,List<String>>>, ValueResolver<CharSequence>

All Known Subinterfaces:

MutableHttpHeaders

All Known Implementing Classes:

CaseInsensitiveMutableHttpHeaders, HttpHeadersAdapter, NettyHttpHeaders, SimpleHttpHeaders

public interface HttpHeaders
extends Headers

Constants for common HTTP headers. See https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCEPT	"Accept".
static final String	ACCEPT_CH	"Accept-CH".
static final String	ACCEPT_CH_LIFETIME	"Accept-CH".
static final String	ACCEPT_CHARSET	"Accept-Charset".
static final String	ACCEPT_ENCODING	"Accept-Encoding".
static final String	ACCEPT_LANGUAGE	"Accept-Language".
static final String	ACCEPT_PATCH	"Accept-Patch".
static final String	ACCEPT_RANGES	"Accept-Ranges".
static final String	ACCESS_CONTROL_ALLOW_CREDENTIALS	"Access-Control-Allow-Credentials".
static final String	ACCESS_CONTROL_ALLOW_HEADERS	"Access-Control-Allow-Headers".
static final String	ACCESS_CONTROL_ALLOW_METHODS	"Access-Control-Allow-Methods".
static final String	ACCESS_CONTROL_ALLOW_ORIGIN	"Access-Control-Allow-Origin".
static final String	ACCESS_CONTROL_ALLOW_PRIVATE_NETWORK	"Access-Control-Allow-Private-Network".
static final String	ACCESS_CONTROL_EXPOSE_HEADERS	"Access-Control-Expose-Headers".
static final String	ACCESS_CONTROL_MAX_AGE	"Access-Control-Max-Age".
static final String	ACCESS_CONTROL_REQUEST_HEADERS	"Access-Control-Request-Headers".
static final String	ACCESS_CONTROL_REQUEST_METHOD	"Access-Control-Request-Method".
static final String	ACCESS_CONTROL_REQUEST_PRIVATE_NETWORK	"Access-Control-Request-Private-Network".
static final String	AGE	"Age".
static final String	ALLOW	"Allow".
static final String	AUTHORIZATION	"Authorization".
static final String	AUTHORIZATION_INFO	"Authorization".
static final String	CACHE_CONTROL	"Cache-Control".
static final String	CONNECTION	"Connection".
static final String	CONTENT_BASE	"Content-Base".
static final String	CONTENT_DISPOSITION	"Content-Disposition".
static final String	CONTENT_DPR	"Content-DPR".
static final String	CONTENT_ENCODING	"Content-Encoding".
static final String	CONTENT_LANGUAGE	"Content-Language".
static final String	CONTENT_LENGTH	"Content-Length".
static final String	CONTENT_LOCATION	"Content-Location".
static final String	CONTENT_MD5	"Content-MD5".
static final String	CONTENT_RANGE	"Content-Range".
static final String	CONTENT_TRANSFER_ENCODING	"Content-Transfer-Encoding".
static final String	CONTENT_TYPE	"Content-Type".
static final String	COOKIE	"Cookie".
static final String	CROSS_ORIGIN_RESOURCE_POLICY	"Cross-Origin-Resource-Policy".
static final String	DATE	"Date".
static final String	DEVICE_MEMORY	"Device-Memory".
static final String	DOWNLINK	"Downlink".
static final String	DPR	"DPR".
static final String	ECT	"ECT".
static final String	ETAG	"ETag".
static final String	EXPECT	"Expect".
static final String	EXPIRES	"Expires".
static final String	FEATURE_POLICY	"Feature-Policy".
static final String	FORWARDED	"Forwarded".
static final String	FROM	"From".
static final String	HOST	"Host".
static final String	IF_MATCH	"If-Match".
static final String	IF_MODIFIED_SINCE	"If-Modified-Since".
static final String	IF_NONE_MATCH	"If-None-Match".
static final String	IF_RANGE	"If-Range".
static final String	IF_UNMODIFIED_SINCE	"If-Unmodified-Since".
static final String	LAST_MODIFIED	"Last-Modified".
static final String	LINK	"Link".
static final String	LOCATION	"Location".
static final String	MAX_FORWARDS	"Max-Forwards".
static final String	ORIGIN	"Origin".
static final String	PRAGMA	"Pragma".
static final String	PROXY_AUTHENTICATE	"Proxy-Authenticate".
static final String	PROXY_AUTHORIZATION	"Proxy-Authorization".
static final String	RANGE	"Range".
static final String	REFERER	"Referer".
static final String	REFERRER_POLICY	"Referrer-Policy".
static final String	RETRY_AFTER	"Retry-After".
static final String	RTT	"RTT".
static final String	SAVE_DATA	"Save-Data".
static final String	SEC_WEBSOCKET_ACCEPT	"Sec-WebSocket-Accept".
static final String	SEC_WEBSOCKET_KEY	"Sec-WebSocket-Key".
static final String	SEC_WEBSOCKET_KEY1	"Sec-WebSocket-Key1".
static final String	SEC_WEBSOCKET_KEY2	"Sec-WebSocket-Key2".
static final String	SEC_WEBSOCKET_LOCATION	"Sec-WebSocket-Location".
static final String	SEC_WEBSOCKET_ORIGIN	"Sec-WebSocket-Origin".
static final String	SEC_WEBSOCKET_PROTOCOL	"Sec-WebSocket-Protocol".
static final String	SEC_WEBSOCKET_VERSION	"Sec-WebSocket-Version".
static final String	SERVER	"Server".
static final String	SET_COOKIE	"Set-Cookie".
static final String	SET_COOKIE2	"Set-Cookie2".
static final String	SOURCE_MAP	"Source-Map".
static final List<String>	STANDARD_HEADERS	Unmodifiable List of every header constant defined in HttpHeaders.
static final String	TE	"TE".
static final String	TRAILER	"Trailer".
static final String	TRANSFER_ENCODING	"Transfer-Encoding".
static final String	UPGRADE	"Upgrade".
static final String	USER_AGENT	"User-Agent".
static final String	VARY	"Vary".
static final String	VIA	"Via".
static final String	VIEWPORT_WIDTH	"Viewport-Width".
static final String	WARNING	"Warning".
static final String	WEBSOCKET_LOCATION	"WebSocket-Location".
static final String	WEBSOCKET_ORIGIN	"WebSocket-Origin".
static final String	WEBSOCKET_PROTOCOL	"WebSocket-Protocol".
static final String	WIDTH	"Width".
static final String	WWW_AUTHENTICATE	"WWW-Authenticate".
static final String	X_AUTH_TOKEN	"X-Auth-Token".

Fields inherited from interface io.micronaut.core.convert.value.ConvertibleValues

EMPTY

Method Summary

Modifier and Type	Method	Description
default List<MediaType>	accept()	A list of accepted MediaType instances.
default Charset	acceptCharset()	The Accept-Charset header, or null if unset.
default Locale	acceptLanguage()	The Accept-Language header, or null if unset.
default boolean	contains(CharSequence name)	Whether the given key is contained within these values.
default OptionalLong	contentLength()	The request or response content type.
default Optional<MediaType>	contentType()	The request or response content type.
default Optional<Charset>	findAcceptCharset()	The Accept-Charset header, or empty if unset.
default Optional<Locale>	findAcceptLanguage()	The Accept-Language header, or empty if unset.
default Optional<ZonedDateTime>	findDate(CharSequence name)	Obtain the date header.
default Optional<String>	findFirst(CharSequence name)	Get the first value of the given header.
default Optional<Integer>	findInt(CharSequence name)	Find an integer header.
default Optional<String>	getAuthorization()
default Optional<String>	getContentType()
default ZonedDateTime	getDate(CharSequence name)	Obtain the date header.
default Integer	getInt(CharSequence name)	Obtain an integer header.
default Optional<String>	getOrigin()
default boolean	isKeepAlive()

Methods inherited from interface io.micronaut.core.convert.value.ConvertibleMultiValues

forEach, forEachValue, get, getAll, getFirst, getFirst, getFirst, getFirst, getFirst, isEmpty, iterator

Methods inherited from interface io.micronaut.core.convert.value.ConvertibleValues

asMap, asMap, asProperties, contains, getConversionService, getValue, getValueType, names, subMap, subMap, subMap, values

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface io.micronaut.core.value.ValueResolver

get, get, get, get

Field Details

ACCEPT

static final String ACCEPT

"Accept".

See Also:

• Constant Field Values

ACCEPT_CH

static final String ACCEPT_CH

"Accept-CH".

See Also:

• Constant Field Values

ACCEPT_CH_LIFETIME

static final String ACCEPT_CH_LIFETIME

"Accept-CH".

See Also:

• Constant Field Values

ACCEPT_CHARSET

static final String ACCEPT_CHARSET

"Accept-Charset".

See Also:

• Constant Field Values

ACCEPT_ENCODING

static final String ACCEPT_ENCODING

"Accept-Encoding".

See Also:

• Constant Field Values

ACCEPT_LANGUAGE

static final String ACCEPT_LANGUAGE

"Accept-Language".

See Also:

• Constant Field Values

ACCEPT_RANGES

static final String ACCEPT_RANGES

"Accept-Ranges".

See Also:

• Constant Field Values

ACCEPT_PATCH

static final String ACCEPT_PATCH

"Accept-Patch".

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_CREDENTIALS

static final String ACCESS_CONTROL_ALLOW_CREDENTIALS

"Access-Control-Allow-Credentials".

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_HEADERS

static final String ACCESS_CONTROL_ALLOW_HEADERS

"Access-Control-Allow-Headers".

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_METHODS

static final String ACCESS_CONTROL_ALLOW_METHODS

"Access-Control-Allow-Methods".

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_ORIGIN

static final String ACCESS_CONTROL_ALLOW_ORIGIN

"Access-Control-Allow-Origin".

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_PRIVATE_NETWORK

static final String ACCESS_CONTROL_ALLOW_PRIVATE_NETWORK

"Access-Control-Allow-Private-Network".

Since:

4.3.0

See Also:

• Private Network Access
• Constant Field Values

ACCESS_CONTROL_EXPOSE_HEADERS

static final String ACCESS_CONTROL_EXPOSE_HEADERS

"Access-Control-Expose-Headers".

See Also:

• Constant Field Values

ACCESS_CONTROL_MAX_AGE

static final String ACCESS_CONTROL_MAX_AGE

"Access-Control-Max-Age".

See Also:

• Constant Field Values

ACCESS_CONTROL_REQUEST_HEADERS

static final String ACCESS_CONTROL_REQUEST_HEADERS

"Access-Control-Request-Headers".

See Also:

• Constant Field Values

ACCESS_CONTROL_REQUEST_METHOD

static final String ACCESS_CONTROL_REQUEST_METHOD

"Access-Control-Request-Method".

See Also:

• Constant Field Values

ACCESS_CONTROL_REQUEST_PRIVATE_NETWORK

static final String ACCESS_CONTROL_REQUEST_PRIVATE_NETWORK

"Access-Control-Request-Private-Network".

Since:

4.3.0

See Also:

• Private Network Access
• Constant Field Values

AGE

static final String AGE

"Age".

See Also:

• Constant Field Values

ALLOW

static final String ALLOW

"Allow".

See Also:

• Constant Field Values

AUTHORIZATION

static final String AUTHORIZATION

"Authorization".

See Also:

• Constant Field Values

AUTHORIZATION_INFO

static final String AUTHORIZATION_INFO

"Authorization".

See Also:

• Constant Field Values

CACHE_CONTROL

static final String CACHE_CONTROL

"Cache-Control".

See Also:

• Constant Field Values

CONNECTION

static final String CONNECTION

"Connection".

See Also:

• Constant Field Values

CONTENT_BASE

static final String CONTENT_BASE

"Content-Base".

See Also:

• Constant Field Values

CONTENT_DISPOSITION

static final String CONTENT_DISPOSITION

"Content-Disposition".

See Also:

• Constant Field Values

CONTENT_DPR

static final String CONTENT_DPR

"Content-DPR".

See Also:

• Constant Field Values

CONTENT_ENCODING

static final String CONTENT_ENCODING

"Content-Encoding".

See Also:

• Constant Field Values

CONTENT_LANGUAGE

static final String CONTENT_LANGUAGE

"Content-Language".

See Also:

• Constant Field Values

CONTENT_LENGTH

static final String CONTENT_LENGTH

"Content-Length".

See Also:

• Constant Field Values

CONTENT_LOCATION

static final String CONTENT_LOCATION

"Content-Location".

See Also:

• Constant Field Values

CONTENT_TRANSFER_ENCODING

static final String CONTENT_TRANSFER_ENCODING

"Content-Transfer-Encoding".

See Also:

• Constant Field Values

CONTENT_MD5

static final String CONTENT_MD5

"Content-MD5".

See Also:

• Constant Field Values

CONTENT_RANGE

static final String CONTENT_RANGE

"Content-Range".

See Also:

• Constant Field Values

CONTENT_TYPE

static final String CONTENT_TYPE

"Content-Type".

See Also:

• Constant Field Values

COOKIE

static final String COOKIE

"Cookie".

See Also:

• Constant Field Values

CROSS_ORIGIN_RESOURCE_POLICY

static final String CROSS_ORIGIN_RESOURCE_POLICY

"Cross-Origin-Resource-Policy".

See Also:

• Constant Field Values

DATE

static final String DATE

"Date".

See Also:

• Constant Field Values

DEVICE_MEMORY

static final String DEVICE_MEMORY

"Device-Memory".

See Also:

• Constant Field Values

DOWNLINK

static final String DOWNLINK

"Downlink".

See Also:

• Constant Field Values

DPR

static final String DPR

"DPR".

See Also:

• Constant Field Values

ECT

static final String ECT

"ECT".

See Also:

• Constant Field Values

ETAG

static final String ETAG

"ETag".

See Also:

• Constant Field Values

EXPECT

static final String EXPECT

"Expect".

See Also:

• Constant Field Values

EXPIRES

static final String EXPIRES

"Expires".

See Also:

• Constant Field Values

FEATURE_POLICY

static final String FEATURE_POLICY

"Feature-Policy".

See Also:

• Constant Field Values

FORWARDED

static final String FORWARDED

"Forwarded".

See Also:

• Constant Field Values

FROM

static final String FROM

"From".

See Also:

• Constant Field Values

HOST

static final String HOST

"Host".

See Also:

• Constant Field Values

IF_MATCH

static final String IF_MATCH

"If-Match".

See Also:

• Constant Field Values

IF_MODIFIED_SINCE

static final String IF_MODIFIED_SINCE

"If-Modified-Since".

See Also:

• Constant Field Values

IF_NONE_MATCH

static final String IF_NONE_MATCH

"If-None-Match".

See Also:

• Constant Field Values

IF_RANGE

static final String IF_RANGE

"If-Range".

See Also:

• Constant Field Values

IF_UNMODIFIED_SINCE

static final String IF_UNMODIFIED_SINCE

"If-Unmodified-Since".

See Also:

• Constant Field Values

LAST_MODIFIED

static final String LAST_MODIFIED

"Last-Modified".

See Also:

• Constant Field Values

LINK

static final String LINK

"Link".

See Also:

• Constant Field Values

LOCATION

static final String LOCATION

"Location".

See Also:

• Constant Field Values

MAX_FORWARDS

static final String MAX_FORWARDS

"Max-Forwards".

See Also:

• Constant Field Values

ORIGIN

static final String ORIGIN

"Origin".

See Also:

• Constant Field Values

PRAGMA

static final String PRAGMA

"Pragma".

See Also:

• Constant Field Values

PROXY_AUTHENTICATE

static final String PROXY_AUTHENTICATE

"Proxy-Authenticate".

See Also:

• Constant Field Values

PROXY_AUTHORIZATION

static final String PROXY_AUTHORIZATION

"Proxy-Authorization".

See Also:

• Constant Field Values

RANGE

static final String RANGE

"Range".

See Also:

• Constant Field Values

REFERER

static final String REFERER

"Referer".

See Also:

• Constant Field Values

REFERRER_POLICY

static final String REFERRER_POLICY

"Referrer-Policy".

See Also:

• Constant Field Values

RETRY_AFTER

static final String RETRY_AFTER

"Retry-After".

See Also:

• Constant Field Values

RTT

static final String RTT

"RTT".

See Also:

• Constant Field Values

SAVE_DATA

static final String SAVE_DATA

"Save-Data".

See Also:

• Constant Field Values

SEC_WEBSOCKET_KEY1

static final String SEC_WEBSOCKET_KEY1

"Sec-WebSocket-Key1".

See Also:

• Constant Field Values

SEC_WEBSOCKET_KEY2

static final String SEC_WEBSOCKET_KEY2

"Sec-WebSocket-Key2".

See Also:

• Constant Field Values

SEC_WEBSOCKET_LOCATION

static final String SEC_WEBSOCKET_LOCATION

"Sec-WebSocket-Location".

See Also:

• Constant Field Values

SEC_WEBSOCKET_ORIGIN

static final String SEC_WEBSOCKET_ORIGIN

"Sec-WebSocket-Origin".

See Also:

• Constant Field Values

SEC_WEBSOCKET_PROTOCOL

static final String SEC_WEBSOCKET_PROTOCOL

"Sec-WebSocket-Protocol".

See Also:

• Constant Field Values

SEC_WEBSOCKET_VERSION

static final String SEC_WEBSOCKET_VERSION

"Sec-WebSocket-Version".

See Also:

• Constant Field Values

SEC_WEBSOCKET_KEY

static final String SEC_WEBSOCKET_KEY

"Sec-WebSocket-Key".

See Also:

• Constant Field Values

SEC_WEBSOCKET_ACCEPT

static final String SEC_WEBSOCKET_ACCEPT

"Sec-WebSocket-Accept".

See Also:

• Constant Field Values

SERVER

static final String SERVER

"Server".

See Also:

• Constant Field Values

SET_COOKIE

static final String SET_COOKIE

"Set-Cookie".

See Also:

• Constant Field Values

SET_COOKIE2

static final String SET_COOKIE2

"Set-Cookie2".

See Also:

• Constant Field Values

SOURCE_MAP

static final String SOURCE_MAP

"Source-Map".

See Also:

• Constant Field Values

TE

static final String TE

"TE".

See Also:

• Constant Field Values

TRAILER

static final String TRAILER

"Trailer".

See Also:

• Constant Field Values

TRANSFER_ENCODING

static final String TRANSFER_ENCODING

"Transfer-Encoding".

See Also:

• Constant Field Values

UPGRADE

static final String UPGRADE

"Upgrade".

See Also:

• Constant Field Values

USER_AGENT

static final String USER_AGENT

"User-Agent".

See Also:

• Constant Field Values

VARY

static final String VARY

"Vary".

See Also:

• Constant Field Values

VIA

static final String VIA

"Via".

See Also:

• Constant Field Values

VIEWPORT_WIDTH

static final String VIEWPORT_WIDTH

"Viewport-Width".

See Also:

• Constant Field Values

WARNING

static final String WARNING

"Warning".

See Also:

• Constant Field Values

WEBSOCKET_LOCATION

static final String WEBSOCKET_LOCATION

"WebSocket-Location".

See Also:

• Constant Field Values

WEBSOCKET_ORIGIN

static final String WEBSOCKET_ORIGIN

"WebSocket-Origin".

See Also:

• Constant Field Values

WEBSOCKET_PROTOCOL

static final String WEBSOCKET_PROTOCOL

"WebSocket-Protocol".

See Also:

• Constant Field Values

WIDTH

static final String WIDTH

"Width".

See Also:

• Constant Field Values

WWW_AUTHENTICATE

static final String WWW_AUTHENTICATE

"WWW-Authenticate".

See Also:

• Constant Field Values

X_AUTH_TOKEN

static final String X_AUTH_TOKEN

"X-Auth-Token".

See Also:

• Constant Field Values

STANDARD_HEADERS

static final List<String> STANDARD_HEADERS

Unmodifiable List of every header constant defined in HttpHeaders.

Method Details

contains

default boolean contains(CharSequence name)

Whether the given key is contained within these values.

Parameters:

name - The key name

Returns:

True if it is

Since:

4.8.0

findDate

default Optional<ZonedDateTime> findDate(CharSequence name)

Obtain the date header.

Parameters:

name - The header name

Returns:

The date header as a ZonedDateTime otherwise if it is not present or cannot be parsed Optional.empty()

getDate

default ZonedDateTime getDate(CharSequence name)

Obtain the date header.

Parameters:

name - The header name

Returns:

The date header as a ZonedDateTime otherwise if it is not present or cannot be parsed null

getInt

default Integer getInt(CharSequence name)

Obtain an integer header.

Parameters:

name - The header name

Returns:

The date header as a ZonedDateTime otherwise if it is not present or cannot be parsed null

findInt

default Optional<Integer> findInt(CharSequence name)

Find an integer header.

Parameters:

name - The name of the header

Returns:

An Optional of Integer

findFirst

default Optional<String> findFirst(CharSequence name)

Get the first value of the given header.

Parameters:

name - The header name

Returns:

The first value or null if it is present

contentType

default Optional<MediaType> contentType()

The request or response content type.

Returns:

The content type

contentLength

default OptionalLong contentLength()

The request or response content type.

Returns:

The content type

accept

default List<MediaType> accept()

A list of accepted MediaType instances.

Returns:

A list of zero or many MediaType instances

acceptCharset

@Nullable
default Charset acceptCharset()

The Accept-Charset header, or null if unset.

Returns:

The Accept-Charset header

Since:

4.0.0

findAcceptCharset

default Optional<Charset> findAcceptCharset()

The Accept-Charset header, or empty if unset.

Returns:

The Accept-Charset header

Since:

4.3.0

acceptLanguage

@Nullable
default Locale acceptLanguage()

The Accept-Language header, or null if unset.

Returns:

The Accept-Language header

Since:

4.0.0

findAcceptLanguage

default Optional<Locale> findAcceptLanguage()

The Accept-Language header, or empty if unset.

Returns:

The Accept-Language header

Since:

4.3.0

isKeepAlive

default boolean isKeepAlive()

Returns:

Whether the CONNECTION header is set to Keep-Alive

getOrigin

default Optional<String> getOrigin()

Returns:

The ORIGIN header

getAuthorization

default Optional<String> getAuthorization()

Returns:

The AUTHORIZATION header

getContentType

default Optional<String> getContentType()

Returns:

The CONTENT_TYPE header