com.sun.xml.ws.transport.Headers Maven / Gradle / Ivy
Show all versions of webservices-rt Show documentation
/*
* Copyright (c) 1997, 2022 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.ws.transport;
import java.io.Serializable;
import java.util.Comparator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
/**
* HTTP request and response headers are represented by this class which implements
* the interface {@link java.util.Map}<{@link String},
* {@link List}<{@link String}>>.
* The keys are case-insensitive Strings representing the header names and
* the value associated with each key is a {@link List}<{@link String}> with one
* element for each occurrence of the header name in the request or response.
*
* For example, if the request has the the following headers:
*
* HeaderName: value1
* HeadernaMe: value2
*
* Then get("hEaDeRnAmE") would give both "value1", and "value2" values in a list
*
* All the normal {@link Map} methods are provided, but the following
* additional convenience methods are most likely to be used:
*
* - {@link #getFirst(String)} returns a single valued header or the first
* value of a multi-valued header.
* - {@link #add(String,String)} adds the given header value to the list
* for the given key
* - {@link #set(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.
*
* @author Jitendra Kotamraju
*/
public class Headers extends TreeMap> {
private static final long serialVersionUID = -8661300222069744942L;
public Headers() {
super(INSTANCE);
}
private static final InsensitiveComparator INSTANCE = new InsensitiveComparator();
// case-insensitive string comparison of HTTP header names.
private static final class InsensitiveComparator implements Comparator, Serializable {
private static final long serialVersionUID = -6135680289896849318L;
@Override
public int compare(String o1, String o2) {
if (o1 == null && o2 == null)
return 0;
if (o1 == null)
return -1;
if (o2 == null)
return 1;
return o1.compareToIgnoreCase(o2);
}
}
/**
* Adds the given value to the list of headers for the given key. If the
* mapping does not already exist, then it is created.
*
* @param key the header name
* @param value the header value to add to the header
*/
public void add (String key, String value) {
List list = this.get(key);
if (list == null) {
list = new LinkedList<>();
put(key,list);
}
list.add (value);
}
/**
* Returns the first value from the List of String values for the given key
* (if at least one exists).
*
* @param key the key to search for
* @return the first string value associated with the key
*/
public String getFirst (String key) {
List l = get(key);
return (l == null) ? null : l.get(0);
}
/**
* Sets the given value as the sole header value for the given key. If the
* mapping does not already exist, then it is created.
*
* @param key the header name
* @param value the header value to set.
*/
public void set (String key, String value) {
LinkedList l = new LinkedList<>();
l.add (value);
put(key, l);
}
/**
* Added to fix issue
* putAll() is easier to deal with as it doesn't return anything
*/
@Override
public void putAll(Map> map) {
for (Map.Entry> entry : map.entrySet()) {
List list = entry.getValue();
for (String v : list) {
add(entry.getKey(),v);
}
}
}
}