| java.lang.Object
 com.sun.xml.ws.transport.Headers
| Headers | | public class Headers implements Map<String, List<String>>(Code) | | HTTP request and response headers are represented by this class which implements
the interface
java.util.Map <
java.lang.String ,
java.util.List <
java.lang.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
java.util.Map methods are provided, but the following
additional convenience methods are most likely to be used:
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 |
| Constructor Summary | |
| public | Headers()
|
| add | | public void add(String key, String value)(Code) | | 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 name
Parameters:
value - the header value to add to the header |
| clear | | public void clear()(Code) | | |
| containsValue | | public boolean containsValue(Object value)(Code) | | |
| getFirst | | public String getFirst(String key)(Code) | | 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 the first string value associated with the key |
| hashCode | | public int hashCode()(Code) | | |
| isEmpty | | public boolean isEmpty()(Code) | | |
| set | | public void set(String key, String value)(Code) | | 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 name
Parameters:
value - the header value to set. |
|
|