| /* |
| * ==================================================================== |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| * |
| */ |
| |
| package org.apache.hc.core5.http.message; |
| |
| import java.io.Serializable; |
| import java.util.ArrayList; |
| import java.util.Collections; |
| import java.util.Iterator; |
| import java.util.List; |
| import java.util.Locale; |
| import java.util.Objects; |
| |
| import org.apache.hc.core5.http.Header; |
| import org.apache.hc.core5.http.MessageHeaders; |
| import org.apache.hc.core5.http.ProtocolException; |
| import org.apache.hc.core5.util.CharArrayBuffer; |
| |
| /** |
| * A class for combining a set of headers. This class allows for multiple headers with the same name |
| * and keeps track of the order in which headers were added. |
| * |
| * @since 4.0 |
| */ |
| public class HeaderGroup implements MessageHeaders, Serializable { |
| |
| private static final long serialVersionUID = 2608834160639271617L; |
| |
| private static final Header[] EMPTY = new Header[] {}; |
| |
| /** The list of headers for this group, in the order in which they were added */ |
| private final List<Header> headers; |
| |
| /** |
| * Constructor for HeaderGroup. |
| */ |
| public HeaderGroup() { |
| this.headers = new ArrayList<>(16); |
| } |
| |
| /** |
| * Removes all headers. |
| */ |
| public void clear() { |
| headers.clear(); |
| } |
| |
| /** |
| * Adds the given header to the group. The order in which this header was |
| * added is preserved. |
| * |
| * @param header the header to add |
| */ |
| public void addHeader(final Header header) { |
| if (header == null) { |
| return; |
| } |
| headers.add(header); |
| } |
| |
| /** |
| * Removes the first given header. |
| * |
| * @param header the header to remove |
| * @return <code>true</code> if a header was removed as a result of this call. |
| */ |
| public boolean removeHeader(final Header header) { |
| if (header == null) { |
| return false; |
| } |
| for (int i = 0; i < this.headers.size(); i++) { |
| final Header current = this.headers.get(i); |
| if (headerEquals(header, current)) { |
| this.headers.remove(current); |
| return true; |
| } |
| } |
| return false; |
| } |
| |
| private boolean headerEquals(final Header header1, final Header header2) { |
| return header2 == header1 || header2.getName().equalsIgnoreCase(header1.getName()) |
| && Objects.equals(header1.getValue(), header2.getValue()); |
| } |
| |
| /** |
| * Removes all headers that match the given header. |
| * |
| * @param header the header to remove |
| * @return <code>true</code> if any header was removed as a result of this call. |
| * |
| * @since 5.0 |
| */ |
| public boolean removeHeaders(final Header header) { |
| if (header == null) { |
| return false; |
| } |
| boolean removed = false; |
| for (final Iterator<Header> iterator = headerIterator(); iterator.hasNext();) { |
| final Header current = iterator.next(); |
| if (headerEquals(header, current)) { |
| iterator.remove(); |
| removed = true; |
| } |
| } |
| return removed; |
| } |
| |
| /** |
| * Replaces the first occurrence of the header with the same name. If no header with |
| * the same name is found the given header is added to the end of the list. |
| * |
| * @param header the new header that should replace the first header with the same |
| * name if present in the list. |
| * |
| * @since 5.0 |
| */ |
| public void setHeader(final Header header) { |
| if (header == null) { |
| return; |
| } |
| for (int i = 0; i < this.headers.size(); i++) { |
| final Header current = this.headers.get(i); |
| if (current.getName().equalsIgnoreCase(header.getName())) { |
| this.headers.set(i, header); |
| return; |
| } |
| } |
| this.headers.add(header); |
| } |
| |
| /** |
| * Sets all of the headers contained within this group overriding any |
| * existing headers. The headers are added in the order in which they appear |
| * in the array. |
| * |
| * @param headers the headers to set |
| */ |
| public void setHeaders(final Header... headers) { |
| clear(); |
| if (headers == null) { |
| return; |
| } |
| Collections.addAll(this.headers, headers); |
| } |
| |
| /** |
| * Gets a header representing all of the header values with the given name. |
| * If more that one header with the given name exists the values will be |
| * combined with a "," as per RFC 2616. |
| * |
| * <p>Header name comparison is case insensitive. |
| * |
| * @param name the name of the header(s) to get |
| * @return a header with a condensed value or {@code null} if no |
| * headers by the given name are present |
| */ |
| public Header getCondensedHeader(final String name) { |
| final Header[] hdrs = getHeaders(name); |
| |
| if (hdrs.length == 0) { |
| return null; |
| } else if (hdrs.length == 1) { |
| return hdrs[0]; |
| } else { |
| final CharArrayBuffer valueBuffer = new CharArrayBuffer(128); |
| valueBuffer.append(hdrs[0].getValue()); |
| for (int i = 1; i < hdrs.length; i++) { |
| valueBuffer.append(", "); |
| valueBuffer.append(hdrs[i].getValue()); |
| } |
| |
| return new BasicHeader(name.toLowerCase(Locale.ROOT), valueBuffer.toString()); |
| } |
| } |
| |
| /** |
| * Gets all of the headers with the given name. The returned array |
| * maintains the relative order in which the headers were added. |
| * |
| * <p>Header name comparison is case insensitive. |
| * |
| * @param name the name of the header(s) to get |
| * |
| * @return an array of length ≥ 0 |
| */ |
| @Override |
| public Header[] getHeaders(final String name) { |
| List<Header> headersFound = null; |
| for (int i = 0; i < this.headers.size(); i++) { |
| final Header header = this.headers.get(i); |
| if (header.getName().equalsIgnoreCase(name)) { |
| if (headersFound == null) { |
| headersFound = new ArrayList<>(); |
| } |
| headersFound.add(header); |
| } |
| } |
| return headersFound != null ? headersFound.toArray(new Header[headersFound.size()]) : EMPTY; |
| } |
| |
| /** |
| * Gets the first header with the given name. |
| * |
| * <p>Header name comparison is case insensitive. |
| * |
| * @param name the name of the header to get |
| * @return the first header or {@code null} |
| */ |
| @Override |
| public Header getFirstHeader(final String name) { |
| for (int i = 0; i < this.headers.size(); i++) { |
| final Header header = this.headers.get(i); |
| if (header.getName().equalsIgnoreCase(name)) { |
| return header; |
| } |
| } |
| return null; |
| } |
| |
| /** |
| * Gets single first header with the given name. |
| * |
| * <p>Header name comparison is case insensitive. |
| * |
| * @param name the name of the header to get |
| * @return the first header or {@code null} |
| * @throws ProtocolException in case multiple headers with the given name are found. |
| */ |
| @Override |
| public Header getHeader(final String name) throws ProtocolException { |
| int count = 0; |
| Header singleHeader = null; |
| for (int i = 0; i < this.headers.size(); i++) { |
| final Header header = this.headers.get(i); |
| if (header.getName().equalsIgnoreCase(name)) { |
| singleHeader = header; |
| count++; |
| } |
| } |
| if (count > 1) { |
| throw new ProtocolException("Multiple headers '%s'' found", name); |
| } |
| return singleHeader; |
| } |
| |
| /** |
| * Gets the last header with the given name. |
| * |
| * <p>Header name comparison is case insensitive. |
| * |
| * @param name the name of the header to get |
| * @return the last header or {@code null} |
| */ |
| @Override |
| public Header getLastHeader(final String name) { |
| // start at the end of the list and work backwards |
| for (int i = headers.size() - 1; i >= 0; i--) { |
| final Header header = headers.get(i); |
| if (header.getName().equalsIgnoreCase(name)) { |
| return header; |
| } |
| } |
| |
| return null; |
| } |
| |
| /** |
| * Gets all of the headers contained within this group. |
| * |
| * @return an array of length ≥ 0 |
| */ |
| @Override |
| public Header[] getHeaders() { |
| return headers.toArray(new Header[headers.size()]); |
| } |
| |
| /** |
| * Tests if headers with the given name are contained within this group. |
| * |
| * <p>Header name comparison is case insensitive. |
| * |
| * @param name the header name to test for |
| * @return {@code true} if at least one header with the name is |
| * contained, {@code false} otherwise |
| */ |
| @Override |
| public boolean containsHeader(final String name) { |
| for (int i = 0; i < this.headers.size(); i++) { |
| final Header header = this.headers.get(i); |
| if (header.getName().equalsIgnoreCase(name)) { |
| return true; |
| } |
| } |
| |
| return false; |
| } |
| |
| /** |
| * Checks if a certain header is present in this message and how many times. |
| * <p>Header name comparison is case insensitive. |
| * |
| * @param name the header name to check for. |
| * @return number of occurrences of the header in the message. |
| */ |
| @Override |
| public int countHeaders(final String name) { |
| int count = 0; |
| for (int i = 0; i < this.headers.size(); i++) { |
| final Header header = this.headers.get(i); |
| if (header.getName().equalsIgnoreCase(name)) { |
| count++; |
| } |
| } |
| return count; |
| } |
| |
| /** |
| * Returns an iterator over this group of headers. |
| * |
| * @return iterator over this group of headers. |
| * |
| * @since 5.0 |
| */ |
| @Override |
| public Iterator<Header> headerIterator() { |
| return new BasicListHeaderIterator(this.headers, null); |
| } |
| |
| /** |
| * Returns an iterator over the headers with a given name in this group. |
| * |
| * @param name the name of the headers over which to iterate, or |
| * {@code null} for all headers |
| * |
| * @return iterator over some headers in this group. |
| * |
| * @since 5.0 |
| */ |
| @Override |
| public Iterator<Header> headerIterator(final String name) { |
| return new BasicListHeaderIterator(this.headers, name); |
| } |
| |
| /** |
| * Removes all headers with a given name in this group. |
| * |
| * @param name the name of the headers to be removed. |
| * @return <code>true</code> if any header was removed as a result of this call. |
| * |
| * @since 5.0 |
| */ |
| public boolean removeHeaders(final String name) { |
| if (name == null) { |
| return false; |
| } |
| boolean removed = false; |
| for (final Iterator<Header> iterator = headerIterator(); iterator.hasNext(); ) { |
| final Header header = iterator.next(); |
| if (header.getName().equalsIgnoreCase(name)) { |
| iterator.remove(); |
| removed = true; |
| } |
| } |
| return removed; |
| } |
| |
| @Override |
| public String toString() { |
| return this.headers.toString(); |
| } |
| |
| } |