public Interface HttpHeaders

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See IETF RFC-2183.

See HTTP/1.1 documentation.

See IETF RFC-2392.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See IETF RFC 2109.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

"Last-Event-ID" HTTP request header name as defined by SSE specification.

Since

2.1

See HTTP/1.1 documentation.

See Web Linking (IETF RFC-5988) documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See IETF RFC 2109.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

See HTTP/1.1 documentation.

Checks whether a header with a specific name and value (or item of the token-separated value list) exists. Each single non-string header value is converted to String using a jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.RuntimeDelegate#createHeaderDelegate(java.lang.Class) for the header value class or using its toString method if a header delegate is not available.

For example: containsHeaderString("cache-control", ",", "no-store"::equalsIgnoreCase) will return true if a Cache-Control header exists that has the value no-store, the value No-Store or the value Max-Age, NO-STORE, no-transform, but false when it has the value no-store;no-transform (missing comma), or the value no - store (whitespace within value).

Parameters

name:String

the message header.

valueSeparatorRegex:String

Regular expression that separates the header value into single values. null does not split.

valuePredicate:Predicate<String>

value must fulfil this predicate.

Returns:boolean

true if and only if a header with the given name exists, having either a whitespace-trimmed value matching the predicate, or having at least one whitespace-trimmed single value in a token-separated list of single values.

Since

4.0

See Also

getRequestHeaders(), getHeaderString(String)

Checks whether a header with a specific name and value (or item of the comma-separated value list) exists. Each single non-string header value is converted to String using a jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.RuntimeDelegate#createHeaderDelegate(java.lang.Class) for the header value class or using its toString method if a header delegate is not available.

For example: containsHeaderString("cache-control", "no-store"::equalsIgnoreCase) will return true if a Cache-Control header exists that has the value no-store, the value No-Store or the value Max-Age, NO-STORE, no-transform, but false when it has the value no-store;no-transform (missing comma), or the value no - store (whitespace within value).

Parameters

name:String

the message header.

valuePredicate:Predicate<String>

value must fulfil this predicate.

Returns:boolean

true if and only if a header with the given name exists, having either a whitespace-trimmed value matching the predicate, or having at least one whitespace-trimmed single value in a comma-separated list of single values.

Since

4.0

See Also

getRequestHeaders(), getHeaderString(String)

Get a list of languages that are acceptable for the response.

Returns:List<Locale>

a read-only list of acceptable languages sorted according to their q-value, with highest preference first.

Exceptions

IllegalStateException:

if called outside the scope of a request.

Get a list of media types that are acceptable for the response.

Returns:List<MediaType>

a read-only list of requested response media types sorted according to their q-value, with highest preference first.

Exceptions

IllegalStateException:

if called outside the scope of a request.

Get any cookies that accompanied the request.

Returns:Map<String, Cookie>

a read-only map of cookie name (String) to Cookie.

Exceptions

IllegalStateException:

if called outside the scope of a request

Get message date.

Returns:Date

the message date, otherwise null if not present.

Since

2.0

Get a HTTP header as a single string value.

Parameters

name:String

the HTTP header.

Returns:String

the HTTP header value. If the HTTP header is not present then null is returned. If the HTTP header is present but has no value then the empty string is returned. If the HTTP header is present more than once then the values of joined together and separated by a ',' character.

Since

2.0

See Also

getRequestHeader(java.lang.String)

Get the language of the request entity.

Returns:Locale

the language of the entity or null if not specified.

Exceptions

IllegalStateException:

if called outside the scope of a request.

Get Content-Length value.

Returns:int

Content-Length as integer if present and valid number. In other cases returns -1.

Since

2.0

Get the media type of the request entity.

Returns:MediaType

the media type or null if there is no request entity.

Exceptions

IllegalStateException:

if called outside the scope of a request.

Get the values of a HTTP request header if the header exists on the current request. The returned value will be a read-only List if the specified header exists or null if it does not. This is a shortcut for getRequestHeaders().get(name).

Parameters

name:String

the header name, case insensitive.

Returns:List<String>

a read-only list of header values if the specified header exists, otherwise null.

Exceptions

IllegalStateException:

if called outside the scope of a request.

Get the values of HTTP request headers. The returned Map is case-insensitive wrt. keys and is read-only. The method never returns null.

Returns:MultivaluedMap<String, String>

a read-only map of header names and values.

Exceptions

IllegalStateException:

if called outside the scope of a request.