com.contentful.java.cda.CDAHttpException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-sdk Show documentation
Java SDK for Contentful's Content Delivery API.
There is a newer version: 9.1.0
package com.contentful.java.cda;

import okhttp3.Headers;
import okhttp3.Request;
import okhttp3.Response;
import okio.BufferedSource;
import okio.Timeout;

import java.io.IOException;
import java.util.Locale;
import java.util.concurrent.TimeUnit;

/**
 * This class will represent known Contentful exceptions
 */
public class CDAHttpException extends RuntimeException {
  private static final long serialVersionUID = 637581021148308658L;
  private final Request request;
  private final Response response;
  private final String responseBody;
  private final String stringRepresentation;

  private final boolean logSensitiveData;

  /**
   * Construct an error response.
   * 
   * This constructor will fill the exception with easy accessible values, like
   * {@link #responseCode()}. {@link #responseMessage()}, but also
   * {@link #rateLimitReset()}.
   *
   * @param request  the request issuing the error.
   * @param response the response from the server to this faulty request.
   */
  public CDAHttpException(Request request, Response response, boolean logSensitiveData) {
    super(response.message());
    this.request = request;
    this.response = response;
    this.responseBody = readResponseBody(response);
    this.stringRepresentation = createString();
    this.logSensitiveData = logSensitiveData;
  }

  private String readResponseBody(Response response) {
    try {
      BufferedSource bufferedSource = response.body().source();
      Timeout timeout = bufferedSource.timeout();
      timeout.deadline(1, TimeUnit.SECONDS);
      return response.body().string();
    } catch (IOException ioException) {
      return "";
    }
  }

  private String createString() {
    return String.format(
            Locale.getDefault(),
            "FAILED REQUEST:\n\t%s\n\t╰→ Header{%s}\n\t%s\n\t├→ Body{%s}\n\t╰→ Header{%s}",
            toStringRequest(request),                  // Safe request string
            headersToString(request.headers()),        // Already respects logSensitiveData
            toStringResponse(response),                // Safe response string
            responseBody,
            headersToString(response.headers())        // Already respects logSensitiveData
    );
  }

  private String toStringRequest(Request request) {
    if (logSensitiveData) {
      return request.toString();
    } else {
      return request.method() + " " + request.url();
    }
  }

  private String toStringResponse(Response response) {
    if (logSensitiveData) {
      return response.toString();
    } else {
      return "HTTP " + response.code() + " " + response.message();
    }
  }

  /**
   * Convert exception to human readable form.
   *
   * @return a string representing this exception.
   */
  @Override
  public String toString() {
    return stringRepresentation;
  }

  /**
   * @return the response code of the request.
   */
  public int responseCode() {
    return response.code();
  }

  /**
   * @return the message the server returned.
   */
  public String responseMessage() {
    return response.message();
  }

  /**
   * @return the errors body, potentially containing more information.
   */
  public String responseBody() {
    return responseBody;
  }

  /**
   * @return the hourly rate limit or -1 if header not send
   */
  public int rateLimitHourLimit() {
    return parseRateLimitHeader("X-Contentful-RateLimit-Hour-Limit");
  }

//BEGIN TO LONG CODE LINES
  /**
   * @return the number of remaining requests that can be made for the current hour or -1 if header not send
   */
//END TO LONG CODE LINES
  public int rateLimitHourRemaining() {
    return parseRateLimitHeader("X-Contentful-RateLimit-Hour-Remaining");
  }

  /**
   * @return the per second rate limit or -1 if header not send
   */
  public int rateLimitSecondLimit() {
    return parseRateLimitHeader("X-Contentful-RateLimit-Second-Limit");
  }

  /**
   * @return the number of remaining requests that can be made per second or -1 if header not send
   */
  public int rateLimitSecondRemaining() {
    return parseRateLimitHeader("X-Contentful-RateLimit-Second-Remaining");
  }

//BEGIN TO LONG CODE LINES
  /**
   * @return the number of seconds until the user can make their next request or -1 if header not send
   */
//END TO LONG CODE LINES
  public int rateLimitReset() {
    return parseRateLimitHeader("X-Contentful-RateLimit-Reset");
  }

  private String headersToString(Headers headers) {
    if (!logSensitiveData) {
      return "";
    }

    final StringBuilder builder = new StringBuilder();

    String divider = "";
    for (final String name : headers.names()) {
      final String value = headers.get(name);
      builder.append(divider);
      builder.append(name);
      builder.append(": ");
      builder.append(value);

      if ("".equals(divider)) {
        divider = ", ";
      }
    }

    return builder.toString();
  }

  private int parseRateLimitHeader(String name) {
    try {
      return Integer.parseInt(response.header(name));
    } catch (NumberFormatException e) {
      return -1;
    }
  }
}