org.springframework.http.support.JettyHeadersAdapter Maven / Gradle / Ivy
/*
* Copyright 2002-2023 the original author or authors.
*
* 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
*
* https://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 org.springframework.http.support;
import java.util.AbstractSet;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.eclipse.jetty.http.HttpField;
import org.eclipse.jetty.http.HttpFields;
import org.springframework.http.HttpHeaders;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
import org.springframework.util.MultiValueMap;
/**
* {@code MultiValueMap} implementation for wrapping Jetty HTTP headers.
*
* @author Rossen Stoyanchev
* @author Juergen Hoeller
* @author Sam Brannen
* @since 6.1
*/
public final class JettyHeadersAdapter implements MultiValueMap {
private final HttpFields headers;
/**
* Creates a new {@code JettyHeadersAdapter} based on the given
* {@code HttpFields} instance.
* @param headers the {@code HttpFields} to base this adapter on
*/
public JettyHeadersAdapter(HttpFields headers) {
Assert.notNull(headers, "Headers must not be null");
this.headers = headers;
}
@Override
public String getFirst(String key) {
return this.headers.get(key);
}
@Override
public void add(String key, @Nullable String value) {
if (value != null) {
HttpFields.Mutable mutableHttpFields = mutableFields();
mutableHttpFields.add(key, value);
}
}
@Override
public void addAll(String key, List values) {
values.forEach(value -> add(key, value));
}
@Override
public void addAll(MultiValueMap values) {
values.forEach(this::addAll);
}
@Override
public void set(String key, @Nullable String value) {
HttpFields.Mutable mutableHttpFields = mutableFields();
if (value != null) {
mutableHttpFields.put(key, value);
}
else {
mutableHttpFields.remove(key);
}
}
@Override
public void setAll(Map values) {
values.forEach(this::set);
}
@Override
public Map toSingleValueMap() {
Map singleValueMap = CollectionUtils.newLinkedHashMap(this.headers.size());
Iterator iterator = this.headers.iterator();
iterator.forEachRemaining(field -> {
if (!singleValueMap.containsKey(field.getName())) {
singleValueMap.put(field.getName(), field.getValue());
}
});
return singleValueMap;
}
@Override
public int size() {
return this.headers.getFieldNamesCollection().size();
}
@Override
public boolean isEmpty() {
return (this.headers.size() == 0);
}
@Override
public boolean containsKey(Object key) {
return (key instanceof String headerName && this.headers.contains(headerName));
}
@Override
public boolean containsValue(Object value) {
return (value instanceof String searchString &&
this.headers.stream().anyMatch(field -> field.contains(searchString)));
}
@Nullable
@Override
public List get(Object key) {
if (containsKey(key)) {
return this.headers.getValuesList((String) key);
}
return null;
}
@Nullable
@Override
public List put(String key, List value) {
HttpFields.Mutable mutableHttpFields = mutableFields();
List oldValues = get(key);
mutableHttpFields.put(key, value);
return oldValues;
}
@Nullable
@Override
public List remove(Object key) {
HttpFields.Mutable mutableHttpFields = mutableFields();
if (key instanceof String name) {
List oldValues = get(key);
mutableHttpFields.remove(name);
return oldValues;
}
return null;
}
@Override
public void putAll(Map> map) {
map.forEach(this::put);
}
@Override
public void clear() {
HttpFields.Mutable mutableHttpFields = mutableFields();
mutableHttpFields.clear();
}
@Override
public Set keySet() {
return new HeaderNames();
}
@Override
public Collection> values() {
return this.headers.getFieldNamesCollection().stream()
.map(this.headers::getValuesList).toList();
}
@Override
public Set>> entrySet() {
return new AbstractSet<>() {
@Override
public Iterator>> iterator() {
return new EntryIterator();
}
@Override
public int size() {
return headers.size();
}
};
}
private HttpFields.Mutable mutableFields() {
if (this.headers instanceof HttpFields.Mutable mutableHttpFields) {
return mutableHttpFields;
}
else {
throw new IllegalStateException("Immutable headers");
}
}
@Override
public String toString() {
return HttpHeaders.formatHeaders(this);
}
private class EntryIterator implements Iterator>> {
private final Iterator names = headers.getFieldNamesCollection().iterator();
@Override
public boolean hasNext() {
return this.names.hasNext();
}
@Override
public Entry> next() {
return new HeaderEntry(this.names.next());
}
}
private class HeaderEntry implements Entry> {
private final String key;
HeaderEntry(String key) {
this.key = key;
}
@Override
public String getKey() {
return this.key;
}
@Override
public List getValue() {
return headers.getValuesList(this.key);
}
@Override
public List setValue(List value) {
HttpFields.Mutable mutableHttpFields = mutableFields();
List previousValues = headers.getValuesList(this.key);
mutableHttpFields.put(this.key, value);
return previousValues;
}
}
private class HeaderNames extends AbstractSet {
@Override
public Iterator iterator() {
return new HeaderNamesIterator(headers.getFieldNamesCollection().iterator());
}
@Override
public int size() {
return headers.getFieldNamesCollection().size();
}
}
private final class HeaderNamesIterator implements Iterator {
private final Iterator iterator;
@Nullable
private String currentName;
private HeaderNamesIterator(Iterator iterator) {
this.iterator = iterator;
}
@Override
public boolean hasNext() {
return this.iterator.hasNext();
}
@Override
public String next() {
this.currentName = this.iterator.next();
return this.currentName;
}
@Override
public void remove() {
HttpFields.Mutable mutableHttpFields = mutableFields();
if (this.currentName == null) {
throw new IllegalStateException("No current Header in iterator");
}
if (!headers.contains(this.currentName)) {
throw new IllegalStateException("Header not present: " + this.currentName);
}
mutableHttpFields.remove(this.currentName);
}
}
}