org.openqa.selenium.remote.http.HttpMessage Maven / Gradle / Ivy

Go to download
// 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 com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
import com.google.common.net.MediaType;

import org.openqa.selenium.internal.Require;

import java.io.InputStream;
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.function.Supplier;
import java.util.stream.Collectors;

import static com.google.common.net.HttpHeaders.CONTENT_TYPE;
import static java.nio.charset.StandardCharsets.UTF_8;
import static org.openqa.selenium.remote.http.Contents.bytes;
import static org.openqa.selenium.remote.http.Contents.reader;
import static org.openqa.selenium.remote.http.Contents.string;

abstract class HttpMessage>  {

  private final Multimap headers = ArrayListMultimap.create();
  private final Map attributes = new HashMap<>();
  private Supplier content = Contents.empty();

  /**
   * 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 M setAttribute(String key, Object value) {
    attributes.put(key, value);
    return self();
  }

  public M removeAttribute(String key) {
    attributes.remove(key);
    return self();
  }

  public Iterable getAttributeNames() {
    return ImmutableSet.copyOf(attributes.keySet());
  }

  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 M setHeader(String name, String value) {
    return removeHeader(name).addHeader(name, value);
  }

  public M addHeader(String name, String value) {
    headers.put(name, value);
    return self();
  }

  public M removeHeader(String name) {
    String toRemove = headers.keySet().stream()
      .filter(header -> header.equalsIgnoreCase(name))
      .findFirst().orElse(name);
    headers.removeAll(toRemove);
    return self();
  }

  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;
  }

  /**
   * @deprecated Pass {@link Contents#bytes(byte[])} to {@link #setContent(Supplier)}.
   */
  @Deprecated
  public void setContent(byte[] data) {
    setContent(bytes(data));
  }

  /**
   * @deprecated Pass {@code () -> toStreamFrom} to {@link #setContent(Supplier)}.
   */
  @Deprecated
  public void setContent(InputStream toStreamFrom) {
    setContent(() -> toStreamFrom);
  }

  public M setContent(Supplier supplier) {
    this.content = Require.nonNull("Supplier", supplier);
    return self();
  }

  public Supplier getContent() {
    return content;
  }

  /**
   * @deprecated Use {@link Contents#string(HttpMessage)} instead.
   */
  @Deprecated
  public String getContentString() {
    return string(this);
  }

  /**
   * @deprecated Use {@link Contents#reader(HttpMessage)} instead.
   */
  @Deprecated
  public Reader getContentReader() {
    return reader(this);
  }

  /**
   * @deprecated Use {@link #getContent()} and call {@link Supplier#get()}.
   */
  @Deprecated
  public InputStream getContentStream() {
    return getContent().get();
  }

  /**
   * Get the underlying content stream, bypassing the caching mechanisms that allow it to be read
   * again.
   * @deprecated No direct replacement. Use {@link #getContent()} and call {@link Supplier#get()}.
   */
  @Deprecated
  public InputStream consumeContentStream() {
    return getContent().get();
  }

  @SuppressWarnings("unchecked")
  private M self() {
    return (M) this;
  }
}