Package javax.ws.rs.core
Interface HttpHeaders
public interface HttpHeaders
An injectable interface that provides access to HTTP header information.
All methods throw java.lang.IllegalStateException if called outside the scope of a request
(e.g. from a provider constructor).
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.2">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.8">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.12">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.14">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.ietf.org/rfc/rfc2109.txt">IETF
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.19">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.23">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.24">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.28">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.29">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.ietf.org/rfc/rfc2109.txt">IETF
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.43">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.44">HTTP/1.1
static final String
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.47">HTTP/1.1
-
Method Summary
Modifier and TypeMethodDescriptionGet a list of languages that are acceptable for the response.Get a list of media types that are acceptable for the response.Get any cookies that accompanied the request.Get the language of the request entityGet the media type of the request entitygetRequestHeader
(String name) Get the values of a HTTP request header.Get the values of HTTP request headers.
-
Field Details
-
ACCEPT
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">HTTP/1.1
- See Also:
-
ACCEPT_CHARSET
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.2">HTTP/1.1
- See Also:
-
ACCEPT_ENCODING
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3">HTTP/1.1
- See Also:
-
ACCEPT_LANGUAGE
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4">HTTP/1.1
- See Also:
-
AUTHORIZATION
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.8">HTTP/1.1
- See Also:
-
CACHE_CONTROL
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9">HTTP/1.1
- See Also:
-
CONTENT_ENCODING
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11">HTTP/1.1
- See Also:
-
CONTENT_LANGUAGE
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.12">HTTP/1.1
- See Also:
-
CONTENT_LENGTH
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13">HTTP/1.1
- See Also:
-
CONTENT_LOCATION
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.14">HTTP/1.1
- See Also:
-
CONTENT_TYPE
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">HTTP/1.1
- See Also:
-
DATE
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18">HTTP/1.1
- See Also:
-
ETAG
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.19">HTTP/1.1
- See Also:
-
EXPIRES
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21">HTTP/1.1
- See Also:
-
HOST
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.23">HTTP/1.1
- See Also:
-
IF_MATCH
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.24">HTTP/1.1
- See Also:
-
IF_MODIFIED_SINCE
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25">HTTP/1.1
- See Also:
-
IF_NONE_MATCH
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26">HTTP/1.1
- See Also:
-
IF_UNMODIFIED_SINCE
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.28">HTTP/1.1
- See Also:
-
LAST_MODIFIED
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.29">HTTP/1.1
- See Also:
-
LOCATION
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30">HTTP/1.1
- See Also:
-
USER_AGENT
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.43">HTTP/1.1
- See Also:
-
VARY
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.44">HTTP/1.1
- See Also:
-
WWW_AUTHENTICATE
Seeinvalid @link
{@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.47">HTTP/1.1
- See Also:
-
COOKIE
Seeinvalid @link
{@link <a href="http://www.ietf.org/rfc/rfc2109.txt">IETF
- See Also:
-
SET_COOKIE
Seeinvalid @link
{@link <a href="http://www.ietf.org/rfc/rfc2109.txt">IETF
- See Also:
-
-
Method Details
-
getRequestHeader
Get the values of a HTTP request header. The returned List is read-only. This is a shortcut forgetRequestHeaders().get(name)
.- Parameters:
name
- the header name, case insensitive- Returns:
- a read-only list of header values.
- Throws:
IllegalStateException
- if called outside the scope of a request
-
getRequestHeaders
MultivaluedMap<String,String> getRequestHeaders()Get the values of HTTP request headers. The returned Map is case-insensitive wrt keys and is read-only.- Returns:
- a read-only map of header names and values.
- Throws:
IllegalStateException
- if called outside the scope of a request
-
getAcceptableMediaTypes
Get a list of media types that are acceptable for the response.- Returns:
- a read-only list of requested response media types sorted according to their q-value, with highest preference first.
- Throws:
IllegalStateException
- if called outside the scope of a request
-
getAcceptableLanguages
Get a list of languages that are acceptable for the response.- Returns:
- a read-only list of acceptable languages sorted according to their q-value, with highest preference first.
- Throws:
IllegalStateException
- if called outside the scope of a request
-
getMediaType
MediaType getMediaType()Get the media type of the request entity- Returns:
- the media type or null if there is no request entity.
- Throws:
IllegalStateException
- if called outside the scope of a request
-
getLanguage
Locale getLanguage()Get the language of the request entity- Returns:
- the language of the entity or null if not specified
- Throws:
IllegalStateException
- if called outside the scope of a request
-
getCookies
Get any cookies that accompanied the request.- Returns:
- a read-only map of cookie name (String) to Cookie.
- Throws:
IllegalStateException
- if called outside the scope of a request
-