Package io.micronaut.http
Interface HttpHeaders
-
- All Superinterfaces:
io.micronaut.core.convert.value.ConvertibleMultiValues<java.lang.String>,io.micronaut.core.convert.value.ConvertibleValues<java.util.List<java.lang.String>>,io.micronaut.core.type.Headers,java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>>,io.micronaut.core.value.ValueResolver<java.lang.CharSequence>
- All Known Subinterfaces:
MutableHttpHeaders
- All Known Implementing Classes:
CaseInsensitiveMutableHttpHeaders,SimpleHttpHeaders
public interface HttpHeaders extends io.micronaut.core.type.HeadersConstants for common HTTP headers. See https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html.- Since:
- 1.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringACCEPT"Accept".static java.lang.StringACCEPT_CH"Accept-CH".static java.lang.StringACCEPT_CH_LIFETIME"Accept-CH".static java.lang.StringACCEPT_CHARSET"Accept-Charset".static java.lang.StringACCEPT_ENCODING"Accept-Encoding".static java.lang.StringACCEPT_LANGUAGE"Accept-Language".static java.lang.StringACCEPT_PATCH"Accept-Patch".static java.lang.StringACCEPT_RANGES"Accept-Ranges".static java.lang.StringACCESS_CONTROL_ALLOW_CREDENTIALS"Access-Control-Allow-Credentials".static java.lang.StringACCESS_CONTROL_ALLOW_HEADERS"Access-Control-Allow-Headers".static java.lang.StringACCESS_CONTROL_ALLOW_METHODS"Access-Control-Allow-Methods".static java.lang.StringACCESS_CONTROL_ALLOW_ORIGIN"Access-Control-Allow-Origin".static java.lang.StringACCESS_CONTROL_EXPOSE_HEADERS"Access-Control-Expose-Headers".static java.lang.StringACCESS_CONTROL_MAX_AGE"Access-Control-Max-Age".static java.lang.StringACCESS_CONTROL_REQUEST_HEADERS"Access-Control-Request-Headers".static java.lang.StringACCESS_CONTROL_REQUEST_METHOD"Access-Control-Request-Method".static java.lang.StringAGE"Age".static java.lang.StringALLOW"Allow".static java.lang.StringAUTHORIZATION"Authorization".static java.lang.StringAUTHORIZATION_INFO"Authorization".static java.lang.StringCACHE_CONTROL"Cache-Control".static java.lang.StringCONNECTION"Connection".static java.lang.StringCONTENT_BASE"Content-Base".static java.lang.StringCONTENT_DISPOSITION"Content-Disposition".static java.lang.StringCONTENT_DPR"Content-DPR".static java.lang.StringCONTENT_ENCODING"Content-Encoding".static java.lang.StringCONTENT_LANGUAGE"Content-Language".static java.lang.StringCONTENT_LENGTH"Content-Length".static java.lang.StringCONTENT_LOCATION"Content-Location".static java.lang.StringCONTENT_MD5"Content-MD5".static java.lang.StringCONTENT_RANGE"Content-Range".static java.lang.StringCONTENT_TRANSFER_ENCODING"Content-Transfer-Encoding".static java.lang.StringCONTENT_TYPE"Content-Type".static java.lang.StringCOOKIE"Cookie".static java.lang.StringCROSS_ORIGIN_RESOURCE_POLICY"Cross-Origin-Resource-Policy".static java.lang.StringDATE"Date".static java.lang.StringDEVICE_MEMORY"Device-Memory".static java.lang.StringDOWNLINK"Downlink".static java.lang.StringDPR"DPR".static java.lang.StringECT"ECT".static java.lang.StringETAG"ETag".static java.lang.StringEXPECT"Expect".static java.lang.StringEXPIRES"Expires".static java.lang.StringFEATURE_POLICY"Feature-Policy".static java.lang.StringFORWARDED"Forwarded".static java.lang.StringFROM"From".static java.lang.StringHOST"Host".static java.lang.StringIF_MATCH"If-Match".static java.lang.StringIF_MODIFIED_SINCE"If-Modified-Since".static java.lang.StringIF_NONE_MATCH"If-None-Match".static java.lang.StringIF_RANGE"If-Range".static java.lang.StringIF_UNMODIFIED_SINCE"If-Unmodified-Since".static java.lang.StringLAST_MODIFIED"Last-Modified".static java.lang.StringLINK"Link".static java.lang.StringLOCATION"Location".static java.lang.StringMAX_FORWARDS"Max-Forwards".static java.lang.StringORIGIN"Origin".static java.lang.StringPRAGMA"Pragma".static java.lang.StringPROXY_AUTHENTICATE"Proxy-Authenticate".static java.lang.StringPROXY_AUTHORIZATION"Proxy-Authorization".static java.lang.StringRANGE"Range".static java.lang.StringREFERER"Referer".static java.lang.StringREFERRER_POLICY"Referrer-Policy".static java.lang.StringRETRY_AFTER"Retry-After".static java.lang.StringRTT"RTT".static java.lang.StringSAVE_DATA"Save-Data".static java.lang.StringSEC_WEBSOCKET_ACCEPT"Sec-WebSocket-Accept".static java.lang.StringSEC_WEBSOCKET_KEY"Sec-WebSocket-Key".static java.lang.StringSEC_WEBSOCKET_KEY1"Sec-WebSocket-Key1".static java.lang.StringSEC_WEBSOCKET_KEY2"Sec-WebSocket-Key2".static java.lang.StringSEC_WEBSOCKET_LOCATION"Sec-WebSocket-Location".static java.lang.StringSEC_WEBSOCKET_ORIGIN"Sec-WebSocket-Origin".static java.lang.StringSEC_WEBSOCKET_PROTOCOL"Sec-WebSocket-Protocol".static java.lang.StringSEC_WEBSOCKET_VERSION"Sec-WebSocket-Version".static java.lang.StringSERVER"Server".static java.lang.StringSET_COOKIE"Set-Cookie".static java.lang.StringSET_COOKIE2"Set-Cookie2".static java.lang.StringSOURCE_MAP"Source-Map".static java.util.List<java.lang.String>STANDARD_HEADERSUnmodifiable List of every header constant defined inHttpHeaders.static java.lang.StringTE"TE".static java.lang.StringTRAILER"Trailer".static java.lang.StringTRANSFER_ENCODING"Transfer-Encoding".static java.lang.StringUPGRADE"Upgrade".static java.lang.StringUSER_AGENT"User-Agent".static java.lang.StringVARY"Vary".static java.lang.StringVIA"Via".static java.lang.StringVIEWPORT_WIDTH"Viewport-Width".static java.lang.StringWARNING"Warning".static java.lang.StringWEBSOCKET_LOCATION"WebSocket-Location".static java.lang.StringWEBSOCKET_ORIGIN"WebSocket-Origin".static java.lang.StringWEBSOCKET_PROTOCOL"WebSocket-Protocol".static java.lang.StringWIDTH"Width".static java.lang.StringWWW_AUTHENTICATE"WWW-Authenticate".static java.lang.StringX_AUTH_TOKEN"X-Auth-Token".
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default java.util.List<MediaType>accept()A list of acceptedMediaTypeinstances.default java.util.OptionalLongcontentLength()The request or response content type.default java.util.Optional<MediaType>contentType()The request or response content type.default java.util.Optional<java.time.ZonedDateTime>findDate(java.lang.CharSequence name)Obtain the date header.default java.util.Optional<java.lang.String>findFirst(java.lang.CharSequence name)Get the first value of the given header.default java.util.Optional<java.lang.Integer>findInt(java.lang.CharSequence name)Find an integer header.default java.util.Optional<java.lang.String>getAuthorization()default java.util.Optional<java.lang.String>getContentType()default java.time.ZonedDateTimegetDate(java.lang.CharSequence name)Obtain the date header.default java.lang.IntegergetInt(java.lang.CharSequence name)Obtain an integer header.default java.util.Optional<java.lang.String>getOrigin()default booleanisKeepAlive()-
Methods inherited from interface io.micronaut.core.convert.value.ConvertibleMultiValues
forEach, forEachValue, get, getAll, getFirst, getFirst, getFirst, getFirst, getFirst, isEmpty, iterator
-
-
-
-
Field Detail
-
ACCEPT
static final java.lang.String ACCEPT
"Accept".- See Also:
- Constant Field Values
-
ACCEPT_CH
static final java.lang.String ACCEPT_CH
"Accept-CH".- See Also:
- Constant Field Values
-
ACCEPT_CH_LIFETIME
static final java.lang.String ACCEPT_CH_LIFETIME
"Accept-CH".- See Also:
- Constant Field Values
-
ACCEPT_CHARSET
static final java.lang.String ACCEPT_CHARSET
"Accept-Charset".- See Also:
- Constant Field Values
-
ACCEPT_ENCODING
static final java.lang.String ACCEPT_ENCODING
"Accept-Encoding".- See Also:
- Constant Field Values
-
ACCEPT_LANGUAGE
static final java.lang.String ACCEPT_LANGUAGE
"Accept-Language".- See Also:
- Constant Field Values
-
ACCEPT_RANGES
static final java.lang.String ACCEPT_RANGES
"Accept-Ranges".- See Also:
- Constant Field Values
-
ACCEPT_PATCH
static final java.lang.String ACCEPT_PATCH
"Accept-Patch".- See Also:
- Constant Field Values
-
ACCESS_CONTROL_ALLOW_CREDENTIALS
static final java.lang.String ACCESS_CONTROL_ALLOW_CREDENTIALS
"Access-Control-Allow-Credentials".- See Also:
- Constant Field Values
-
ACCESS_CONTROL_ALLOW_HEADERS
static final java.lang.String ACCESS_CONTROL_ALLOW_HEADERS
"Access-Control-Allow-Headers".- See Also:
- Constant Field Values
-
ACCESS_CONTROL_ALLOW_METHODS
static final java.lang.String ACCESS_CONTROL_ALLOW_METHODS
"Access-Control-Allow-Methods".- See Also:
- Constant Field Values
-
ACCESS_CONTROL_ALLOW_ORIGIN
static final java.lang.String ACCESS_CONTROL_ALLOW_ORIGIN
"Access-Control-Allow-Origin".- See Also:
- Constant Field Values
-
ACCESS_CONTROL_EXPOSE_HEADERS
static final java.lang.String ACCESS_CONTROL_EXPOSE_HEADERS
"Access-Control-Expose-Headers".- See Also:
- Constant Field Values
-
ACCESS_CONTROL_MAX_AGE
static final java.lang.String ACCESS_CONTROL_MAX_AGE
"Access-Control-Max-Age".- See Also:
- Constant Field Values
-
ACCESS_CONTROL_REQUEST_HEADERS
static final java.lang.String ACCESS_CONTROL_REQUEST_HEADERS
"Access-Control-Request-Headers".- See Also:
- Constant Field Values
-
ACCESS_CONTROL_REQUEST_METHOD
static final java.lang.String ACCESS_CONTROL_REQUEST_METHOD
"Access-Control-Request-Method".- See Also:
- Constant Field Values
-
AGE
static final java.lang.String AGE
"Age".- See Also:
- Constant Field Values
-
ALLOW
static final java.lang.String ALLOW
"Allow".- See Also:
- Constant Field Values
-
AUTHORIZATION
static final java.lang.String AUTHORIZATION
"Authorization".- See Also:
- Constant Field Values
-
AUTHORIZATION_INFO
static final java.lang.String AUTHORIZATION_INFO
"Authorization".- See Also:
- Constant Field Values
-
CACHE_CONTROL
static final java.lang.String CACHE_CONTROL
"Cache-Control".- See Also:
- Constant Field Values
-
CONNECTION
static final java.lang.String CONNECTION
"Connection".- See Also:
- Constant Field Values
-
CONTENT_BASE
static final java.lang.String CONTENT_BASE
"Content-Base".- See Also:
- Constant Field Values
-
CONTENT_DISPOSITION
static final java.lang.String CONTENT_DISPOSITION
"Content-Disposition".- See Also:
- Constant Field Values
-
CONTENT_DPR
static final java.lang.String CONTENT_DPR
"Content-DPR".- See Also:
- Constant Field Values
-
CONTENT_ENCODING
static final java.lang.String CONTENT_ENCODING
"Content-Encoding".- See Also:
- Constant Field Values
-
CONTENT_LANGUAGE
static final java.lang.String CONTENT_LANGUAGE
"Content-Language".- See Also:
- Constant Field Values
-
CONTENT_LENGTH
static final java.lang.String CONTENT_LENGTH
"Content-Length".- See Also:
- Constant Field Values
-
CONTENT_LOCATION
static final java.lang.String CONTENT_LOCATION
"Content-Location".- See Also:
- Constant Field Values
-
CONTENT_TRANSFER_ENCODING
static final java.lang.String CONTENT_TRANSFER_ENCODING
"Content-Transfer-Encoding".- See Also:
- Constant Field Values
-
CONTENT_MD5
static final java.lang.String CONTENT_MD5
"Content-MD5".- See Also:
- Constant Field Values
-
CONTENT_RANGE
static final java.lang.String CONTENT_RANGE
"Content-Range".- See Also:
- Constant Field Values
-
CONTENT_TYPE
static final java.lang.String CONTENT_TYPE
"Content-Type".- See Also:
- Constant Field Values
-
COOKIE
static final java.lang.String COOKIE
"Cookie".- See Also:
- Constant Field Values
-
CROSS_ORIGIN_RESOURCE_POLICY
static final java.lang.String CROSS_ORIGIN_RESOURCE_POLICY
"Cross-Origin-Resource-Policy".- See Also:
- Constant Field Values
-
DATE
static final java.lang.String DATE
"Date".- See Also:
- Constant Field Values
-
DEVICE_MEMORY
static final java.lang.String DEVICE_MEMORY
"Device-Memory".- See Also:
- Constant Field Values
-
DOWNLINK
static final java.lang.String DOWNLINK
"Downlink".- See Also:
- Constant Field Values
-
DPR
static final java.lang.String DPR
"DPR".- See Also:
- Constant Field Values
-
ECT
static final java.lang.String ECT
"ECT".- See Also:
- Constant Field Values
-
ETAG
static final java.lang.String ETAG
"ETag".- See Also:
- Constant Field Values
-
EXPECT
static final java.lang.String EXPECT
"Expect".- See Also:
- Constant Field Values
-
EXPIRES
static final java.lang.String EXPIRES
"Expires".- See Also:
- Constant Field Values
-
FEATURE_POLICY
static final java.lang.String FEATURE_POLICY
"Feature-Policy".- See Also:
- Constant Field Values
-
FORWARDED
static final java.lang.String FORWARDED
"Forwarded".- See Also:
- Constant Field Values
-
FROM
static final java.lang.String FROM
"From".- See Also:
- Constant Field Values
-
HOST
static final java.lang.String HOST
"Host".- See Also:
- Constant Field Values
-
IF_MATCH
static final java.lang.String IF_MATCH
"If-Match".- See Also:
- Constant Field Values
-
IF_MODIFIED_SINCE
static final java.lang.String IF_MODIFIED_SINCE
"If-Modified-Since".- See Also:
- Constant Field Values
-
IF_NONE_MATCH
static final java.lang.String IF_NONE_MATCH
"If-None-Match".- See Also:
- Constant Field Values
-
IF_RANGE
static final java.lang.String IF_RANGE
"If-Range".- See Also:
- Constant Field Values
-
IF_UNMODIFIED_SINCE
static final java.lang.String IF_UNMODIFIED_SINCE
"If-Unmodified-Since".- See Also:
- Constant Field Values
-
LAST_MODIFIED
static final java.lang.String LAST_MODIFIED
"Last-Modified".- See Also:
- Constant Field Values
-
LINK
static final java.lang.String LINK
"Link".- See Also:
- Constant Field Values
-
LOCATION
static final java.lang.String LOCATION
"Location".- See Also:
- Constant Field Values
-
MAX_FORWARDS
static final java.lang.String MAX_FORWARDS
"Max-Forwards".- See Also:
- Constant Field Values
-
ORIGIN
static final java.lang.String ORIGIN
"Origin".- See Also:
- Constant Field Values
-
PRAGMA
static final java.lang.String PRAGMA
"Pragma".- See Also:
- Constant Field Values
-
PROXY_AUTHENTICATE
static final java.lang.String PROXY_AUTHENTICATE
"Proxy-Authenticate".- See Also:
- Constant Field Values
-
PROXY_AUTHORIZATION
static final java.lang.String PROXY_AUTHORIZATION
"Proxy-Authorization".- See Also:
- Constant Field Values
-
RANGE
static final java.lang.String RANGE
"Range".- See Also:
- Constant Field Values
-
REFERER
static final java.lang.String REFERER
"Referer".- See Also:
- Constant Field Values
-
REFERRER_POLICY
static final java.lang.String REFERRER_POLICY
"Referrer-Policy".- See Also:
- Constant Field Values
-
RETRY_AFTER
static final java.lang.String RETRY_AFTER
"Retry-After".- See Also:
- Constant Field Values
-
RTT
static final java.lang.String RTT
"RTT".- See Also:
- Constant Field Values
-
SAVE_DATA
static final java.lang.String SAVE_DATA
"Save-Data".- See Also:
- Constant Field Values
-
SEC_WEBSOCKET_KEY1
static final java.lang.String SEC_WEBSOCKET_KEY1
"Sec-WebSocket-Key1".- See Also:
- Constant Field Values
-
SEC_WEBSOCKET_KEY2
static final java.lang.String SEC_WEBSOCKET_KEY2
"Sec-WebSocket-Key2".- See Also:
- Constant Field Values
-
SEC_WEBSOCKET_LOCATION
static final java.lang.String SEC_WEBSOCKET_LOCATION
"Sec-WebSocket-Location".- See Also:
- Constant Field Values
-
SEC_WEBSOCKET_ORIGIN
static final java.lang.String SEC_WEBSOCKET_ORIGIN
"Sec-WebSocket-Origin".- See Also:
- Constant Field Values
-
SEC_WEBSOCKET_PROTOCOL
static final java.lang.String SEC_WEBSOCKET_PROTOCOL
"Sec-WebSocket-Protocol".- See Also:
- Constant Field Values
-
SEC_WEBSOCKET_VERSION
static final java.lang.String SEC_WEBSOCKET_VERSION
"Sec-WebSocket-Version".- See Also:
- Constant Field Values
-
SEC_WEBSOCKET_KEY
static final java.lang.String SEC_WEBSOCKET_KEY
"Sec-WebSocket-Key".- See Also:
- Constant Field Values
-
SEC_WEBSOCKET_ACCEPT
static final java.lang.String SEC_WEBSOCKET_ACCEPT
"Sec-WebSocket-Accept".- See Also:
- Constant Field Values
-
SERVER
static final java.lang.String SERVER
"Server".- See Also:
- Constant Field Values
-
SET_COOKIE
static final java.lang.String SET_COOKIE
"Set-Cookie".- See Also:
- Constant Field Values
-
SET_COOKIE2
static final java.lang.String SET_COOKIE2
"Set-Cookie2".- See Also:
- Constant Field Values
-
SOURCE_MAP
static final java.lang.String SOURCE_MAP
"Source-Map".- See Also:
- Constant Field Values
-
TE
static final java.lang.String TE
"TE".- See Also:
- Constant Field Values
-
TRAILER
static final java.lang.String TRAILER
"Trailer".- See Also:
- Constant Field Values
-
TRANSFER_ENCODING
static final java.lang.String TRANSFER_ENCODING
"Transfer-Encoding".- See Also:
- Constant Field Values
-
UPGRADE
static final java.lang.String UPGRADE
"Upgrade".- See Also:
- Constant Field Values
-
USER_AGENT
static final java.lang.String USER_AGENT
"User-Agent".- See Also:
- Constant Field Values
-
VARY
static final java.lang.String VARY
"Vary".- See Also:
- Constant Field Values
-
VIA
static final java.lang.String VIA
"Via".- See Also:
- Constant Field Values
-
VIEWPORT_WIDTH
static final java.lang.String VIEWPORT_WIDTH
"Viewport-Width".- See Also:
- Constant Field Values
-
WARNING
static final java.lang.String WARNING
"Warning".- See Also:
- Constant Field Values
-
WEBSOCKET_LOCATION
static final java.lang.String WEBSOCKET_LOCATION
"WebSocket-Location".- See Also:
- Constant Field Values
-
WEBSOCKET_ORIGIN
static final java.lang.String WEBSOCKET_ORIGIN
"WebSocket-Origin".- See Also:
- Constant Field Values
-
WEBSOCKET_PROTOCOL
static final java.lang.String WEBSOCKET_PROTOCOL
"WebSocket-Protocol".- See Also:
- Constant Field Values
-
WIDTH
static final java.lang.String WIDTH
"Width".- See Also:
- Constant Field Values
-
WWW_AUTHENTICATE
static final java.lang.String WWW_AUTHENTICATE
"WWW-Authenticate".- See Also:
- Constant Field Values
-
X_AUTH_TOKEN
static final java.lang.String X_AUTH_TOKEN
"X-Auth-Token".- See Also:
- Constant Field Values
-
STANDARD_HEADERS
static final java.util.List<java.lang.String> STANDARD_HEADERS
Unmodifiable List of every header constant defined inHttpHeaders.
-
-
Method Detail
-
findDate
default java.util.Optional<java.time.ZonedDateTime> findDate(java.lang.CharSequence name)
Obtain the date header.- Parameters:
name- The header name- Returns:
- The date header as a
ZonedDateTimeotherwise if it is not present or cannot be parsedOptional.empty()
-
getDate
default java.time.ZonedDateTime getDate(java.lang.CharSequence name)
Obtain the date header.- Parameters:
name- The header name- Returns:
- The date header as a
ZonedDateTimeotherwise if it is not present or cannot be parsed null
-
getInt
default java.lang.Integer getInt(java.lang.CharSequence name)
Obtain an integer header.- Parameters:
name- The header name- Returns:
- The date header as a
ZonedDateTimeotherwise if it is not present or cannot be parsed null
-
findInt
default java.util.Optional<java.lang.Integer> findInt(java.lang.CharSequence name)
Find an integer header.- Parameters:
name- The name of the header- Returns:
- An
OptionalofInteger
-
findFirst
default java.util.Optional<java.lang.String> findFirst(java.lang.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 java.util.Optional<MediaType> contentType()
The request or response content type.- Returns:
- The content type
-
contentLength
default java.util.OptionalLong contentLength()
The request or response content type.- Returns:
- The content type
-
accept
default java.util.List<MediaType> accept()
A list of acceptedMediaTypeinstances.- Returns:
- A list of zero or many
MediaTypeinstances
-
isKeepAlive
default boolean isKeepAlive()
- Returns:
- Whether the
CONNECTIONheader is set to Keep-Alive
-
getOrigin
default java.util.Optional<java.lang.String> getOrigin()
- Returns:
- The
ORIGINheader
-
getAuthorization
default java.util.Optional<java.lang.String> getAuthorization()
- Returns:
- The
AUTHORIZATIONheader
-
getContentType
default java.util.Optional<java.lang.String> getContentType()
- Returns:
- The
CONTENT_TYPEheader
-
-