java.lang.Object
com.sun.xml.ws.transport.httpspi.servlet.Headers
HTTP request and response headers are represented by this class which implements
the interface
Map
<
String
,List
<String
>>.
The keys are case-insensitive Strings representing the header names and
the value associated with each key is a List
<String
> with one
element for each occurence of the header name in the request or response.
For example, if a response header instance contains one key "HeaderName" with two values "value1 and value2" then this object is output as two header lines:
HeaderName: value1 HeaderName: value2
All the normal Map
methods are provided, but the following
additional convenience methods are most likely to be used:
getFirst(String)
returns a single valued header or the first value of a multi-valued header.add(String,String)
adds the given header value to the list for the given keyset(String,String)
sets the given header field to the single value given overwriting any existing values in the value list.
All methods in this class accept null
values for keys and values. However, null
keys will never will be present in HTTP request headers, and will not be output/sent in response headers.
Null values can be represented as either a null entry for the key (i.e. the list is null) or
where the key has a list, but one (or more) of the list's values is null. Null values are output
as a header line containing the key but no associated value.
- Since:
- 1.6
-
Nested Class Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
adds the given value to the list of headers for the given key.void
clear()
boolean
containsKey
(Object key) boolean
containsValue
(Object value) entrySet()
boolean
returns the first value from the List of String values for the given key (if at least one exists).int
hashCode()
boolean
isEmpty()
keySet()
void
void
sets the given value as the sole header value for the given key.int
size()
toString()
values()
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Constructor Details
-
Headers
public Headers()
-
-
Method Details
-
size
public int size() -
isEmpty
public boolean isEmpty() -
containsKey
- Specified by:
containsKey
in interfaceMap<String,
List<String>>
-
containsValue
- Specified by:
containsValue
in interfaceMap<String,
List<String>>
-
get
-
getFirst
returns the first value from the List of String values for the given key (if at least one exists).- Parameters:
key
- the key to search for- Returns:
- the first string value associated with the key
-
put
-
add
adds the given value to the list of headers for the given key. If the mapping does not already exist, then it is created- Parameters:
key
- the header namevalue
- the header value to add to the header
-
set
sets the given value as the sole header value for the given key. If the mapping does not already exist, then it is created- Parameters:
key
- the header namevalue
- the header value to set.
-
remove
-
putAll
-
clear
public void clear() -
keySet
-
values
-
entrySet
-
equals
-
hashCode
public int hashCode() -
toString
-