Headers (PingAccess Addon SDK)

```
public interface Headers
```
An ordered collection of zero or more HeaderFields. A HeadersFactory must be used to create an instance of this interface.

Since:

4.1

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`add(HeaderName name, String value)` Add a `HeaderField` to this `Headers` object.
`void`	`add(String name, String value)` Add a `HeaderField` to this `Headers` object.
`boolean`	`contains(String name)` Returns true if this `Headers` object contains a `HeaderField` with the specified name.
`List<String>`	`getAccept()` Gets all the values for the Accept `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`String`	`getAccessControlAllowCredentials()` Gets the value from the first Access-Control-Allow-Credentials `HeaderField`.
`List<String>`	`getAccessControlAllowHeaders()` Gets all the values for the Access-Control-Allow-Headers `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`List<String>`	`getAccessControlAllowMethods()` Gets all the values for the Access-Control-Allow-Methods `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`String`	`getAccessControlAllowOrigin()` Gets the value from the first Access-Control-Allow-Origin `HeaderField`.
`List<String>`	`getAccessControlExposeHeaders()` Gets all the values for the Access-Control-Expose-Headers `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`String`	`getAccessControlMaxAge()` Gets the value from the first Access-Control-Max-Age `HeaderField`.
`List<String>`	`getAccessControlRequestHeaders()` Gets all the values for the Access-Control-Request-Headers `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`String`	`getAccessControlRequestMethod()` Gets the value from the first Access-Control-Request-Method `HeaderField`.
`String`	`getAuthorization()` Gets the value from the first Authorization `HeaderField`.
`List<String>`	`getCacheControl()` Gets all the values for the Cache-Control `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`Charset`	`getCharset()` Gets the `Charset` from the first Content-Type `HeaderField`.
`List<String>`	`getConnection()` Gets all the values for the Connection `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`String`	`getContentDisposition()` Gets the value from the first Content-Disposition `HeaderField`.
`List<String>`	`getContentEncoding()` Gets all the values for the Content-Encoding `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`long`	`getContentLength()` Gets the length, in bytes, of the associated message body.
`String`	`getContentLocation()` Gets the value from the first Content-Location `HeaderField`.
`MediaType`	`getContentType()` Gets a `MediaType` representing the value fo the first Content-Type `HeaderField`.
`Map<String,String[]>`	`getCookies()` Gets a map of HTTP cookies extracted from any Cookie `HeaderField`s.
`Instant`	`getDate()` Gets the value from the first Date `HeaderField`.
`String`	`getFirstCookieValue(String name)` Gets the value of the first cookie with the specified name
`String`	`getFirstValue(String name)` Gets the first value from the first `HeaderField` with the specified name where values within a `HeaderField` value are separated by a comma, excluding commas in a quoted string or comment blocks.
`List<HeaderField>`	`getHeaderFields()` Gets a `List` containing all the `HeaderField`s in this `Headers` object.
`String`	`getHost()` Gets the value from the first Host `HeaderField`.
`Instant`	`getLastModified()` Gets the value from the first Last-Modified `HeaderField`.
`String`	`getLastValue(String name)` Gets the last value for the last `HeaderField` with the specified name where values within a `HeaderField` value are separated by a comma, excluding commas in a quoted string or comment blocks.
`List<Locale>`	`getLocales()` Gets the locales in order of preference specified in the Accept-Language header.
`String`	`getLocation()` Gets the value from the first Location `HeaderField`.
`Set<HeaderName>`	`getModifiedHeaderNames()`
`String`	`getOrigin()` Gets the value from the first Origin `HeaderField`.
`String`	`getProxyAuthorization()` Gets the value from the first Proxy-Authorization `HeaderField`.
`List<String>`	`getProxyConnection()` Gets all the values for the Proxy-Connection `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`Set<HeaderName>`	`getRemovedHeaderNames()`
`String`	`getSecWebSocketAccept()` Gets the value from the first Sec-WebSocket-Accept `HeaderField`.
`List<String>`	`getSecWebSocketExtensions()` Gets all the values for the Sec-WebSocket-Extensions `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`String`	`getSecWebSocketKey()` Gets the value from the first Sec-WebSocket-Key `HeaderField`.
`List<String>`	`getSecWebSocketProtocol()` Gets all the values for the Sec-WebSocket-Protocol `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`String`	`getSecWebSocketVersion()` Gets the first value from the first Sec-WebSocket-Version `HeaderField`.
`String`	`getServer()` Gets the value from the first Server `HeaderField`.
`List<String>`	`getSetCookie()` Gets all the values from the Set-Cookie `HeaderField`s in this `Headers` object.
`List<String>`	`getTransferEncoding()` Gets all the values from the Transfer-Encoding `HeaderField`s in this `Headers` object.
`List<String>`	`getUpgrade()` Gets all the values for the Upgrade `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`List<String>`	`getURIs()` Returns all URI headers, including any variants defined via the vary parameter.
`List<String>`	`getValues(String name)` Gets the values of all the `HeaderField`s with the specified name.
`List<String>`	`getVary()` Gets all the values for the Vary `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`List<String>`	`getXForwardedFor()` Gets all the values for the X-Forwarded-For `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`List<String>`	`getXForwardedHost()` Gets all the values for the X-Forwarded-Host `HeaderField`s in this `Headers` object where values within in a `HeaderField` are separated by a comma.
`String`	`getXForwardedProto()` Gets the first value from the first X-Forwarded-Proto `HeaderField`.
`String`	`getXFrameOptions()` Gets the value from the first X-Frame-Options `HeaderField`.
`boolean`	`isChunked()` Helper method to determine if this `Headers` object contains header fields that indicate the related HTTP message body uses a chunked Transfer-Encoding.
`boolean`	`removeFields(String name)` Removes all `HeaderField`s with the specified name.
`void`	`setAccept(List<String> values)` Replaces all the values of the Accept `HeaderField`s in this `Headers` object.
`void`	`setAccessControlAllowCredentials(String value)` Sets the value for the first Access-Control-Allow-Credentials `HeaderField`.
`void`	`setAccessControlAllowHeaders(List<String> values)` Replaces all the values of the Access-Control-Allow-Headers `HeaderField`s in this `Headers` object.
`void`	`setAccessControlAllowMethods(List<String> values)` Replaces all the values of the Access-Control-Allow-Methods `HeaderField`s in this `Headers` object.
`void`	`setAccessControlAllowOrigin(String value)` Sets the value for the first Access-Control-Allow-Origin `HeaderField`.
`void`	`setAccessControlExposeHeaders(List<String> values)` Replaces all the values of the Access-Control-Expose-Headers `HeaderField`s in this `Headers` object.
`void`	`setAccessControlMaxAge(String value)` Sets the value for the first Access-Control-Max-Age `HeaderField`.
`void`	`setAccessControlRequestHeaders(List<String> values)` Replaces all the values of the Access-Control-Request-Headers `HeaderField`s in this `Headers` object.
`void`	`setAccessControlRequestMethod(String value)` Sets the value for the first Access-Control-Request-Method `HeaderField`.
`void`	`setAuthorization(String value)` Sets the value for the first Authorization `HeaderField`.
`void`	`setCacheControl(List<String> values)` Replaces all the values of the Cache-Control `HeaderField`s in this `Headers` object.
`void`	`setConnection(List<String> values)` Replaces all the values for the Connection `HeaderField`s in this `Headers` object.
`void`	`setContentDisposition(String value)` Sets the value for the first Content-Disposition `HeaderField`.
`void`	`setContentEncoding(List<String> values)` Replaces all the values for the Content-Encoding `HeaderField`s in this `Headers` object.
`void`	`setContentLength(long value)` Sets the value for the first Content-Length `HeaderField`.
`void`	`setContentLocation(String value)` Sets the value for the first Content-Location `HeaderField`.
`void`	`setContentType(MediaType value)` Sets the value for the first Content-Type `HeaderField`.
`void`	`setContentType(String value)` Sets the value for the first Content-Type `HeaderField`.
`void`	`setCookies(Map<String,String[]> cookies)` Replaces the cookies in this `Headers` object with the specified cookies.
`void`	`setDate(Instant value)` Sets the value for the first Date `HeaderField`.
`void`	`setFirstValue(String name, String value)` Sets the value of the first `HeaderField` with the specified name.
`void`	`setHost(String value)` Sets the value for the first Host `HeaderField`.
`void`	`setLastModified(Instant value)` Sets the value for the first Last-Modified `HeaderField`.
`void`	`setLastValue(String name, String value)` Sets the value of the last `HeaderField` with the specified name.
`void`	`setLocation(String value)` Sets the value for the first Location `HeaderField`.
`void`	`setOrigin(String value)` Sets the value for the first Origin `HeaderField`.
`void`	`setProxyAuthorization(String value)` Sets the value for the first Proxy-Authorization `HeaderField`.
`void`	`setProxyConnection(List<String> values)` Replaces all the values for the Proxy-Connection `HeaderField`s in this `Headers` object.
`void`	`setSecWebSocketAccept(String value)` Sets the value for the first Sec-WebSocket-Accept `HeaderField`.
`void`	`setSecWebSocketExtensions(List<String> values)` Replaces all the values of the Sec-WebSocket-Extensions `HeaderField`s in this `Headers` object.
`void`	`setSecWebSocketKey(String value)` Sets the value for the first Sec-WebSocket-Key `HeaderField`.
`void`	`setSecWebSocketProtocol(List<String> values)` Replaces all the values of the Sec-WebSocket-Protocol `HeaderField`s in this `Headers` object.
`void`	`setSecWebSocketVersion(String value)` Sets the value for the first Sec-WebSocket-Version `HeaderField`.
`void`	`setServer(String value)` Sets the value for the first Server `HeaderField`.
`void`	`setSetCookie(List<String> values)` Replaces all the values of the Set-Cookie `HeaderField`s in this `Headers` object.
`void`	`setTransferEncoding(List<String> values)` Replaces all the values of the Transfer-Encoding `HeaderField`s in this `Headers` object.
`void`	`setUpgrade(List<String> values)` Replaces all the values for the Upgrade `HeaderField`s in this `Headers` object.
`void`	`setURIs(List<String> values)` Replaces all the values of the URI `HeaderField`s in this `Headers` object.
`void`	`setValues(String name, List<String> values)` Replaces all the values of the `HeaderField`s with the specified name.
`void`	`setVary(List<String> values)` Replaces all the values for the Vary `HeaderField`s in this `Headers` object.
`void`	`setXForwardedFor(List<String> values)` Replaces all the values for the X-Forwarded-For `HeaderField`s in this `Headers` object.
`void`	`setXForwardedHost(List<String> values)` Replaces all the values for the X-Forwarded-Host `HeaderField`s in this `Headers` object.
`void`	`setXForwardedProto(String value)` Sets the value for the first X-Forwarded-Proto `HeaderField`.
`void`	`setXFrameOptions(String value)` Sets the value for the first X-Frame-Options `HeaderField`.

- Method Detail
  - getHeaderFields
```
List<HeaderField> getHeaderFields()
```
    Gets a List containing all the HeaderFields in this Headers object.
    Note: modifications to the HeaderFields via HeaderField.setValue(String) will not result in the associated HeaderName being present in the Set returned by getModifiedHeaderNames().
    
    Returns:
    
    an unmodifiable List containing all the HeaderFields in this Headers object.
  - contains
```
boolean contains(String name)
```
    Returns true if this Headers object contains a HeaderField with the specified name. Note: this method is more efficient than getValues(name).isEmpty() since a temporary collection is not built to perform the query.
    
    Parameters:
    
    name - the name of the HeaderField to search for.
    
    Returns:
    
    true if this Headers object contains a HeaderField with the specified name.
  - getFirstValue
```
String getFirstValue(String name)
```
    Gets the first value from the first HeaderField with the specified name where values within a HeaderField value are separated by a comma, excluding commas in a quoted string or comment blocks.
    
    Parameters:
    
    name - the name of the HeaderField to look up.
    
    Returns:
    
    the value or null if no HeaderField exists with the specified name.
    
    See Also:
    
    RFC 7230, Section 3.2.6
  - getLastValue
```
String getLastValue(String name)
```
    Gets the last value for the last HeaderField with the specified name where values within a HeaderField value are separated by a comma, excluding commas in a quoted string or comment blocks.
    
    Parameters:
    
    name - the name of the HeaderField to look up.
    
    Returns:
    
    the value or null if no HeaderField exists with the specified name.
  - getValues
```
List<String> getValues(String name)
```
    Gets the values of all the HeaderFields with the specified name. Like getFirstValue(String) and getLastValue(String), this method splits HeaderField values separated by a comma, excluding commas in a quoted string or comment blocks.
    
    Parameters:
    
    name - the name of the HeaderField to look up.
    
    Returns:
    
    the values of the HeaderFields with the specified name. An empty List if no HeaderField with specified name exists.
    
    See Also:
    
    RFC 7230, Section 3.2.6
  - setFirstValue
```
void setFirstValue(String name,
                   String value)
```
    Sets the value of the first HeaderField with the specified name. If no HeaderField with the specified name exists, a new HeaderField is added to the end of this Headers object.
    
    Parameters:
    
    name - the name of the HeaderField to modify.
    
    value - the value
  - setLastValue
```
void setLastValue(String name,
                  String value)
```
    Sets the value of the last HeaderField with the specified name. If no HeaderField with the specified name exists, a new HeaderField is added to the end of this Headers object.
    
    Parameters:
    
    name - the name of the HeaderField to modify.
    
    value - the value
  - setValues
```
void setValues(String name,
               List<String> values)
```
    Replaces all the values of the HeaderFields with the specified name. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields with the specified name.
    
    Parameters:
    
    name - the name of the HeaderField
    
    values - the values to be concatenated
  - getRemovedHeaderNames
```
Set<HeaderName> getRemovedHeaderNames()
```
    Returns:
    
    a list of HeaderField names that have been removed from this Headers object after it was created.
  - getModifiedHeaderNames
```
Set<HeaderName> getModifiedHeaderNames()
```
    Returns:
    
    a list of HeaderField names that have been added to or modified in this Headers object after it was created.
  - add
```
void add(HeaderName name,
         String value)
```
    Add a HeaderField to this Headers object.
    
    Parameters:
    
    name - the HeaderName for a HeaderField to add.
    
    value - the value for a HeaderField to add.
  - add
```
void add(String name,
         String value)
```
    Add a HeaderField to this Headers object.
    
    Parameters:
    
    name - the name for a HeaderField to add.
    
    value - the value for a HeaderField to add.
  - removeFields
```
boolean removeFields(String name)
```
    Removes all HeaderFields with the specified name.
    
    Parameters:
    
    name - the name of the header fields to be removed
    
    Returns:
    
    true if one or more HeaderFields were removed
  - getAccept
```
List<String> getAccept()
```
    Gets all the values for the Accept HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the Accept HeaderFields. An empty List if the header field is not present.
  - setAccept
```
void setAccept(List<String> values)
```
    Replaces all the values of the Accept HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values of the Accept HeaderFields.
  - getAccessControlAllowCredentials
```
String getAccessControlAllowCredentials()
```
    Gets the value from the first Access-Control-Allow-Credentials HeaderField.
    
    Returns:
    
    the value from the first Access-Control-Allow-Credentials HeaderField or null if no Access-Control-Allow-Credentials HeaderField is present.
  - setAccessControlAllowCredentials
```
void setAccessControlAllowCredentials(String value)
```
    Sets the value for the first Access-Control-Allow-Credentials HeaderField. If no Access-Control-Allow-Credentials HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Access-Control-Allow-Credentials HeaderField.
  - getAccessControlAllowHeaders
```
List<String> getAccessControlAllowHeaders()
```
    Gets all the values for the Access-Control-Allow-Headers HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the Access-Control-Allow-Headers HeaderFields. An empty List if the header field is not present.
  - setAccessControlAllowHeaders
```
void setAccessControlAllowHeaders(List<String> values)
```
    Replaces all the values of the Access-Control-Allow-Headers HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values of the Access-Control-Allow-Headers HeaderFields.
  - getAccessControlAllowMethods
```
List<String> getAccessControlAllowMethods()
```
    Gets all the values for the Access-Control-Allow-Methods HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the Access-Control-Allow-Methods HeaderFields. An empty List if the header field is not present.
  - setAccessControlAllowMethods
```
void setAccessControlAllowMethods(List<String> values)
```
    Replaces all the values of the Access-Control-Allow-Methods HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values of the Access-Control-Allow-Methods HeaderFields.
  - getAccessControlAllowOrigin
```
String getAccessControlAllowOrigin()
```
    Gets the value from the first Access-Control-Allow-Origin HeaderField.
    
    Returns:
    
    the value from the first Access-Control-Allow-Origin HeaderField or null if no Access-Control-Allow-Origin HeaderField is present.
  - setAccessControlAllowOrigin
```
void setAccessControlAllowOrigin(String value)
```
    Sets the value for the first Access-Control-Allow-Origin HeaderField. If no Access-Control-Allow-Origin HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Access-Control-Allow-Origin HeaderField.
  - getAccessControlExposeHeaders
```
List<String> getAccessControlExposeHeaders()
```
    Gets all the values for the Access-Control-Expose-Headers HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the Access-Control-Expose-Headers HeaderFields. An empty List if the header field is not present.
  - setAccessControlExposeHeaders
```
void setAccessControlExposeHeaders(List<String> values)
```
    Replaces all the values of the Access-Control-Expose-Headers HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values of the Access-Control-Expose-Headers HeaderFields.
  - getAccessControlMaxAge
```
String getAccessControlMaxAge()
```
    Gets the value from the first Access-Control-Max-Age HeaderField.
    
    Returns:
    
    the value from the first Access-Control-Max-Age HeaderField or null if no Access-Control-Max-Age HeaderField is present.
  - setAccessControlMaxAge
```
void setAccessControlMaxAge(String value)
```
    Sets the value for the first Access-Control-Max-Age HeaderField. If no Access-Control-Max-Age HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Access-Control-Max-Age HeaderField.
  - getAccessControlRequestHeaders
```
List<String> getAccessControlRequestHeaders()
```
    Gets all the values for the Access-Control-Request-Headers HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the Access-Control-Request-Headers HeaderFields. An empty List if the header field is not present.
  - setAccessControlRequestHeaders
```
void setAccessControlRequestHeaders(List<String> values)
```
    Replaces all the values of the Access-Control-Request-Headers HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values of the Access-Control-Request-Headers HeaderFields.
  - getAccessControlRequestMethod
```
String getAccessControlRequestMethod()
```
    Gets the value from the first Access-Control-Request-Method HeaderField.
    
    Returns:
    
    the value from the first Access-Control-Request-Method HeaderField or null if no Access-Control-Request-Method HeaderField is present.
  - setAccessControlRequestMethod
```
void setAccessControlRequestMethod(String value)
```
    Sets the value for the first Access-Control-Request-Method HeaderField. If no Access-Control-Request-Method HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Access-Control-Request-Method HeaderField.
  - getAuthorization
```
String getAuthorization()
```
    Gets the value from the first Authorization HeaderField.
    
    Returns:
    
    the value from the first Authorization HeaderField or null if no Authorization HeaderField is present.
  - setAuthorization
```
void setAuthorization(String value)
```
    Sets the value for the first Authorization HeaderField. If no Authorization HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Authorization HeaderField.
  - getCacheControl
```
List<String> getCacheControl()
```
    Gets all the values for the Cache-Control HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the Cache-Control HeaderFields. An empty List if the header field is not present.
  - setCacheControl
```
void setCacheControl(List<String> values)
```
    Replaces all the values of the Cache-Control HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values of the Cache-Control HeaderFields.
  - getCharset
```
Charset getCharset()
```
    Gets the Charset from the first Content-Type HeaderField.
    
    Returns:
    
    the Charset from the first Content-Type HeaderField, null if the Content-Type HeaderField is not present or the charset parameter is not specified in the Content-Type value.
    
    Throws:
    
    IllegalArgumentException - if the Content-Type value is not a valid MediaType
    
    IllegalCharsetNameException - if the charset parameter on the MediaType is invalid
  - getConnection
```
List<String> getConnection()
```
    Gets all the values for the Connection HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the Connection HeaderFields. An empty List if the header field is not present.
  - setConnection
```
void setConnection(List<String> values)
```
    Replaces all the values for the Connection HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values for the Connection HeaderFields in this Headers object.
  - getContentEncoding
```
List<String> getContentEncoding()
```
    Gets all the values for the Content-Encoding HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the Content-Encoding HeaderFields. An empty List if the header field is not present.
  - setContentEncoding
```
void setContentEncoding(List<String> values)
```
    Replaces all the values for the Content-Encoding HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values for the Content-Encoding HeaderFields in this Headers object.
  - getContentDisposition
```
String getContentDisposition()
```
    Gets the value from the first Content-Disposition HeaderField.
    
    Returns:
    
    the value from the first Content-Disposition HeaderField or null if no Content-Disposition HeaderField is present.
  - setContentDisposition
```
void setContentDisposition(String value)
```
    Sets the value for the first Content-Disposition HeaderField. If no Content-Disposition HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Content-Disposition HeaderField
  - getContentLength
```
long getContentLength()
```
    Gets the length, in bytes, of the associated message body.
    
    Returns:
    
    the length, in bytes, of the associated message body, or -1 if the length is not known or the value is invalid.
  - setContentLength
```
void setContentLength(long value)
```
    Sets the value for the first Content-Length HeaderField. If no Content-Length HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Content-Length HeaderField.
  - getContentLocation
```
String getContentLocation()
```
    Gets the value from the first Content-Location HeaderField.
    
    Returns:
    
    the value from the first Content-Location HeaderField or null if no Content-Location HeaderField is present.
  - setContentLocation
```
void setContentLocation(String value)
```
    Sets the value for the first Content-Location HeaderField. If no Content-Location HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Content-Location HeaderField
  - getContentType
```
MediaType getContentType()
```
    Gets a MediaType representing the value fo the first Content-Type HeaderField.
    
    Returns:
    
    a MediaType representing the value of the Content-Type HeaderField, or null if the Content-Type HeaderField does not exist.
    
    Throws:
    
    IllegalArgumentException - if the Content-Type value is not a valid MediaType
  - setContentType
```
void setContentType(MediaType value)
```
    Sets the value for the first Content-Type HeaderField. If no Content-Type HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Content-Type HeaderField.
  - setContentType
```
void setContentType(String value)
```
    Sets the value for the first Content-Type HeaderField. If no Content-Type HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Content-Type HeaderField.
  - getCookies
```
Map<String,String[]> getCookies()
```
    Gets a map of HTTP cookies extracted from any Cookie HeaderFields.
    
    Returns:
    
    a map of cookies extracted from any Cookie HeaderFields. An empty Map if there are no Cookie HeaderField.
  - setCookies
```
void setCookies(Map<String,String[]> cookies)
```
    Replaces the cookies in this Headers object with the specified cookies.
    
    Parameters:
    
    cookies - the cookies to replace on this Headers object. An empty value will remove all cookies from this Headers object.
    
    Throws:
    
    NullPointerException - if cookies is null.
  - getFirstCookieValue
```
String getFirstCookieValue(String name)
```
    Gets the value of the first cookie with the specified name
    
    Parameters:
    
    name - the name of the cookie to look up.
    
    Returns:
    
    the cookie value or null if no cookie exists in this Headers object with the specified name.
  - getDate
```
Instant getDate()
```
    Gets the value from the first Date HeaderField.
    
    Returns:
    
    the value from the first Date HeaderField or null if no Date HeaderField is present.
  - setDate
```
void setDate(Instant value)
```
    Sets the value for the first Date HeaderField. If no Date HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Date HeaderField
  - getHost
```
String getHost()
```
    Gets the value from the first Host HeaderField.
    
    Returns:
    
    the value from the first Host HeaderField or null if no Host HeaderField is present.
  - setHost
```
void setHost(String value)
```
    Sets the value for the first Host HeaderField. If no Host HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Host HeaderField.
  - getLastModified
```
Instant getLastModified()
```
    Gets the value from the first Last-Modified HeaderField. A Last-Modified HeaderField is expected to only contain a single value.
    
    Returns:
    
    the value the first Last-Modified HeaderField or null if no Last-Modified HeaderField is present.
  - setLastModified
```
void setLastModified(Instant value)
```
    Sets the value for the first Last-Modified HeaderField. If no Last-Modified HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Last-Modified HeaderField.
  - getLocation
```
String getLocation()
```
    Gets the value from the first Location HeaderField.
    
    Returns:
    
    the value from the first Location HeaderField or null if no Location HeaderField is present.
  - setLocation
```
void setLocation(String value)
```
    Sets the value for the first Location HeaderField. If no Location HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Location HeaderField.
  - getOrigin
```
String getOrigin()
```
    Gets the value from the first Origin HeaderField.
    
    Returns:
    
    the value from the first Origin HeaderField or null if no Origin HeaderField is present.
  - setOrigin
```
void setOrigin(String value)
```
    Sets the value for the first Origin HeaderField. If no Origin HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Origin HeaderField.
  - getProxyAuthorization
```
String getProxyAuthorization()
```
    Gets the value from the first Proxy-Authorization HeaderField.
    
    Returns:
    
    the value from the first Proxy-Authorization HeaderField or null if no Origin HeaderField is present.
  - setProxyAuthorization
```
void setProxyAuthorization(String value)
```
    Sets the value for the first Proxy-Authorization HeaderField. If no Proxy-Authorization HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Proxy-Authorization HeaderField.
  - getProxyConnection
```
List<String> getProxyConnection()
```
    Gets all the values for the Proxy-Connection HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the Proxy-Connection HeaderFields. An empty List if the header field is not present.
  - setProxyConnection
```
void setProxyConnection(List<String> values)
```
    Replaces all the values for the Proxy-Connection HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values for the Proxy-Connection HeaderFields in this Headers object.
  - getSecWebSocketKey
```
String getSecWebSocketKey()
```
    Gets the value from the first Sec-WebSocket-Key HeaderField.
    
    Returns:
    
    the value from the first Sec-WebSocket-Key HeaderField or null if no Sec-WebSocket-Key HeaderField is present.
  - setSecWebSocketKey
```
void setSecWebSocketKey(String value)
```
    Sets the value for the first Sec-WebSocket-Key HeaderField. If no Sec-WebSocket-Key HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Sec-WebSocket-Key HeaderField.
  - getSecWebSocketExtensions
```
List<String> getSecWebSocketExtensions()
```
    Gets all the values for the Sec-WebSocket-Extensions HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the Sec-WebSocket-Extensions HeaderFields. An empty List if the header field is not present.
  - setSecWebSocketExtensions
```
void setSecWebSocketExtensions(List<String> values)
```
    Replaces all the values of the Sec-WebSocket-Extensions HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values of the Sec-WebSocket-Extensions HeaderFields.
  - getSecWebSocketAccept
```
String getSecWebSocketAccept()
```
    Gets the value from the first Sec-WebSocket-Accept HeaderField.
    
    Returns:
    
    the value from the first Sec-WebSocket-Accept HeaderField or null if no Sec-WebSocket-Accept HeaderField is present.
  - setSecWebSocketAccept
```
void setSecWebSocketAccept(String value)
```
    Sets the value for the first Sec-WebSocket-Accept HeaderField. If no Sec-WebSocket-Accept HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Sec-WebSocket-Accept HeaderField.
  - getSecWebSocketProtocol
```
List<String> getSecWebSocketProtocol()
```
    Gets all the values for the Sec-WebSocket-Protocol HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the Sec-WebSocket-Protocol HeaderFields. An empty List if the header field is not present.
  - setSecWebSocketProtocol
```
void setSecWebSocketProtocol(List<String> values)
```
    Replaces all the values of the Sec-WebSocket-Protocol HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values of the Sec-WebSocket-Protocol HeaderFields.
  - getSecWebSocketVersion
```
String getSecWebSocketVersion()
```
    Gets the first value from the first Sec-WebSocket-Version HeaderField.
    
    Returns:
    
    the first value from the first Sec-WebSocket-Version HeaderField or null if no Sec-WebSocket-Version HeaderField is present.
  - setSecWebSocketVersion
```
void setSecWebSocketVersion(String value)
```
    Sets the value for the first Sec-WebSocket-Version HeaderField. If no Sec-WebSocket-Version HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Sec-WebSocket-Version HeaderField.
  - getServer
```
String getServer()
```
    Gets the value from the first Server HeaderField.
    
    Returns:
    
    the value from the first Server HeaderField or null if no Server HeaderField is present.
  - setServer
```
void setServer(String value)
```
    Sets the value for the first Server HeaderField. If no Server HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first Server HeaderField.
  - getSetCookie
```
List<String> getSetCookie()
```
    Gets all the values from the Set-Cookie HeaderFields in this Headers object.
    
    Returns:
    
    all the values from the Set-Cookie HeaderFields in this Headers object. An empty List if the header field is not present.
  - setSetCookie
```
void setSetCookie(List<String> values)
```
    Replaces all the values of the Set-Cookie HeaderFields in this Headers object. Individual values in the specified values List will be added as distinct Set-Cookie HeaderFields. An empty list will remove any existing Set-Cookie HeaderFields.
    
    Parameters:
    
    values - the values of the Set-Cookie HeaderFields.
  - getTransferEncoding
```
List<String> getTransferEncoding()
```
    Gets all the values from the Transfer-Encoding HeaderFields in this Headers object.
    
    Returns:
    
    all the values from the Transfer-Encoding HeaderFields in this Headers object. An empty List if the header field is not present.
  - setTransferEncoding
```
void setTransferEncoding(List<String> values)
```
    Replaces all the values of the Transfer-Encoding HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values of the Transfer-Encoding HeaderFields.
  - isChunked
```
boolean isChunked()
```
    Helper method to determine if this Headers object contains header fields that indicate the related HTTP message body uses a chunked Transfer-Encoding.
    
    Returns:
    
    true, if the header fields indicate a chunked message body.
  - getURIs
```
List<String> getURIs()
```
    Returns all URI headers, including any variants defined via the vary parameter. See: http://www.w3.org/Protocols/HTTP/Object_Headers.html#uri Unlike other methods in this interface that return values separated by a comma, the values from the URI HeaderFields are returned verbatim.
    
    Returns:
    
    URI header values, including variants if present. An empty List if the header field is not present.
  - setURIs
```
void setURIs(List<String> values)
```
    Replaces all the values of the URI HeaderFields in this Headers object. Individual values in the specified values List will be added as distinct URI HeaderFields. An empty list will remove any existing URI HeaderFields.
    
    Parameters:
    
    values - the values of the URI HeaderFields.
  - getUpgrade
```
List<String> getUpgrade()
```
    Gets all the values for the Upgrade HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the Upgrade HeaderFields. An empty List if the header field is not present.
  - setUpgrade
```
void setUpgrade(List<String> values)
```
    Replaces all the values for the Upgrade HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values for the Upgrade HeaderFields in this Headers object.
  - getVary
```
List<String> getVary()
```
    Gets all the values for the Vary HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the Vary HeaderFields. An empty List if the header field is not present.
  - setVary
```
void setVary(List<String> values)
```
    Replaces all the values for the Vary HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values for the Vary HeaderFields in this Headers object.
  - getXForwardedFor
```
List<String> getXForwardedFor()
```
    Gets all the values for the X-Forwarded-For HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the X-Forwarded-For HeaderFields. An empty List if the header field is not present.
  - setXForwardedFor
```
void setXForwardedFor(List<String> values)
```
    Replaces all the values for the X-Forwarded-For HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values for the X-Forwarded-For HeaderFields in this Headers object.
  - getXForwardedHost
```
List<String> getXForwardedHost()
```
    Gets all the values for the X-Forwarded-Host HeaderFields in this Headers object where values within in a HeaderField are separated by a comma.
    
    Returns:
    
    all the values for the X-Forwarded-Host HeaderFields. An empty List if the header field is not present.
  - setXForwardedHost
```
void setXForwardedHost(List<String> values)
```
    Replaces all the values for the X-Forwarded-Host HeaderFields in this Headers object. Values will be combined into a single HeaderField value, where individual elements in the specified List will be separated by a comma. An empty values List will remove all HeaderFields.
    
    Parameters:
    
    values - the values for the X-Forwarded-Host HeaderFields in this Headers object.
  - getXForwardedProto
```
String getXForwardedProto()
```
    Gets the first value from the first X-Forwarded-Proto HeaderField.
    
    Returns:
    
    the first value from the first X-Forwarded-Proto HeaderField or null if no X-Forwarded-Proto HeaderField is present.
  - setXForwardedProto
```
void setXForwardedProto(String value)
```
    Sets the value for the first X-Forwarded-Proto HeaderField. If no X-Forwarded-Proto HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first X-Forwarded-Proto HeaderField.
  - getXFrameOptions
```
String getXFrameOptions()
```
    Gets the value from the first X-Frame-Options HeaderField.
    
    Returns:
    
    the value from the first X-Frame-Options HeaderField or null if no X-Frame-Options HeaderField is present.
  - setXFrameOptions
```
void setXFrameOptions(String value)
```
    Sets the value for the first X-Frame-Options HeaderField. If no X-Frame-Options HeaderField exists, a new HeaderField is added.
    
    Parameters:
    
    value - the value for the first X-Frame-Options HeaderField.
  - getLocales
```
List<Locale> getLocales()
```
    Gets the locales in order of preference specified in the Accept-Language header. If Accept-Language is not available, a list containing the ROOT (undefined) locale is returned
    
    Returns:
    
    the locales in order of preference specified in the Accept-Language header or the JVM default locale.

Interface Headers

Method Summary

Method Detail

getHeaderFields

contains

getFirstValue

getLastValue

getValues

setFirstValue

setLastValue

setValues

getRemovedHeaderNames

getModifiedHeaderNames

add

add

removeFields

getAccept

setAccept

getAccessControlAllowCredentials

setAccessControlAllowCredentials

getAccessControlAllowHeaders

setAccessControlAllowHeaders

getAccessControlAllowMethods

setAccessControlAllowMethods

getAccessControlAllowOrigin

setAccessControlAllowOrigin

getAccessControlExposeHeaders

setAccessControlExposeHeaders

getAccessControlMaxAge

setAccessControlMaxAge

getAccessControlRequestHeaders

setAccessControlRequestHeaders

getAccessControlRequestMethod

setAccessControlRequestMethod

getAuthorization

setAuthorization

getCacheControl

setCacheControl

getCharset

getConnection

setConnection

getContentEncoding

setContentEncoding

getContentDisposition

setContentDisposition

getContentLength

setContentLength

getContentLocation

setContentLocation

getContentType

setContentType

setContentType

getCookies

setCookies

getFirstCookieValue

getDate

setDate

getHost

setHost

getLastModified

setLastModified

getLocation

setLocation

getOrigin

setOrigin

getProxyAuthorization

setProxyAuthorization

getProxyConnection

setProxyConnection

getSecWebSocketKey

setSecWebSocketKey

getSecWebSocketExtensions

setSecWebSocketExtensions

getSecWebSocketAccept

setSecWebSocketAccept

getSecWebSocketProtocol

setSecWebSocketProtocol

getSecWebSocketVersion

setSecWebSocketVersion

getServer