com.netflix.zuul.message.Headers Maven / Gradle / Ivy
/*
* Copyright 2018 Netflix, Inc.
*
* Licensed 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.
*/
package com.netflix.zuul.message;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.Iterables;
import com.google.common.collect.ListMultimap;
import com.netflix.zuul.message.http.HttpHeaderNames;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.runners.MockitoJUnitRunner;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import static com.netflix.zuul.util.HttpUtils.stripMaliciousHeaderChars;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
/**
* An abstraction over a collection of http headers. Allows multiple headers with same name, and header names are
* compared case insensitively.
*
* There are methods for getting and setting headers by String AND by HeaderName. When possible, use the HeaderName
* variants and cache the HeaderName instances somewhere, to avoid case-insensitive String comparisons.
*
* User: [email protected]
* Date: 2/20/15
* Time: 3:13 PM
*/
public class Headers implements Cloneable
{
private final ListMultimap delegate;
private final boolean immutable;
public Headers()
{
delegate = ArrayListMultimap.create();
immutable = false;
}
private Headers(ListMultimap delegate)
{
this.delegate = delegate;
immutable = ImmutableListMultimap.class.isAssignableFrom(delegate.getClass());
}
protected HeaderName getHeaderName(String name)
{
return HttpHeaderNames.get(name);
}
private boolean delegatePut(HeaderName hn, String value) {
return delegate.put(hn, stripMaliciousHeaderChars(value));
}
private void delegatePutAll(Headers headers) {
// enforce using above delegatePut method, for stripping malicious characters
headers.delegate.entries().forEach(entry -> delegatePut(entry.getKey(), entry.getValue()));
}
/**
* Get the first value found for this key even if there are multiple. If none, then
* return null.
*
* @param name
* @return
*/
public String getFirst(String name)
{
HeaderName hn = getHeaderName(name);
return getFirst(hn);
}
public String getFirst(HeaderName hn)
{
List values = delegate.get(hn);
if (values != null) {
if (values.size() > 0) {
return values.get(0);
}
}
return null;
}
/**
* Get the first value found for this key even if there are multiple. If none, then
* return the specified defaultValue.
*
* @param name
* @return
*/
public String getFirst(String name, String defaultValue)
{
String value = getFirst(name);
if (value == null) {
value = defaultValue;
}
return value;
}
public String getFirst(HeaderName hn, String defaultValue)
{
String value = getFirst(hn);
if (value == null) {
value = defaultValue;
}
return value;
}
public List get(String name)
{
HeaderName hn = getHeaderName(name);
return get(hn);
}
public List get(HeaderName hn)
{
return delegate.get(hn);
}
/**
* Replace any/all entries with this key, with this single entry.
*
* If value is null, then not added, but any existing header of same name is removed.
*
* @param name
* @param value
*/
public void set(String name, String value)
{
HeaderName hn = getHeaderName(name);
set(hn, value);
}
public void set(HeaderName hn, String value)
{
delegate.removeAll(hn);
if (value != null) {
delegatePut(hn, value);
}
}
public boolean setIfAbsent(String name, String value)
{
HeaderName hn = getHeaderName(name);
return setIfAbsent(hn, value);
}
public boolean setIfAbsent(HeaderName hn, String value)
{
boolean did = false;
if (! contains(hn)) {
set(hn, value);
did = true;
}
return did;
}
public void add(String name, String value)
{
HeaderName hn = getHeaderName(name);
add(hn, value);
}
public void add(HeaderName hn, String value)
{
delegatePut(hn, value);
}
public void putAll(Headers headers)
{
delegatePutAll(headers);
}
public List remove(String name)
{
HeaderName hn = getHeaderName(name);
return remove(hn);
}
public List remove(HeaderName hn)
{
return delegate.removeAll(hn);
}
public boolean removeIf(Predicate> filter) {
return delegate.entries().removeIf(filter);
}
public Collection entries()
{
return delegate.entries()
.stream()
.map(entry -> new Header(entry.getKey(), entry.getValue()))
.collect(Collectors.toList());
}
public Set keySet()
{
return delegate.keySet();
}
public boolean contains(String name)
{
return contains(getHeaderName(name));
}
public boolean contains(HeaderName hn)
{
return delegate.containsKey(hn);
}
public boolean contains(String name, String value)
{
HeaderName hn = getHeaderName(name);
return contains(hn, value);
}
public boolean contains(HeaderName hn, String value)
{
return delegate.containsEntry(hn, value);
}
public int size()
{
return delegate.size();
}
@Override
public Headers clone()
{
Headers copy = new Headers();
copy.delegatePutAll(this);
return copy;
}
public Headers immutableCopy()
{
return new Headers(ImmutableListMultimap.copyOf(delegate));
}
public boolean isImmutable()
{
return immutable;
}
@Override
public int hashCode()
{
return super.hashCode();
}
@Override
public boolean equals(Object obj)
{
if (obj == null)
return false;
if (! (obj instanceof Headers))
return false;
Headers h2 = (Headers) obj;
return Iterables.elementsEqual(delegate.entries(), h2.delegate.entries());
}
@Override
public String toString()
{
return delegate.toString();
}
@RunWith(MockitoJUnitRunner.class)
public static class UnitTest
{
@Test
public void testCaseInsensitiveKeys_Set()
{
Headers headers = new Headers();
headers.set("Content-Length", "5");
headers.set("content-length", "10");
assertEquals("10", headers.getFirst("Content-Length"));
assertEquals("10", headers.getFirst("content-length"));
assertEquals(1, headers.get("content-length").size());
}
@Test
public void testCaseInsensitiveKeys_Add()
{
Headers headers = new Headers();
headers.add("Content-Length", "5");
headers.add("content-length", "10");
List values = headers.get("content-length");
assertTrue(values.contains("10"));
assertTrue(values.contains("5"));
assertEquals(2, values.size());
}
@Test
public void testCaseInsensitiveKeys_SetIfAbsent()
{
Headers headers = new Headers();
headers.set("Content-Length", "5");
headers.setIfAbsent("content-length", "10");
List values = headers.get("content-length");
assertEquals(1, values.size());
assertEquals("5", values.get(0));
}
@Test
public void testCaseInsensitiveKeys_PutAll()
{
Headers headers = new Headers();
headers.add("Content-Length", "5");
headers.add("content-length", "10");
Headers headers2 = new Headers();
headers2.putAll(headers);
List values = headers2.get("content-length");
assertTrue(values.contains("10"));
assertTrue(values.contains("5"));
assertEquals(2, values.size());
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy