RequestHeaders (Apache Juneau 7.1.1)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.TreeMap<String,String[]>
  - - org.apache.juneau.rest.RequestHeaders

All Implemented Interfaces:

Serializable, Cloneable, Map<String,String[]>, NavigableMap<String,String[]>, SortedMap<String,String[]>
```
public class RequestHeaders
extends TreeMap<String,String[]>
```
Represents the headers in an HTTP request.
Entries are stored in a case-insensitive map.
See Also:
- Overview > juneau-rest-server > RequestHeaders
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RequestHeaders`	`addDefault(Map<String,Object> defaultEntries)` Adds default entries to these headers.
`RequestHeaders`	`addDefault(String name, Object value)` Adds a default header value on this request.
`<T> T`	`get(HttpPartParser parser, String name, Class<T> type)` Same as `get(String, Class)` but allows you to override the part parser used.
`<T> T`	`get(HttpPartParser parser, String name, T def, Class<T> type)` Same as `get(String, Object, Class)` but allows you to override the part parser used.
`<T> T`	`get(HttpPartParser parser, String name, Type type, Type... args)` Same as `get(String, Type, Type...)` but allows you to override the part parser used.
`<T> T`	`get(String name, Class<T> type)` Returns the specified header value converted to a POJO using the `HttpPartParser` registered with the resource.
`<T> T`	`get(String name, T def, Class<T> type)` Same as `get(String, Class)` but returns a default value if not found.
`<T> T`	`get(String name, Type type, Type... args)` Returns the specified header value converted to a POJO using the `HttpPartParser` registered with the resource.
`Accept`	`getAccept()` Returns the `Accept` header on the request.
`AcceptCharset`	`getAcceptCharset()` Returns the `Accept-Charset` header on the request.
`AcceptEncoding`	`getAcceptEncoding()` Returns the `Accept-Encoding` header on the request.
`AcceptLanguage`	`getAcceptLanguage()` Returns the `Accept-Language` header on the request.
`Authorization`	`getAuthorization()` Returns the `Authorization` header on the request.
`boolean`	`getBoolean(String name)` Same as `getString(String)` but converts the value to a boolean.
`boolean`	`getBoolean(String name, boolean def)` Same as `getString(String,String)` but converts the value to a boolean.
`CacheControl`	`getCacheControl()` Returns the `Cache-Control` header on the request.
`Connection`	`getConnection()` Returns the `Connection` header on the request.
`ContentLength`	`getContentLength()` Returns the `Content-Length` header on the request.
`ContentType`	`getContentType()` Returns the `Content-Type` header on the request.
`Date`	`getDate()` Returns the `Date` header on the request.
`Expect`	`getExpect()` Returns the `Expect` header on the request.
`From`	`getFrom()` Returns the `From` header on the request.
`Host`	`getHost()` Returns the `Host` header on the request.
`IfMatch`	`getIfMatch()` Returns the `If-Match` header on the request.
`IfModifiedSince`	`getIfModifiedSince()` Returns the `If-Modified-Since` header on the request.
`IfNoneMatch`	`getIfNoneMatch()` Returns the `If-None-Match` header on the request.
`IfRange`	`getIfRange()` Returns the `If-Range` header on the request.
`IfUnmodifiedSince`	`getIfUnmodifiedSince()` Returns the `If-Unmodified-Since` header on the request.
`int`	`getInt(String name)` Same as `getString(String)` but converts the value to an integer.
`int`	`getInt(String name, int def)` Same as `getString(String,String)` but converts the value to an integer.
`MaxForwards`	`getMaxForwards()` Returns the `Max-Forwards` header on the request.
`Pragma`	`getPragma()` Returns the `Pragma` header on the request.
`ProxyAuthorization`	`getProxyAuthorization()` Returns the `Proxy-Authorization` header on the request.
`Range`	`getRange()` Returns the `Range` header on the request.
`Referer`	`getReferer()` Returns the `Referer` header on the request.
`String`	`getString(String name)` Returns the specified header value as a string.
`String`	`getString(String name, String def)` Returns the specified header value as a string.
`TE`	`getTE()` Returns the `TE` header on the request.
`TimeZone`	`getTimeZone()` Returns the `Time-Zone` header value on the request if there is one.
`Upgrade`	`getUpgrade()` Returns the `Upgrade` header on the request.
`UserAgent`	`getUserAgent()` Returns the `User-Agent` header on the request.
`Via`	`getVia()` Returns the `Via` header on the request.
`Warning`	`getWarning()` Returns the `Warning` header on the request.
`RequestHeaders`	`put(String name, Enumeration<String> values)` Adds a set of header values to this object.
`void`	`put(String name, Object value)` Sets a request header value.
`RequestHeaders`	`subset(String... headers)` Returns a copy of this object but only with the specified header names copied.
`RequestHeaders`	`subset(String headers)` Same as `subset(String...)` but allows you to specify header names as a comma-delimited list.
`String`	`toString()`
`String`	`toString(boolean sorted)` Converts the headers to a readable string.

Methods inherited from class java.util.TreeMap
ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap
equals, hashCode, isEmpty

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove

- Method Detail
  - addDefault
```
public RequestHeaders addDefault(Map<String,Object> defaultEntries)
```
    Adds default entries to these headers.
    Similar to put(String, Object) but doesn't override existing values.
    
    Parameters:
    
    defaultEntries - The default entries.
    Can be null.
    
    Returns:
    
    This object (for method chaining).
  - addDefault
```
public RequestHeaders addDefault(String name,
                                 Object value)
```
    Adds a default header value on this request.
    Similar to put(String, Object) but doesn't override existing values.
    
    Parameters:
    
    name - The header name.
    
    value - The header value.
    Converted to a String using toString().
    Ignored if value is null or blank.
    
    Returns:
    
    This object (for method chaining).
  - put
```
public RequestHeaders put(String name,
                          Enumeration<String> values)
```
    Adds a set of header values to this object.
    
    Parameters:
    
    name - The header name.
    
    values - The header values.
    
    Returns:
    
    This object (for method chaining).
  - getString
```
public String getString(String name)
```
    Returns the specified header value as a string.
    Notes:
    - If allowHeaderParams init parameter is true, then first looks for &HeaderName=x in the URL query string.
    Parameters:
    
    name - The header name.
    
    Returns:
    
    The header value, or null if it doesn't exist.
  - getString
```
public String getString(String name,
                        String def)
```
    Returns the specified header value as a string.
    Notes:
    - If allowHeaderParams init parameter is true, then first looks for &HeaderName=x in the URL query string.
    Parameters:
    
    name - The HTTP header name.
    
    def - The default value to return if the header value isn't found.
    
    Returns:
    
    The header value, or the default value if the header isn't present.
  - getInt
```
public int getInt(String name)
```
    Same as getString(String) but converts the value to an integer.
    
    Parameters:
    
    name - The HTTP header name.
    
    Returns:
    
    The header value, or the default value if the header isn't present.
  - getInt
```
public int getInt(String name,
                  int def)
```
    Same as getString(String,String) but converts the value to an integer.
    
    Parameters:
    
    name - The HTTP header name.
    
    def - The default value to return if the header value isn't found.
    
    Returns:
    
    The header value, or the default value if the header isn't present.
  - getBoolean
```
public boolean getBoolean(String name)
```
    Same as getString(String) but converts the value to a boolean.
    
    Parameters:
    
    name - The HTTP header name.
    
    Returns:
    
    The header value, or the default value if the header isn't present.
  - getBoolean
```
public boolean getBoolean(String name,
                          boolean def)
```
    Same as getString(String,String) but converts the value to a boolean.
    
    Parameters:
    
    name - The HTTP header name.
    
    def - The default value to return if the header value isn't found.
    
    Returns:
    
    The header value, or the default value if the header isn't present.
  - put
```
public void put(String name,
                Object value)
```
    Sets a request header value.
    This overwrites any previous value.
    
    Parameters:
    
    name - The header name.
    
    value - The header value.
  - get
```
public <T> T get(String name,
                 Class<T> type)
          throws ParseException
```
    Returns the specified header value converted to a POJO using the HttpPartParser registered with the resource.
    Examples:
    
    // Parse into an integer. int myheader = req.getHeader("My-Header", int.class); // Parse a UUID. UUID myheader = req.getHeader("My-Header", UUID.class);
    
    Notes:
    - If allowHeaderParams init parameter is true, then first looks for &HeaderName=x in the URL query string.
    See Also:
    - RestContext.REST_partParser
    Type Parameters:
    
    T - The class type to convert the header value to.
    
    Parameters:
    
    name - The HTTP header name.
    
    type - The class type to convert the header value to.
    
    Returns:
    
    The parameter value converted to the specified class type.
    
    Throws:
    
    ParseException
  - get
```
public <T> T get(HttpPartParser parser,
                 String name,
                 Class<T> type)
          throws ParseException
```
    Same as get(String, Class) but allows you to override the part parser used.
    
    Type Parameters:
    
    T - The class type to convert the header value to.
    
    Parameters:
    
    parser - The parser to use for parsing the string header.
    If null, uses the part parser defined on the resource/method.
    
    name - The HTTP header name.
    
    type - The class type to convert the header value to.
    
    Returns:
    
    The parameter value converted to the specified class type.
    
    Throws:
    
    ParseException
  - get
```
public <T> T get(String name,
                 T def,
                 Class<T> type)
          throws ParseException
```
    Same as get(String, Class) but returns a default value if not found.
    
    Type Parameters:
    
    T - The class type to convert the header value to.
    
    Parameters:
    
    name - The HTTP header name.
    
    def - The default value if the header was not specified or is null.
    
    type - The class type to convert the header value to.
    
    Returns:
    
    The parameter value converted to the specified class type.
    
    Throws:
    
    ParseException
  - get
```
public <T> T get(HttpPartParser parser,
                 String name,
                 T def,
                 Class<T> type)
          throws ParseException
```
    Same as get(String, Object, Class) but allows you to override the part parser used.
    
    Type Parameters:
    
    T - The class type to convert the header value to.
    
    Parameters:
    
    parser - The parser to use for parsing the string header.
    If null, uses the part parser defined on the resource/method.
    
    name - The HTTP header name.
    
    def - The default value if the header was not specified or is null.
    
    type - The class type to convert the header value to.
    
    Returns:
    
    The parameter value converted to the specified class type.
    
    Throws:
    
    ParseException
  - get
```
public <T> T get(String name,
                 Type type,
                 Type... args)
          throws ParseException
```
    Returns the specified header value converted to a POJO using the HttpPartParser registered with the resource.
    Similar to get(String,Class) but allows for complex collections of POJOs to be created.
    Examples:
    
    // Parse into a linked-list of strings. List<String> myheader = req.getHeader("My-Header", LinkedList.class, String.class);
    
    Notes:
    - Collections must be followed by zero or one parameter representing the value type.
    - Maps must be followed by zero or two parameters representing the key and value types.
    - If allowHeaderParams init parameter is true, then first looks for &HeaderName=x in the URL query string.
    See Also:
    - RestContext.REST_partParser
    Type Parameters:
    
    T - The class type to convert the header value to.
    
    Parameters:
    
    name - The HTTP header name.
    
    type - The type of object to create.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    
    args - The type arguments of the class if it's a collection or map.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    Ignored if the main type is not a map or collection.
    
    Returns:
    
    The parameter value converted to the specified class type.
    
    Throws:
    
    ParseException - If the header could not be converted to the specified type.
  - get
```
public <T> T get(HttpPartParser parser,
                 String name,
                 Type type,
                 Type... args)
          throws ParseException
```
    Same as get(String, Type, Type...) but allows you to override the part parser used.
    
    Type Parameters:
    
    T - The class type to convert the header value to.
    
    Parameters:
    
    parser - The parser to use for parsing the string header.
    If null, uses the part parser defined on the resource/method.
    
    name - The HTTP header name.
    
    type - The type of object to create.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    
    args - The type arguments of the class if it's a collection or map.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    Ignored if the main type is not a map or collection.
    
    Returns:
    
    The parameter value converted to the specified class type.
    
    Throws:
    
    ParseException - If the header could not be converted to the specified type.
  - subset
```
public RequestHeaders subset(String... headers)
```
    Returns a copy of this object but only with the specified header names copied.
    
    Parameters:
    
    headers - The headers to include in the copy.
    
    Returns:
    
    A new headers object.
  - subset
```
public RequestHeaders subset(String headers)
```
    Same as subset(String...) but allows you to specify header names as a comma-delimited list.
    
    Parameters:
    
    headers - The headers to include in the copy.
    
    Returns:
    
    A new headers object.
  - getAccept
```
public Accept getAccept()
```
    Returns the Accept header on the request.
    Content-Types that are acceptable for the response.
    Example:
    
    Accept: text/plain
    
    Returns:
    
    The parsed Accept header on the request, or null if not found.
  - getAcceptCharset
```
public AcceptCharset getAcceptCharset()
```
    Returns the Accept-Charset header on the request.
    Character sets that are acceptable.
    Example:
    
    Accept-Charset: utf-8
    
    Returns:
    
    The parsed Accept-Charset header on the request, or null if not found.
  - getAcceptEncoding
```
public AcceptEncoding getAcceptEncoding()
```
    Returns the Accept-Encoding header on the request.
    List of acceptable encodings.
    Example:
    
    Accept-Encoding: gzip, deflate
    
    Returns:
    
    The parsed Accept-Encoding header on the request, or null if not found.
  - getAcceptLanguage
```
public AcceptLanguage getAcceptLanguage()
```
    Returns the Accept-Language header on the request.
    List of acceptable human languages for response.
    Example:
    
    Accept-Language: en-US
    
    Returns:
    
    The parsed Accept-Language header on the request, or null if not found.
  - getAuthorization
```
public Authorization getAuthorization()
```
    Returns the Authorization header on the request.
    Authentication credentials for HTTP authentication.
    Example:
    
    Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
    
    Returns:
    
    The parsed Authorization header on the request, or null if not found.
  - getCacheControl
```
public CacheControl getCacheControl()
```
    Returns the Cache-Control header on the request.
    Used to specify directives that must be obeyed by all caching mechanisms along the request-response chain.
    Example:
    
    Cache-Control: no-cache
    
    Returns:
    
    The parsed Cache-Control header on the request, or null if not found.
  - getConnection
```
public Connection getConnection()
```
    Returns the Connection header on the request.
    Control options for the current connection and list of hop-by-hop request fields.
    Example:
    
    Connection: keep-alive Connection: Upgrade
    
    Returns:
    
    The parsed header on the request, or null if not found.
  - getContentLength
```
public ContentLength getContentLength()
```
    Returns the Content-Length header on the request.
    The length of the request body in octets (8-bit bytes).
    Example:
    
    Content-Length: 348
    
    Returns:
    
    The parsed Content-Length header on the request, or null if not found.
  - getContentType
```
public ContentType getContentType()
```
    Returns the Content-Type header on the request.
    The MIME type of the body of the request (used with POST and PUT requests).
    Example:
    
    Content-Type: application/x-www-form-urlencoded
    
    Returns:
    
    The parsed Content-Type header on the request, or null if not found.
  - getDate
```
public Date getDate()
```
    Returns the Date header on the request.
    The date and time that the message was originated (in "HTTP-date" format as defined by RFC 7231 Date/Time Formats).
    Example:
    
    Date: Tue, 15 Nov 1994 08:12:31 GMT
    
    Returns:
    
    The parsed Date header on the request, or null if not found.
  - getExpect
```
public Expect getExpect()
```
    Returns the Expect header on the request.
    Indicates that particular server behaviors are required by the client.
    Example:
    
    Expect: 100-continue
    
    Returns:
    
    The parsed Expect header on the request, or null if not found.
  - getFrom
```
public From getFrom()
```
    Returns the From header on the request.
    The email address of the user making the request.
    Example:
    
    From: user@example.com
    
    Returns:
    
    The parsed From header on the request, or null if not found.
  - getHost
```
public Host getHost()
```
    Returns the Host header on the request.
    The domain name of the server (for virtual hosting), and the TCP port number on which the server is listening. The port number may be omitted if the port is the standard port for the service requested.
    Example:
    
    Host: en.wikipedia.org:8080 Host: en.wikipedia.org
    
    Returns:
    
    The parsed Host header on the request, or null if not found.
  - getIfMatch
```
public IfMatch getIfMatch()
```
    Returns the If-Match header on the request.
    Only perform the action if the client supplied entity matches the same entity on the server. This is mainly for methods like PUT to only update a resource if it has not been modified since the user last updated it.
    Example:
    
    If-Match: "737060cd8c284d8af7ad3082f209582d"
    
    Returns:
    
    The parsed If-Match header on the request, or null if not found.
  - getIfModifiedSince
```
public IfModifiedSince getIfModifiedSince()
```
    Returns the If-Modified-Since header on the request.
    Allows a 304 Not Modified to be returned if content is unchanged.
    Example:
    
    If-Modified-Since: Sat, 29 Oct 1994 19:43:31 GMT
    
    Returns:
    
    The parsed If-Modified-Since header on the request, or null if not found.
  - getIfNoneMatch
```
public IfNoneMatch getIfNoneMatch()
```
    Returns the If-None-Match header on the request.
    Allows a 304 Not Modified to be returned if content is unchanged, see HTTP ETag.
    Example:
    
    If-None-Match: "737060cd8c284d8af7ad3082f209582d"
    
    Returns:
    
    The parsed If-None-Match header on the request, or null if not found.
  - getIfRange
```
public IfRange getIfRange()
```
    Returns the If-Range header on the request.
    If the entity is unchanged, send me the part(s) that I am missing; otherwise, send me the entire new entity.
    Example:
    
    If-Range: "737060cd8c284d8af7ad3082f209582d"
    
    Returns:
    
    The parsed If-Range header on the request, or null if not found.
  - getIfUnmodifiedSince
```
public IfUnmodifiedSince getIfUnmodifiedSince()
```
    Returns the If-Unmodified-Since header on the request.
    Only send the response if the entity has not been modified since a specific time.
    Example:
    
    If-Unmodified-Since: Sat, 29 Oct 1994 19:43:31 GMT
    
    Returns:
    
    The parsed If-Unmodified-Since header on the request, or null if not found.
  - getMaxForwards
```
public MaxForwards getMaxForwards()
```
    Returns the Max-Forwards header on the request.
    Limit the number of times the message can be forwarded through proxies or gateways.
    Example:
    
    Max-Forwards: 10
    
    Returns:
    
    The parsed Max-Forwards header on the request, or null if not found.
  - getPragma
```
public Pragma getPragma()
```
    Returns the Pragma header on the request.
    Implementation-specific fields that may have various effects anywhere along the request-response chain.
    Example:
    
    Pragma: no-cache
    
    Returns:
    
    The parsed Pragma header on the request, or null if not found.
  - getProxyAuthorization
```
public ProxyAuthorization getProxyAuthorization()
```
    Returns the Proxy-Authorization header on the request.
    Authorization credentials for connecting to a proxy.
    Example:
    
    Proxy-Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
    
    Returns:
    
    The parsed Proxy-Authorization header on the request, or null if not found.
  - getRange
```
public Range getRange()
```
    Returns the Range header on the request.
    Request only part of an entity. Bytes are numbered from 0.
    Example:
    
    Range: bytes=500-999
    
    Returns:
    
    The parsed Range header on the request, or null if not found.
  - getReferer
```
public Referer getReferer()
```
    Returns the Referer header on the request.
    This is the address of the previous web page from which a link to the currently requested page was followed.
    Example:
    
    Referer: http://en.wikipedia.org/wiki/Main_Page
    
    Returns:
    
    The parsed Referer header on the request, or null if not found.
  - getTE
```
public TE getTE()
```
    Returns the TE header on the request.
    The transfer encodings the user agent is willing to accept: the same values as for the response header field Transfer-Encoding can be used, plus the "trailers" value (related to the "chunked" transfer method) to notify the server it expects to receive additional fields in the trailer after the last, zero-sized, chunk.
    Example:
    
    TE: trailers, deflate
    
    Returns:
    
    The parsed TE header on the request, or null if not found.
  - getTimeZone
```
public TimeZone getTimeZone()
```
    Returns the Time-Zone header value on the request if there is one.
    Example: "GMT".
    
    Returns:
    
    The Time-Zone header value on the request, or null if not present.
  - getUserAgent
```
public UserAgent getUserAgent()
```
    Returns the User-Agent header on the request.
    The user agent string of the user agent.
    Example:
    
    User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:12.0) Gecko/20100101 Firefox/21.0
    
    Returns:
    
    The parsed User-Agent header on the request, or null if not found.
  - getUpgrade
```
public Upgrade getUpgrade()
```
    Returns the Upgrade header on the request.
    Ask the server to upgrade to another protocol.
    Example:
    
    Upgrade: HTTP/2.0, HTTPS/1.3, IRC/6.9, RTA/x11, websocket
    
    Returns:
    
    The parsed Upgrade header on the request, or null if not found.
  - getVia
```
public Via getVia()
```
    Returns the Via header on the request.
    Informs the server of proxies through which the request was sent.
    Example:
    
    Via: 1.0 fred, 1.1 example.com (Apache/1.1)
    
    Returns:
    
    The parsed Via header on the request, or null if not found.
  - getWarning
```
public Warning getWarning()
```
    Returns the Warning header on the request.
    A general warning about possible problems with the entity body.
    Example:
    
    Warning: 199 Miscellaneous warning
    
    Returns:
    
    The parsed Warning header on the request, or null if not found.
  - toString
```
public String toString(boolean sorted)
```
    Converts the headers to a readable string.
    
    Parameters:
    
    sorted - Sort the headers by name.
    
    Returns:
    
    A JSON string containing the contents of the headers.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractMap<String,String[]>

Class RequestHeaders

See Also:

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Method Summary

Methods inherited from class java.util.TreeMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Method Detail

addDefault

addDefault

put

getString

Notes:

getString

Notes:

getInt

getInt

getBoolean

getBoolean

put

get

Examples:

Notes:

See Also:

get

get

get

get

Examples:

Notes:

See Also:

get

subset

subset

getAccept

Example:

getAcceptCharset

Example:

getAcceptEncoding

Example:

getAcceptLanguage

Example:

getAuthorization

Example:

getCacheControl

Example:

getConnection

Example:

getContentLength

Example:

getContentType

Example:

getDate

Example:

getExpect

Example:

getFrom

Example:

getHost

Example:

getIfMatch

Example:

getIfModifiedSince

Example:

getIfNoneMatch

Example:

getIfRange

Example:

getIfUnmodifiedSince

Example:

getMaxForwards

Example:

getPragma

Example:

getProxyAuthorization

Example:

getRange

Example: