com.google.tsunami.common.net.http.HttpResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tsunami-common Show documentation
Tsunami: Common
There is a newer version: 0.0.26
/*
 * Copyright 2020 Google LLC
 *
 * 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.google.tsunami.common.net.http;

import com.google.auto.value.AutoValue;
import com.google.auto.value.extension.memoized.Memoized;
import com.google.errorprone.annotations.Immutable;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;
import com.google.gson.JsonPrimitive;
import com.google.protobuf.ByteString;
import java.util.Optional;
import okhttp3.HttpUrl;

/** Immutable HTTP response. */
@Immutable
@AutoValue
@AutoValue.CopyAnnotations
// HttpUrl is immutable even if not marked as such.
@SuppressWarnings("Immutable")
public abstract class HttpResponse {
  public abstract HttpStatus status();
  public abstract HttpHeaders headers();
  public abstract Optional bodyBytes();
  // The URL that produced this response.
  // TODO(b/173574468): Provide the full redirection request not just the Url.
  public abstract Optional responseUrl();

  /**
   * Gets the body of the HTTP response as a UTF-8 encoded String.
   *
   * @return HTTP response body as a Java {@link String}.
   */
  @Memoized
  public Optional bodyString() {
    return bodyBytes().map(ByteString::toStringUtf8);
  }

  /**
   * Tries to parse the response body as json and returns the parsing result as {@link JsonElement}.
   * If parsing failed, an empty optional is returned.
   *
   * @return HTTP response body as a Gson {@link JsonElement} object.
   */
  @Memoized
  public Optional bodyJson() {
    try {
      return bodyString().map(JsonParser::parseString);
    } catch (RuntimeException e) {
      // Do best-effort parsing and ignore Json parsing errors
      return Optional.empty();
    }
  }

  /**
   * Tries to determine if a given field in Json response is equal to a specific value. If parsing
   * failed, {@link com.google.gson.JsonSyntaxException} or {@link IllegalStateException} will be
   * thrown.
   *
   * @return boolean
   */
  public boolean jsonFieldEqualsToValue(String fieldname, String value) {
    Optional jsonPrimitive =
        bodyJson()
            .map(JsonElement::getAsJsonObject)
            .map(object -> object.getAsJsonPrimitive(fieldname));
    return jsonPrimitive.isPresent() && jsonPrimitive.get().getAsString().equals(value);
  }

  public static Builder builder() {
    return new AutoValue_HttpResponse.Builder();
  }

  /** Builder for {@link HttpResponse}. */
  @AutoValue.Builder
  public abstract static class Builder {
    public abstract Builder setStatus(HttpStatus httpStatus);
    public abstract Builder setHeaders(HttpHeaders httpHeaders);
    public abstract Builder setBodyBytes(ByteString bodyBytes);
    public abstract Builder setBodyBytes(Optional bodyBytes);
    public abstract Builder setResponseUrl(HttpUrl url);
    public abstract Builder setResponseUrl(Optional url);

    public abstract HttpResponse build();
  }
}