Package jakarta.ws.rs.core
Interface HttpHeaders
-
public interface HttpHeaders
An injectable interface that provides access to HTTP header information. All methods throwIllegalStateException
if called outside the scope of a request (e.g. from a provider constructor).- Since:
- 1.0
- See Also:
Context
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ACCEPT
static java.lang.String
ACCEPT_CHARSET
static java.lang.String
ACCEPT_ENCODING
static java.lang.String
ACCEPT_LANGUAGE
static java.lang.String
ALLOW
static java.lang.String
AUTHORIZATION
static java.lang.String
CACHE_CONTROL
static java.lang.String
CONTENT_DISPOSITION
See IETF RFC-2183.static java.lang.String
CONTENT_ENCODING
static java.lang.String
CONTENT_ID
See IETF RFC-2392.static java.lang.String
CONTENT_LANGUAGE
static java.lang.String
CONTENT_LENGTH
static java.lang.String
CONTENT_LOCATION
static java.lang.String
CONTENT_TYPE
static java.lang.String
COOKIE
See IETF RFC 2109.static java.lang.String
DATE
static java.lang.String
ETAG
static java.lang.String
EXPECT
static java.lang.String
EXPIRES
static java.lang.String
HOST
static java.lang.String
IF_MATCH
static java.lang.String
IF_MODIFIED_SINCE
static java.lang.String
IF_NONE_MATCH
static java.lang.String
IF_UNMODIFIED_SINCE
static java.lang.String
LAST_EVENT_ID_HEADER
"Last-Event-ID"
HTTP request header name as defined by SSE specification.static java.lang.String
LAST_MODIFIED
static java.lang.String
LINK
static java.lang.String
LOCATION
static java.lang.String
RETRY_AFTER
static java.lang.String
SET_COOKIE
See IETF RFC 2109.static java.lang.String
USER_AGENT
static java.lang.String
VARY
static java.lang.String
WWW_AUTHENTICATE
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<java.util.Locale>
getAcceptableLanguages()
Get a list of languages that are acceptable for the response.java.util.List<MediaType>
getAcceptableMediaTypes()
Get a list of media types that are acceptable for the response.java.util.Map<java.lang.String,Cookie>
getCookies()
Get any cookies that accompanied the request.java.util.Date
getDate()
Get message date.java.lang.String
getHeaderString(java.lang.String name)
Get a HTTP header as a single string value.java.util.Locale
getLanguage()
Get the language of the request entity.int
getLength()
Get Content-Length value.MediaType
getMediaType()
Get the media type of the request entity.java.util.List<java.lang.String>
getRequestHeader(java.lang.String name)
Get the values of a HTTP request header if the header exists on the current request.MultivaluedMap<java.lang.String,java.lang.String>
getRequestHeaders()
Get the values of HTTP request headers.
-
-
-
Field Detail
-
ACCEPT
static final java.lang.String ACCEPT
- See Also:
- Constant Field Values
-
ACCEPT_CHARSET
static final java.lang.String ACCEPT_CHARSET
- See Also:
- Constant Field Values
-
ACCEPT_ENCODING
static final java.lang.String ACCEPT_ENCODING
- See Also:
- Constant Field Values
-
ACCEPT_LANGUAGE
static final java.lang.String ACCEPT_LANGUAGE
- See Also:
- Constant Field Values
-
ALLOW
static final java.lang.String ALLOW
- See Also:
- Constant Field Values
-
AUTHORIZATION
static final java.lang.String AUTHORIZATION
- See Also:
- Constant Field Values
-
CACHE_CONTROL
static final java.lang.String CACHE_CONTROL
- See Also:
- Constant Field Values
-
CONTENT_DISPOSITION
static final java.lang.String CONTENT_DISPOSITION
See IETF RFC-2183.- See Also:
- Constant Field Values
-
CONTENT_ENCODING
static final java.lang.String CONTENT_ENCODING
- See Also:
- Constant Field Values
-
CONTENT_ID
static final java.lang.String CONTENT_ID
See IETF RFC-2392.- See Also:
- Constant Field Values
-
CONTENT_LANGUAGE
static final java.lang.String CONTENT_LANGUAGE
- See Also:
- Constant Field Values
-
CONTENT_LENGTH
static final java.lang.String CONTENT_LENGTH
- See Also:
- Constant Field Values
-
CONTENT_LOCATION
static final java.lang.String CONTENT_LOCATION
- See Also:
- Constant Field Values
-
CONTENT_TYPE
static final java.lang.String CONTENT_TYPE
- See Also:
- Constant Field Values
-
DATE
static final java.lang.String DATE
- See Also:
- Constant Field Values
-
ETAG
static final java.lang.String ETAG
- See Also:
- Constant Field Values
-
EXPECT
static final java.lang.String EXPECT
- See Also:
- Constant Field Values
-
EXPIRES
static final java.lang.String EXPIRES
- See Also:
- Constant Field Values
-
HOST
static final java.lang.String HOST
- See Also:
- Constant Field Values
-
IF_MATCH
static final java.lang.String IF_MATCH
- See Also:
- Constant Field Values
-
IF_MODIFIED_SINCE
static final java.lang.String IF_MODIFIED_SINCE
- See Also:
- Constant Field Values
-
IF_NONE_MATCH
static final java.lang.String IF_NONE_MATCH
- See Also:
- Constant Field Values
-
IF_UNMODIFIED_SINCE
static final java.lang.String IF_UNMODIFIED_SINCE
- See Also:
- Constant Field Values
-
LAST_MODIFIED
static final java.lang.String LAST_MODIFIED
- See Also:
- Constant Field Values
-
LOCATION
static final java.lang.String LOCATION
- See Also:
- Constant Field Values
-
LINK
static final java.lang.String LINK
- See Also:
- Constant Field Values
-
RETRY_AFTER
static final java.lang.String RETRY_AFTER
- See Also:
- Constant Field Values
-
USER_AGENT
static final java.lang.String USER_AGENT
- See Also:
- Constant Field Values
-
VARY
static final java.lang.String VARY
- See Also:
- Constant Field Values
-
WWW_AUTHENTICATE
static final java.lang.String WWW_AUTHENTICATE
- See Also:
- Constant Field Values
-
COOKIE
static final java.lang.String COOKIE
See IETF RFC 2109.- See Also:
- Constant Field Values
-
SET_COOKIE
static final java.lang.String SET_COOKIE
See IETF RFC 2109.- See Also:
- Constant Field Values
-
LAST_EVENT_ID_HEADER
static final java.lang.String LAST_EVENT_ID_HEADER
"Last-Event-ID"
HTTP request header name as defined by SSE specification.- Since:
- 2.1
- See Also:
- Constant Field Values
-
-
Method Detail
-
getRequestHeader
java.util.List<java.lang.String> getRequestHeader(java.lang.String name)
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 ornull
if it does not. This is a shortcut forgetRequestHeaders().get(name)
.- Parameters:
name
- the header name, case insensitive.- Returns:
- a read-only list of header values if the specified header exists, otherwise
null
. - Throws:
java.lang.IllegalStateException
- if called outside the scope of a request.
-
getHeaderString
java.lang.String getHeaderString(java.lang.String name)
Get a HTTP header as a single string value.
Each single header value is converted to String using aRuntimeDelegate.HeaderDelegate
if one is available viaRuntimeDelegate.createHeaderDelegate(java.lang.Class)
for the header value class or using itstoString
method if a header delegate is not available.- Parameters:
name
- the HTTP header.- Returns:
- 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)
-
getRequestHeaders
MultivaluedMap<java.lang.String,java.lang.String> getRequestHeaders()
Get the values of HTTP request headers. The returned Map is case-insensitive wrt. keys and is read-only. The method never returnsnull
.- Returns:
- a read-only map of header names and values.
- Throws:
java.lang.IllegalStateException
- if called outside the scope of a request.
-
getAcceptableMediaTypes
java.util.List<MediaType> getAcceptableMediaTypes()
Get a list of media types that are acceptable for the response.
If no acceptable media types are specified, a read-only list containing a singlewildcard media type
instance is returned.- Returns:
- a read-only list of requested response media types sorted according to their q-value, with highest preference first.
- Throws:
java.lang.IllegalStateException
- if called outside the scope of a request.
-
getAcceptableLanguages
java.util.List<java.util.Locale> getAcceptableLanguages()
Get a list of languages that are acceptable for the response.
If no acceptable languages are specified, a read-only list containing a single wildcardLocale
instance (with language field set to "*
") is returned.- Returns:
- a read-only list of acceptable languages sorted according to their q-value, with highest preference first.
- Throws:
java.lang.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:
java.lang.IllegalStateException
- if called outside the scope of a request.
-
getLanguage
java.util.Locale getLanguage()
Get the language of the request entity.- Returns:
- the language of the entity or
null
if not specified. - Throws:
java.lang.IllegalStateException
- if called outside the scope of a request.
-
getCookies
java.util.Map<java.lang.String,Cookie> getCookies()
Get any cookies that accompanied the request.- Returns:
- a read-only map of cookie name (String) to Cookie.
- Throws:
java.lang.IllegalStateException
- if called outside the scope of a request
-
getDate
java.util.Date getDate()
Get message date.- Returns:
- the message date, otherwise
null
if not present. - Since:
- 2.0
-
getLength
int getLength()
Get Content-Length value.- Returns:
- Content-Length as integer if present and valid number. In other cases returns -1.
- Since:
- 2.0
-
-