org.openqa.selenium.remote.http.HttpMessage Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of selenium-remote-driver Show documentation
Show all versions of selenium-remote-driver Show documentation
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The SFC 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.
package org.openqa.selenium.remote.http;
import static com.google.common.net.HttpHeaders.CONTENT_TYPE;
import static java.nio.charset.StandardCharsets.UTF_8;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.Multimap;
import com.google.common.io.ByteStreams;
import com.google.common.net.MediaType;
import org.openqa.selenium.WebDriverException;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.nio.charset.Charset;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Objects;
import java.util.stream.Collectors;
class HttpMessage {
private final Multimap headers = ArrayListMultimap.create();
private final Map attributes = new HashMap<>();
private InputStream content = new ByteArrayInputStream(new byte[0]);
private volatile byte[] readContent = null;
/**
* Retrieves a user-defined attribute of this message. Attributes are stored as simple key-value
* pairs and are not included in a message's serialized form.
*
* @param key attribute name
* @return attribute object
*/
public Object getAttribute(String key) {
return attributes.get(key);
}
public void setAttribute(String key, Object value) {
attributes.put(key, value);
}
public void removeAttribute(String key) {
attributes.remove(key);
}
public Iterable getHeaderNames() {
return headers.keySet();
}
public Iterable getHeaders(String name) {
return headers.entries().stream()
.filter(e -> Objects.nonNull(e.getKey()))
.filter(e -> e.getKey().equalsIgnoreCase(name.toLowerCase()))
.map(Map.Entry::getValue)
.collect(Collectors.toList());
}
public String getHeader(String name) {
Iterable initialHeaders = getHeaders(name);
if (initialHeaders == null) {
return null;
}
Iterator headers = initialHeaders.iterator();
if (headers.hasNext()) {
return headers.next();
}
return null;
}
public void setHeader(String name, String value) {
removeHeader(name);
addHeader(name, value);
}
public void addHeader(String name, String value) {
headers.put(name, value);
}
public void removeHeader(String name) {
headers.removeAll(name);
}
public Charset getContentEncoding() {
Charset charset = UTF_8;
try {
String contentType = getHeader(CONTENT_TYPE);
if (contentType != null) {
MediaType mediaType = MediaType.parse(contentType);
charset = mediaType.charset().or(UTF_8);
}
} catch (IllegalArgumentException ignored) {
// Do nothing.
}
return charset;
}
public void setContent(byte[] data) {
this.content = new ByteArrayInputStream(data);
}
public void setContent(InputStream toStreamFrom) {
this.content = toStreamFrom;
}
/**
* @deprecated There is an expectation that this class caches all input, which leads to leaks.
*/
@Deprecated
public byte[] getContent() {
if (readContent == null) {
synchronized (this) {
if (readContent == null) {
try (ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
ByteStreams.copy(consumeContentStream(), bos);
readContent = bos.toByteArray();
} catch (IOException e) {
throw new WebDriverException(e);
}
}
}
}
return readContent;
}
public String getContentString() {
return new String(getContent(), getContentEncoding());
}
public Reader getContentReader() {
return new InputStreamReader(getContentStream(), getContentEncoding());
}
public InputStream getContentStream() {
return new ByteArrayInputStream(getContent());
}
/**
* Get the underlying content stream, bypassing the caching mechanisms that allow it to be read
* again.
*/
public InputStream consumeContentStream() {
return content;
}
}