Top Description Fields Methods
io.vertx.core.http

public Interface HttpHeaders

Annotations
@VertxGen
Imports
io.netty.handler.codec.http.HttpHeaderNames, .HttpHeaderValues, io.netty.handler.codec.http2.Http2Headers, io.netty.util.AsciiString, io.vertx.codegen.annotations.GenIgnore, .VertxGen, io.vertx.core.MultiMap, io.vertx.core.http.impl.headers.HeadersMultiMap

Contains a bunch of useful HTTP headers stuff:
Author
Norman Maurer

Field Summary

Modifier and TypeField and Description
public static final CharSequence
ACCEPT

Accept header name

public static final CharSequence
ACCEPT_CHARSET

Accept-Charset header name

public static final CharSequence
ACCEPT_ENCODING

Accept-Encoding header name

public static final CharSequence
ACCEPT_LANGUAGE

Accept-Language header name

public static final CharSequence
ACCEPT_PATCH

Accept-Patch header name

public static final CharSequence
ACCEPT_RANGES

Accept-Ranges header name

public static final CharSequence
ACCESS_CONTROL_ALLOW_CREDENTIALS

Access-Control-Allow-Credentials header name

public static final CharSequence
ACCESS_CONTROL_ALLOW_HEADERS

Access-Control-Allow-Headers header name

public static final CharSequence
ACCESS_CONTROL_ALLOW_METHODS

Access-Control-Allow-Methods header name

public static final CharSequence
ACCESS_CONTROL_ALLOW_ORIGIN

Access-Control-Allow-Origin header name

public static final CharSequence
ACCESS_CONTROL_ALLOW_PRIVATE_NETWORK

Access-Control-Allow-Private-Network header name

public static final CharSequence
ACCESS_CONTROL_EXPOSE_HEADERS

Access-Control-Expose-Headers header name

public static final CharSequence
ACCESS_CONTROL_MAX_AGE

Access-Control-Max-Age header name

public static final CharSequence
ACCESS_CONTROL_REQUEST_HEADERS

Access-Control-Request-Headers header name

public static final CharSequence
ACCESS_CONTROL_REQUEST_METHOD

Access-Control-Request-Method header name

public static final CharSequence
ACCESS_CONTROL_REQUEST_PRIVATE_NETWORK

Access-Control-Request-Private-Network header name

public static final CharSequence
AGE

Age header name

public static final CharSequence
ALLOW

Allow header name

public static final CharSequence
APPLICATION_X_WWW_FORM_URLENCODED

application/x-www-form-urlencoded header value

public static final CharSequence
AUTHORIZATION

Authorization header name

public static final CharSequence
CACHE_CONTROL

Cache-Control header name

public static final CharSequence
CHUNKED

chunked header value

public static final CharSequence
CLOSE

close header value

public static final CharSequence
CONNECTION

Connection header name

public static final CharSequence
CONTENT_BASE

Content-Base header name

public static final CharSequence
CONTENT_DISPOSITION

Content-Disposition header name

public static final CharSequence
CONTENT_ENCODING

Content-Encoding header name

public static final CharSequence
CONTENT_LANGUAGE

Content-Language header name

public static final CharSequence
CONTENT_LENGTH

Content-Length header name

public static final CharSequence
CONTENT_LOCATION

Content-Location header name

public static final CharSequence
CONTENT_MD5

Content-MD5 header name

public static final CharSequence
CONTENT_RANGE

Content-Rage header name

public static final CharSequence
CONTENT_TRANSFER_ENCODING

Content-Transfer-Encoding header name

public static final CharSequence
CONTENT_TYPE

Content-Type header name

public static final CharSequence
CONTINUE

100-continue header value

public static final CharSequence
COOKIE

Content-Cookie header name

public static final CharSequence
DATE

Date header name

public static final CharSequence
DEFLATE_GZIP

deflate,gzip header value

public static final CharSequence
DEFLATE_GZIP_BR

deflate,gzip,br header value

public static final boolean
DISABLE_HTTP_HEADERS_VALIDATION

Constant that disables HTTP headers validation, this is a constant so the JIT can eliminate validation code.

public static final String
DISABLE_HTTP_HEADERS_VALIDATION_PROP_NAME

Deprecated
JVM system property that disables HTTP headers validation, don't use this in production.
public static final CharSequence
ETAG

Etag header name

public static final CharSequence
EXPECT

Expect header name

public static final CharSequence
EXPIRES

Expires header name

public static final CharSequence
FROM

From header name

public static final CharSequence
GET

GET header value

public static final CharSequence
HOST

Host header name

public static final CharSequence
IDENTITY

identity header value

public static final CharSequence
IF_MATCH

If-Match header name

public static final CharSequence
IF_MODIFIED_SINCE

If-Modified-Since header name

public static final CharSequence
IF_NONE_MATCH

If-None-Match header name

public static final CharSequence
KEEP_ALIVE

keep-alive header value

public static final CharSequence
LAST_MODIFIED

Last-Modified header name

public static final CharSequence
LOCATION

Location header name

public static final CharSequence
ORIGIN

Origin header name

public static final CharSequence
PROXY_AUTHENTICATE

Proxy-Authenticate header name

public static final CharSequence
PROXY_AUTHORIZATION

Proxy-Authorization header name

public static final CharSequence
PSEUDO_AUTHORITY

HTTP/2 :authority pseudo header

public static final CharSequence
PSEUDO_METHOD

HTTP/2 :method pseudo hedaer

public static final CharSequence
PSEUDO_PATH

HTTP/2 :path pseudo header

public static final CharSequence
PSEUDO_SCHEME

HTTP/2 :scheme pseudo header

public static final CharSequence
PSEUDO_STATUS

HTTP/2 :status pseudo header

public static final CharSequence
REFERER

Referer header name

public static final CharSequence
RETRY_AFTER

Retry-After header name

public static final CharSequence
SERVER

Server header name

public static final CharSequence
SET_COOKIE

Set-Cookie header name

public static final CharSequence
TEXT_HTML

text/html header value

public static final CharSequence
TRANSFER_ENCODING

Transfer-Encoding header name

public static final CharSequence
UPGRADE

Upgrade header value

public static final CharSequence
USER_AGENT

User-Agent header name

public static final CharSequence
VARY

Vary header name

public static final CharSequence
WEBSOCKET

WebSocket header value

Method Summary

Modifier and TypeMethod and Description
public static CharSequence
createOptimized(String value)

Create an optimized CharSequence which can be used as header name or value.

public static MultiMap
public static MultiMap
set(String name, String value)

public static MultiMap

Field Detail

ACCEPTback to summary
public static final CharSequence ACCEPT

Accept header name

Annotations
@GenIgnore:permitted-type
ACCEPT_CHARSETback to summary
public static final CharSequence ACCEPT_CHARSET

Accept-Charset header name

Annotations
@GenIgnore:permitted-type
ACCEPT_ENCODINGback to summary
public static final CharSequence ACCEPT_ENCODING

Accept-Encoding header name

Annotations
@GenIgnore:permitted-type
ACCEPT_LANGUAGEback to summary
public static final CharSequence ACCEPT_LANGUAGE

Accept-Language header name

Annotations
@GenIgnore:permitted-type
ACCEPT_PATCHback to summary
public static final CharSequence ACCEPT_PATCH

Accept-Patch header name

Annotations
@GenIgnore:permitted-type
ACCEPT_RANGESback to summary
public static final CharSequence ACCEPT_RANGES

Accept-Ranges header name

Annotations
@GenIgnore:permitted-type
ACCESS_CONTROL_ALLOW_CREDENTIALSback to summary
public static final CharSequence ACCESS_CONTROL_ALLOW_CREDENTIALS

Access-Control-Allow-Credentials header name

Annotations
@GenIgnore:permitted-type
ACCESS_CONTROL_ALLOW_HEADERSback to summary
public static final CharSequence ACCESS_CONTROL_ALLOW_HEADERS

Access-Control-Allow-Headers header name

Annotations
@GenIgnore:permitted-type
ACCESS_CONTROL_ALLOW_METHODSback to summary
public static final CharSequence ACCESS_CONTROL_ALLOW_METHODS

Access-Control-Allow-Methods header name

Annotations
@GenIgnore:permitted-type
ACCESS_CONTROL_ALLOW_ORIGINback to summary
public static final CharSequence ACCESS_CONTROL_ALLOW_ORIGIN

Access-Control-Allow-Origin header name

Annotations
@GenIgnore:permitted-type
ACCESS_CONTROL_ALLOW_PRIVATE_NETWORKback to summary
public static final CharSequence ACCESS_CONTROL_ALLOW_PRIVATE_NETWORK

Access-Control-Allow-Private-Network header name

Annotations
@GenIgnore:permitted-type
ACCESS_CONTROL_EXPOSE_HEADERSback to summary
public static final CharSequence ACCESS_CONTROL_EXPOSE_HEADERS

Access-Control-Expose-Headers header name

Annotations
@GenIgnore:permitted-type
ACCESS_CONTROL_MAX_AGEback to summary
public static final CharSequence ACCESS_CONTROL_MAX_AGE

Access-Control-Max-Age header name

Annotations
@GenIgnore:permitted-type
ACCESS_CONTROL_REQUEST_HEADERSback to summary
public static final CharSequence ACCESS_CONTROL_REQUEST_HEADERS

Access-Control-Request-Headers header name

Annotations
@GenIgnore:permitted-type
ACCESS_CONTROL_REQUEST_METHODback to summary
public static final CharSequence ACCESS_CONTROL_REQUEST_METHOD

Access-Control-Request-Method header name

Annotations
@GenIgnore:permitted-type
ACCESS_CONTROL_REQUEST_PRIVATE_NETWORKback to summary
public static final CharSequence ACCESS_CONTROL_REQUEST_PRIVATE_NETWORK

Access-Control-Request-Private-Network header name

Annotations
@GenIgnore:permitted-type
AGEback to summary
public static final CharSequence AGE

Age header name

Annotations
@GenIgnore:permitted-type
ALLOWback to summary
public static final CharSequence ALLOW

Allow header name

Annotations
@GenIgnore:permitted-type
APPLICATION_X_WWW_FORM_URLENCODEDback to summary
public static final CharSequence APPLICATION_X_WWW_FORM_URLENCODED

application/x-www-form-urlencoded header value

Annotations
@GenIgnore:permitted-type
AUTHORIZATIONback to summary
public static final CharSequence AUTHORIZATION

Authorization header name

Annotations
@GenIgnore:permitted-type
CACHE_CONTROLback to summary
public static final CharSequence CACHE_CONTROL

Cache-Control header name

Annotations
@GenIgnore:permitted-type
CHUNKEDback to summary
public static final CharSequence CHUNKED

chunked header value

Annotations
@GenIgnore:permitted-type
CLOSEback to summary
public static final CharSequence CLOSE

close header value

Annotations
@GenIgnore:permitted-type
CONNECTIONback to summary
public static final CharSequence CONNECTION

Connection header name

Annotations
@GenIgnore:permitted-type
CONTENT_BASEback to summary
public static final CharSequence CONTENT_BASE

Content-Base header name

Annotations
@GenIgnore:permitted-type
CONTENT_DISPOSITIONback to summary
public static final CharSequence CONTENT_DISPOSITION

Content-Disposition header name

Annotations
@GenIgnore:permitted-type
CONTENT_ENCODINGback to summary
public static final CharSequence CONTENT_ENCODING

Content-Encoding header name

Annotations
@GenIgnore:permitted-type
CONTENT_LANGUAGEback to summary
public static final CharSequence CONTENT_LANGUAGE

Content-Language header name

Annotations
@GenIgnore:permitted-type
CONTENT_LENGTHback to summary
public static final CharSequence CONTENT_LENGTH

Content-Length header name

Annotations
@GenIgnore:permitted-type
CONTENT_LOCATIONback to summary
public static final CharSequence CONTENT_LOCATION

Content-Location header name

Annotations
@GenIgnore:permitted-type
CONTENT_MD5back to summary
public static final CharSequence CONTENT_MD5

Content-MD5 header name

Annotations
@GenIgnore:permitted-type
CONTENT_RANGEback to summary
public static final CharSequence CONTENT_RANGE

Content-Rage header name

Annotations
@GenIgnore:permitted-type
CONTENT_TRANSFER_ENCODINGback to summary
public static final CharSequence CONTENT_TRANSFER_ENCODING

Content-Transfer-Encoding header name

Annotations
@GenIgnore:permitted-type
CONTENT_TYPEback to summary
public static final CharSequence CONTENT_TYPE

Content-Type header name

Annotations
@GenIgnore:permitted-type
CONTINUEback to summary
public static final CharSequence CONTINUE

100-continue header value

Annotations
@GenIgnore:permitted-type
DATEback to summary
public static final CharSequence DATE

Date header name

Annotations
@GenIgnore:permitted-type
DEFLATE_GZIPback to summary
public static final CharSequence DEFLATE_GZIP

deflate,gzip header value

Annotations
@GenIgnore:permitted-type
DEFLATE_GZIP_BRback to summary
public static final CharSequence DEFLATE_GZIP_BR

deflate,gzip,br header value

Annotations
@GenIgnore:permitted-type
DISABLE_HTTP_HEADERS_VALIDATIONback to summary
public static final boolean DISABLE_HTTP_HEADERS_VALIDATION

Constant that disables HTTP headers validation, this is a constant so the JIT can eliminate validation code.

DISABLE_HTTP_HEADERS_VALIDATION_PROP_NAMEback to summary
public static final String DISABLE_HTTP_HEADERS_VALIDATION_PROP_NAME

Deprecated

JVM system property that disables HTTP headers validation, don't use this in production.

Annotations
@Deprecated
ETAGback to summary
public static final CharSequence ETAG

Etag header name

Annotations
@GenIgnore:permitted-type
EXPECTback to summary
public static final CharSequence EXPECT

Expect header name

Annotations
@GenIgnore:permitted-type
EXPIRESback to summary
public static final CharSequence EXPIRES

Expires header name

Annotations
@GenIgnore:permitted-type
FROMback to summary
public static final CharSequence FROM

From header name

Annotations
@GenIgnore:permitted-type
GETback to summary
public static final CharSequence GET

GET header value

Annotations
@GenIgnore:permitted-type
HOSTback to summary
public static final CharSequence HOST

Host header name

Annotations
@GenIgnore:permitted-type
IDENTITYback to summary
public static final CharSequence IDENTITY

identity header value

Annotations
@GenIgnore:permitted-type
IF_MATCHback to summary
public static final CharSequence IF_MATCH

If-Match header name

Annotations
@GenIgnore:permitted-type
IF_MODIFIED_SINCEback to summary
public static final CharSequence IF_MODIFIED_SINCE

If-Modified-Since header name

Annotations
@GenIgnore:permitted-type
IF_NONE_MATCHback to summary
public static final CharSequence IF_NONE_MATCH

If-None-Match header name

Annotations
@GenIgnore:permitted-type
KEEP_ALIVEback to summary
public static final CharSequence KEEP_ALIVE

keep-alive header value

Annotations
@GenIgnore:permitted-type
LAST_MODIFIEDback to summary
public static final CharSequence LAST_MODIFIED

Last-Modified header name

Annotations
@GenIgnore:permitted-type
LOCATIONback to summary
public static final CharSequence LOCATION

Location header name

Annotations
@GenIgnore:permitted-type
ORIGINback to summary
public static final CharSequence ORIGIN

Origin header name

Annotations
@GenIgnore:permitted-type
PROXY_AUTHENTICATEback to summary
public static final CharSequence PROXY_AUTHENTICATE

Proxy-Authenticate header name

Annotations
@GenIgnore:permitted-type
PROXY_AUTHORIZATIONback to summary
public static final CharSequence PROXY_AUTHORIZATION

Proxy-Authorization header name

Annotations
@GenIgnore:permitted-type
PSEUDO_AUTHORITYback to summary
public static final CharSequence PSEUDO_AUTHORITY

HTTP/2 :authority pseudo header

Annotations
@GenIgnore:permitted-type
PSEUDO_METHODback to summary
public static final CharSequence PSEUDO_METHOD

HTTP/2 :method pseudo hedaer

Annotations
@GenIgnore:permitted-type
PSEUDO_PATHback to summary
public static final CharSequence PSEUDO_PATH

HTTP/2 :path pseudo header

Annotations
@GenIgnore:permitted-type
PSEUDO_SCHEMEback to summary
public static final CharSequence PSEUDO_SCHEME

HTTP/2 :scheme pseudo header

Annotations
@GenIgnore:permitted-type
PSEUDO_STATUSback to summary
public static final CharSequence PSEUDO_STATUS

HTTP/2 :status pseudo header

Annotations
@GenIgnore:permitted-type
REFERERback to summary
public static final CharSequence REFERER

Referer header name

Annotations
@GenIgnore:permitted-type
RETRY_AFTERback to summary
public static final CharSequence RETRY_AFTER

Retry-After header name

Annotations
@GenIgnore:permitted-type
SERVERback to summary
public static final CharSequence SERVER

Server header name

Annotations
@GenIgnore:permitted-type
TEXT_HTMLback to summary
public static final CharSequence TEXT_HTML

text/html header value

Annotations
@GenIgnore:permitted-type
TRANSFER_ENCODINGback to summary
public static final CharSequence TRANSFER_ENCODING

Transfer-Encoding header name

Annotations
@GenIgnore:permitted-type
UPGRADEback to summary
public static final CharSequence UPGRADE

Upgrade header value

Annotations
@GenIgnore:permitted-type
USER_AGENTback to summary
public static final CharSequence USER_AGENT

User-Agent header name

Annotations
@GenIgnore:permitted-type
VARYback to summary
public static final CharSequence VARY

Vary header name

Annotations
@GenIgnore:permitted-type
WEBSOCKETback to summary
public static final CharSequence WEBSOCKET

WebSocket header value

Annotations
@GenIgnore:permitted-type

Method Detail

createOptimizedback to summary
public static CharSequence createOptimized(String value)

Create an optimized CharSequence which can be used as header name or value. This should be used if you expect to use it multiple times liked for example adding the same header name or value for multiple responses or requests.

Annotations
@GenIgnore:permitted-type
headersback to summary
public static MultiMap headers()
setback to summary
public static MultiMap set(String name, String value)
setback to summary
public static MultiMap set(CharSequence name, CharSequence value)
Annotations
@GenIgnore:permitted-type