HttpHeaders (micronaut 1.1.4 API)

All Superinterfaces:

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

All Known Subinterfaces:

MutableHttpHeaders

All Known Implementing Classes:

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 and Description
`static String`	`ACCEPT` `"Accept"`.
`static String`	`ACCEPT_CHARSET` `"Accept-Charset"`.
`static String`	`ACCEPT_ENCODING` `"Accept-Encoding"`.
`static String`	`ACCEPT_LANGUAGE` `"Accept-Language"`.
`static String`	`ACCEPT_PATCH` `"Accept-Patch"`.
`static String`	`ACCEPT_RANGES` `"Accept-Ranges"`.
`static String`	`ACCESS_CONTROL_ALLOW_CREDENTIALS` `"Access-Control-Allow-Credentials"`.
`static String`	`ACCESS_CONTROL_ALLOW_HEADERS` `"Access-Control-Allow-Headers"`.
`static String`	`ACCESS_CONTROL_ALLOW_METHODS` `"Access-Control-Allow-Methods"`.
`static String`	`ACCESS_CONTROL_ALLOW_ORIGIN` `"Access-Control-Allow-Origin"`.
`static String`	`ACCESS_CONTROL_EXPOSE_HEADERS` `"Access-Control-Expose-Headers"`.
`static String`	`ACCESS_CONTROL_MAX_AGE` `"Access-Control-Max-Age"`.
`static String`	`ACCESS_CONTROL_REQUEST_HEADERS` `"Access-Control-Request-Headers"`.
`static String`	`ACCESS_CONTROL_REQUEST_METHOD` `"Access-Control-Request-Method"`.
`static String`	`AGE` `"Age"`.
`static String`	`ALLOW` `"Allow"`.
`static String`	`AUTHORIZATION` `"Authorization"`.
`static String`	`AUTHORIZATION_INFO` `"Authorization"`.
`static String`	`CACHE_CONTROL` `"Cache-Control"`.
`static String`	`CONNECTION` `"Connection"`.
`static String`	`CONTENT_BASE` `"Content-Base"`.
`static String`	`CONTENT_DISPOSITION` `"Content-Disposition"`.
`static String`	`CONTENT_ENCODING` `"Content-Encoding"`.
`static String`	`CONTENT_LANGUAGE` `"Content-Language"`.
`static String`	`CONTENT_LENGTH` `"Content-Length"`.
`static String`	`CONTENT_LOCATION` `"Content-Location"`.
`static String`	`CONTENT_MD5` `"Content-MD5"`.
`static String`	`CONTENT_RANGE` `"Content-Range"`.
`static String`	`CONTENT_TRANSFER_ENCODING` `"Content-Transfer-Encoding"`.
`static String`	`CONTENT_TYPE` `"Content-Type"`.
`static String`	`COOKIE` `"Cookie"`.
`static String`	`DATE` `"Date"`.
`static String`	`ETAG` `"ETag"`.
`static String`	`EXPECT` `"Expect"`.
`static String`	`EXPIRES` `"Expires"`.
`static String`	`FROM` `"From"`.
`static String`	`HOST` `"Host"`.
`static String`	`IF_MATCH` `"If-Match"`.
`static String`	`IF_MODIFIED_SINCE` `"If-Modified-Since"`.
`static String`	`IF_NONE_MATCH` `"If-None-Match"`.
`static String`	`IF_RANGE` `"If-Range"`.
`static String`	`IF_UNMODIFIED_SINCE` `"If-Unmodified-Since"`.
`static String`	`LAST_MODIFIED` `"Last-Modified"`.
`static String`	`LOCATION` `"Location"`.
`static String`	`MAX_FORWARDS` `"Max-Forwards"`.
`static String`	`ORIGIN` `"Origin"`.
`static String`	`PRAGMA` `"Pragma"`.
`static String`	`PROXY_AUTHENTICATE` `"Proxy-Authenticate"`.
`static String`	`PROXY_AUTHORIZATION` `"Proxy-Authorization"`.
`static String`	`RANGE` `"Range"`.
`static String`	`REFERER` `"Referer"`.
`static String`	`RETRY_AFTER` `"Retry-After"`.
`static String`	`SEC_WEBSOCKET_ACCEPT` `"Sec-WebSocket-Accept"`.
`static String`	`SEC_WEBSOCKET_KEY` `"Sec-WebSocket-Key"`.
`static String`	`SEC_WEBSOCKET_KEY1` `"Sec-WebSocket-Key1"`.
`static String`	`SEC_WEBSOCKET_KEY2` `"Sec-WebSocket-Key2"`.
`static String`	`SEC_WEBSOCKET_LOCATION` `"Sec-WebSocket-Location"`.
`static String`	`SEC_WEBSOCKET_ORIGIN` `"Sec-WebSocket-Origin"`.
`static String`	`SEC_WEBSOCKET_PROTOCOL` `"Sec-WebSocket-Protocol"`.
`static String`	`SEC_WEBSOCKET_VERSION` `"Sec-WebSocket-Version"`.
`static String`	`SERVER` `"Server"`.
`static String`	`SET_COOKIE` `"Set-Cookie"`.
`static String`	`SET_COOKIE2` `"Set-Cookie2"`.
`static String`	`TE` `"TE"`.
`static String`	`TRAILER` `"Trailer"`.
`static String`	`TRANSFER_ENCODING` `"Transfer-Encoding"`.
`static String`	`UPGRADE` `"Upgrade"`.
`static String`	`USER_AGENT` `"User-Agent"`.
`static String`	`VARY` `"Vary"`.
`static String`	`VIA` `"Via"`.
`static String`	`WARNING` `"Warning"`.
`static String`	`WEBSOCKET_LOCATION` `"WebSocket-Location"`.
`static String`	`WEBSOCKET_ORIGIN` `"WebSocket-Origin"`.
`static String`	`WEBSOCKET_PROTOCOL` `"WebSocket-Protocol"`.
`static String`	`WWW_AUTHENTICATE` `"WWW-Authenticate"`.
`static String`	`X_AUTH_TOKEN` `"X-Auth-Token"`.

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

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default List<MediaType>`	`accept()` A list of accepted `MediaType` instances.
`default OptionalLong`	`contentLength()` The request or response content type.
`default Optional<MediaType>`	`contentType()` The request or response content type.
`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
empty, forEach, forEachValue, get, getAll, getFirst, getFirst, getFirst, getFirst, isEmpty, iterator, of

Methods inherited from interface io.micronaut.core.convert.value.ConvertibleValues
asMap, asMap, asProperties, contains, getValueType, names, of, subMap, subMap, subMap, values

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - ACCEPT
```
static final String ACCEPT
```
    "Accept".
    
    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_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
  - 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_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
  - DATE
```
static final String DATE
```
    "Date".
    
    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
  - 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
  - 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
  - RETRY_AFTER
```
static final String RETRY_AFTER
```
    "Retry-After".
    
    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
  - 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
  - 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
  - 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
- Method Detail
  - 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
  - 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

Interface HttpHeaders

Field Summary

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

Method Summary

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

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

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

Methods inherited from interface java.lang.Iterable

Field Detail

ACCEPT

ACCEPT_CHARSET

ACCEPT_ENCODING

ACCEPT_LANGUAGE

ACCEPT_RANGES

ACCEPT_PATCH

ACCESS_CONTROL_ALLOW_CREDENTIALS

ACCESS_CONTROL_ALLOW_HEADERS

ACCESS_CONTROL_ALLOW_METHODS

ACCESS_CONTROL_ALLOW_ORIGIN

ACCESS_CONTROL_EXPOSE_HEADERS

ACCESS_CONTROL_MAX_AGE

ACCESS_CONTROL_REQUEST_HEADERS

ACCESS_CONTROL_REQUEST_METHOD

AGE

ALLOW

AUTHORIZATION

AUTHORIZATION_INFO

CACHE_CONTROL

CONNECTION

CONTENT_BASE

CONTENT_DISPOSITION

CONTENT_ENCODING

CONTENT_LANGUAGE

CONTENT_LENGTH

CONTENT_LOCATION

CONTENT_TRANSFER_ENCODING

CONTENT_MD5

CONTENT_RANGE

CONTENT_TYPE

COOKIE

DATE

ETAG

EXPECT

EXPIRES

FROM

HOST

IF_MATCH

IF_MODIFIED_SINCE

IF_NONE_MATCH

IF_RANGE

IF_UNMODIFIED_SINCE

LAST_MODIFIED

LOCATION

MAX_FORWARDS

ORIGIN

PRAGMA

PROXY_AUTHENTICATE

PROXY_AUTHORIZATION

RANGE

REFERER

RETRY_AFTER

SEC_WEBSOCKET_KEY1

SEC_WEBSOCKET_KEY2

SEC_WEBSOCKET_LOCATION

SEC_WEBSOCKET_ORIGIN

SEC_WEBSOCKET_PROTOCOL

SEC_WEBSOCKET_VERSION

SEC_WEBSOCKET_KEY

SEC_WEBSOCKET_ACCEPT

SERVER

SET_COOKIE

SET_COOKIE2

TE

TRAILER

TRANSFER_ENCODING

UPGRADE

USER_AGENT

VARY

VIA

WARNING