HttpJsonStatusCode.java

/*
 * Copyright 2017 Google LLC
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google LLC nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.google.api.gax.httpjson;

import com.google.api.core.BetaApi;
import com.google.api.core.InternalExtensionOnly;
import com.google.api.gax.rpc.StatusCode;
import com.google.common.base.Strings;
import java.util.Objects;

/** A failure code specific to an HTTP call. */
@BetaApi
@InternalExtensionOnly
public class HttpJsonStatusCode implements StatusCode {
  static final String FAILED_PRECONDITION = "FAILED_PRECONDITION";
  static final String OUT_OF_RANGE = "OUT_OF_RANGE";
  static final String ALREADY_EXISTS = "ALREADY_EXISTS";
  static final String DATA_LOSS = "DATA_LOSS";
  static final String UNKNOWN = "UNKNOWN";

  private final int httpStatus;
  private final StatusCode.Code statusCode;

  /** Creates a new instance with the given status code. */
  public static HttpJsonStatusCode of(int httpStatus, String errorMessage) {
    return new HttpJsonStatusCode(httpStatus, httpStatusToStatusCode(httpStatus, errorMessage));
  }

  public static HttpJsonStatusCode of(StatusCode.Code statusCode) {
    return new HttpJsonStatusCode(statusCode.getHttpStatusCode(), statusCode);
  }

  public static HttpJsonStatusCode of(com.google.rpc.Code rpcCode) {
    return new HttpJsonStatusCode(rpcCode.getNumber(), rpcCodeToStatusCode(rpcCode));
  }

  static StatusCode.Code rpcCodeToStatusCode(com.google.rpc.Code rpcCode) {
    switch (rpcCode) {
      case OK:
        return Code.OK;
      case CANCELLED:
        return Code.CANCELLED;
      case UNKNOWN:
        return Code.UNKNOWN;
      case INVALID_ARGUMENT:
        return Code.INVALID_ARGUMENT;
      case DEADLINE_EXCEEDED:
        return Code.DEADLINE_EXCEEDED;
      case NOT_FOUND:
        return Code.NOT_FOUND;
      case ALREADY_EXISTS:
        return Code.ALREADY_EXISTS;
      case PERMISSION_DENIED:
        return Code.PERMISSION_DENIED;
      case RESOURCE_EXHAUSTED:
        return Code.RESOURCE_EXHAUSTED;
      case FAILED_PRECONDITION:
        return Code.FAILED_PRECONDITION;
      case ABORTED:
        return Code.ABORTED;
      case OUT_OF_RANGE:
        return Code.OUT_OF_RANGE;
      case UNIMPLEMENTED:
        return Code.UNIMPLEMENTED;
      case INTERNAL:
        return Code.INTERNAL;
      case UNAVAILABLE:
        return Code.UNAVAILABLE;
      case DATA_LOSS:
        return Code.DATA_LOSS;
      case UNAUTHENTICATED:
        return Code.UNAUTHENTICATED;
      default:
        throw new IllegalArgumentException("Unrecognized rpc code: " + rpcCode);
    }
  }

  static StatusCode.Code httpStatusToStatusCode(int httpStatus, String errorMessage) {
    String causeMessage = Strings.nullToEmpty(errorMessage).toUpperCase();
    switch (httpStatus) {
      case 200:
        return Code.OK;
      case 400:
        if (causeMessage.contains(OUT_OF_RANGE)) {
          return Code.OUT_OF_RANGE;
        } else if (causeMessage.contains(FAILED_PRECONDITION)) {
          return Code.FAILED_PRECONDITION;
        } else {
          return Code.INVALID_ARGUMENT;
        }
      case 401:
        return Code.UNAUTHENTICATED;
      case 403:
        return Code.PERMISSION_DENIED;
      case 404:
        return Code.NOT_FOUND;
      case 409:
        if (causeMessage.contains(ALREADY_EXISTS)) {
          return Code.ALREADY_EXISTS;
        } else {
          return Code.ABORTED;
        }
      case 411:
        throw new IllegalStateException(
            "411 status code received (Content-Length header not given.) Please file a bug against https://github.com/googleapis/gax-java/\n"
                + httpStatus);
      case 429:
        return Code.RESOURCE_EXHAUSTED;
      case 499:
        return Code.CANCELLED;
      case 500:
        if (causeMessage.contains(DATA_LOSS)) {
          return Code.DATA_LOSS;
        } else if (causeMessage.contains(UNKNOWN)) {
          return Code.UNKNOWN;
        } else {
          return Code.INTERNAL;
        }
      case 501:
        return Code.UNIMPLEMENTED;
      case 503:
        return Code.UNAVAILABLE;
      case 504:
        return Code.DEADLINE_EXCEEDED;
      default:
        throw new IllegalArgumentException("Unrecognized http status code: " + httpStatus);
    }
  }

  @Override
  public StatusCode.Code getCode() {
    return statusCode;
  }

  /** Returns the status code from the http call. */
  @Override
  public Integer getTransportCode() {
    return httpStatus;
  }

  private HttpJsonStatusCode(int code, StatusCode.Code statusCode) {
    this.httpStatus = code;
    this.statusCode = statusCode;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }

    HttpJsonStatusCode that = (HttpJsonStatusCode) o;

    return Objects.equals(statusCode, that.statusCode);
  }

  @Override
  public int hashCode() {
    return Objects.hash(statusCode);
  }

  @Override
  public String toString() {
    return "HttpJsonStatusCode{" + "statusCode=" + statusCode + "}";
  }
}