com.sun.xml.ws.transport.httpspi.servlet.Headers Maven / Gradle / Ivy
Show all versions of jaxws-rt Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.transport.httpspi.servlet;
import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* HTTP request and response headers are represented by this class which implements
* the interface {@link java.util.Map}<
* {@link String},{@link java.util.List}<{@link String}>>.
* The keys are case-insensitive Strings representing the header names and
* the value associated with each key is a {@link java.util.List}<{@link 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 {@link java.util.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.
* @since 1.6
*/
public class Headers implements Map> values() {
return map.values();
}
@Override
public Set