1 /* 2 * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package jdk.incubator.http; 27 28 import java.util.List; 29 import java.util.Map; 30 import java.util.Optional; 31 import java.util.OptionalLong; 32 33 /** 34 * A read-only view of a set of HTTP headers. 35 * {@Incubating} 36 * 37 * @since 9 38 */ 39 public interface HttpHeaders { 40 41 /** 42 * Returns an {@link java.util.Optional} containing the first value of the 43 * given named (and possibly multi-valued) header. If the header is not 44 * present, then the returned {@code Optional} is empty. 45 * 46 * @param name the header name 47 * @return an {@code Optional<String>} for the first named value 48 */ 49 public Optional<String> firstValue(String name); 50 51 /** 52 * Returns an {@link java.util.OptionalLong} containing the first value of the 53 * named header field. If the header is not 54 * present, then the Optional is empty. If the header is present but 55 * contains a value that does not parse as a {@code Long} value, then an 56 * exception is thrown. 57 * 58 * @param name the header name 59 * @return an {@code OptionalLong} 60 * @throws NumberFormatException if a value is found, but does not parse as 61 * a Long 62 */ 63 public OptionalLong firstValueAsLong(String name); 64 65 /** 66 * Returns an unmodifiable List of all of the values of the given named 67 * header. Always returns a List, which may be empty if the header is not 68 * present. 69 * 70 * @param name the header name 71 * @return a List of String values 72 */ 73 public List<String> allValues(String name); 74 75 /** 76 * Returns an unmodifiable multi Map view of this HttpHeaders. This 77 * interface should only be used when it is required to iterate over the 78 * entire set of headers. 79 * 80 * @return the Map 81 */ 82 public Map<String,List<String>> map(); 83 } | 1 /* 2 * Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package jdk.incubator.http; 27 28 import java.util.List; 29 import java.util.Map; 30 import java.util.Optional; 31 import java.util.OptionalLong; 32 import static java.util.Collections.emptyList; 33 import static java.util.Collections.unmodifiableList; 34 import static java.util.Objects.requireNonNull; 35 36 /** 37 * A read-only view of a set of HTTP headers. 38 * {@Incubating} 39 * 40 * <p> The methods of this class ( that accept a String header name ), and the 41 * Map returned by the {@linkplain #map() map} method, operate without regard to 42 * case when retrieving the header value. 43 * 44 * <p> HttpHeaders instances are immutable. 45 * 46 * @since 9 47 */ 48 public abstract class HttpHeaders { 49 50 /** 51 * Creates an HttpHeaders. 52 */ 53 protected HttpHeaders() {} 54 55 /** 56 * Returns an {@link Optional} containing the first value of the given named 57 * (and possibly multi-valued) header. If the header is not present, then 58 * the returned {@code Optional} is empty. 59 * 60 * @implSpec 61 * The default implementation invokes 62 * {@code allValues(name).stream().findFirst()} 63 * 64 * @param name the header name 65 * @return an {@code Optional<String>} for the first named value 66 */ 67 public Optional<String> firstValue(String name) { 68 return allValues(name).stream().findFirst(); 69 } 70 71 /** 72 * Returns an {@link OptionalLong} containing the first value of the 73 * named header field. If the header is not present, then the Optional is 74 * empty. If the header is present but contains a value that does not parse 75 * as a {@code Long} value, then an exception is thrown. 76 * 77 * @implSpec 78 * The default implementation invokes 79 * {@code allValues(name).stream().mapToLong(Long::valueOf).findFirst()} 80 * 81 * @param name the header name 82 * @return an {@code OptionalLong} 83 * @throws NumberFormatException if a value is found, but does not parse as 84 * a Long 85 */ 86 public OptionalLong firstValueAsLong(String name) { 87 return allValues(name).stream().mapToLong(Long::valueOf).findFirst(); 88 } 89 90 /** 91 * Returns an unmodifiable List of all of the values of the given named 92 * header. Always returns a List, which may be empty if the header is not 93 * present. 94 * 95 * @implSpec 96 * The default implementation invokes, among other things, the 97 * {@code map().get(name)} to retrieve the list of header values. 98 * 99 * @param name the header name 100 * @return a List of String values 101 */ 102 public List<String> allValues(String name) { 103 requireNonNull(name); 104 List<String> values = map().get(name); 105 // Making unmodifiable list out of empty in order to make a list which 106 // throws UOE unconditionally 107 return values != null ? values : unmodifiableList(emptyList()); 108 } 109 110 /** 111 * Returns an unmodifiable multi Map view of this HttpHeaders. 112 * 113 * @return the Map 114 */ 115 public abstract Map<String, List<String>> map(); 116 117 /** 118 * Tests this HTTP headers instance for equality with the given object. 119 * 120 * <p> If the given object is not an {@code HttpHeaders} then this 121 * method returns {@code false}. Two HTTP headers are equal if each 122 * of their corresponding {@linkplain #map() maps} are equal. 123 * 124 * <p> This method satisfies the general contract of the {@link 125 * Object#equals(Object) Object.equals} method. 126 * 127 * @param obj the object to which this object is to be compared 128 * @return {@code true} if, and only if, the given object is an {@code 129 * HttpHeaders} that is equal to this HTTP headers 130 */ 131 public final boolean equals(Object obj) { 132 if (!(obj instanceof HttpHeaders)) 133 return false; 134 HttpHeaders that = (HttpHeaders)obj; 135 return this.map().equals(that.map()); 136 } 137 138 /** 139 * Computes a hash code for this HTTP headers instance. 140 * 141 * <p> The hash code is based upon the components of the HTTP headers 142 * {@linkplain #map() map}, and satisfies the general contract of the 143 * {@link Object#hashCode Object.hashCode} method. 144 * 145 * @return the hash-code value for this HTTP headers 146 */ 147 public final int hashCode() { 148 return map().hashCode(); 149 } 150 151 /** 152 * Returns this HTTP headers as a string. 153 * 154 * @return a string describing the HTTP headers 155 */ 156 @Override 157 public String toString() { 158 StringBuilder sb = new StringBuilder(); 159 sb.append(super.toString()).append(" "); 160 sb.append(map()); 161 sb.append(" }"); 162 return sb.toString(); 163 } 164 } |