com.seq.exception.APIException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sequence-sdk Show documentation
Sequence Java SDK
There is a newer version: 2.2
package com.seq.exception;

import com.google.gson.annotations.SerializedName;

/**
 * APIException is thrown when the ledger API encounters an error handling a
 * user request. Errors could be due to user error, or due to server issues.
 * 

 * Each error contains a brief description in addition to an error code. The
 * error code can be used by technical support to diagnose the exact cause of
 * the error.
 */
public class APIException extends ChainException {
  /**
   * An error code of the format "CHXXX".
   */
  public String code;

  /**
   * Message describing the general nature of the error.
   */
  @SerializedName("message")
  public String chainMessage;

  /**
   * Additional information about the error (possibly null).
   */
  public String detail;

  /**
   * Specifies whether the error is considered to be transient and that the
   * request should be retried.
   */
  public boolean retriable;

  /**
   * Deprecated. Alias for retriable. Will be removed in 2.0.0.
   */
  public boolean temporary;

  /**
   * Unique identifier of the request to the server.
   */
  public String requestId;

  /**
   * HTTP status code returned by the server.
   */
  public int statusCode;

  public APIException(String message, String requestId) {
    super(message);
    this.requestId = requestId;
  }

  public APIException(String code, String message, String detail, boolean retriable) {
    super(message);
    this.chainMessage = message;
    this.code = code;
    this.detail = detail;
    this.retriable = retriable;
    this.temporary = temporary;
  }

  public APIException(String code, String message, String detail, String requestId) {
    super(message);
    this.chainMessage = message;
    this.code = code;
    this.detail = detail;
    this.requestId = requestId;
  }

  public APIException(
      String code,
      String message,
      String detail,
      boolean retriable,
      String requestId,
      int statusCode) {
    super(message);
    this.chainMessage = message;
    this.code = code;
    this.detail = detail;
    this.retriable = retriable;
    this.temporary = temporary;
    this.requestId = requestId;
    this.statusCode = statusCode;
  }

  @Override
  public String getMessage() {
    String s = "";

    if (this.code != null && this.code.length() > 0) {
      s += "Code: " + this.code + " ";
    }

    s += "Message: " + this.chainMessage;

    if (this.detail != null && this.detail.length() > 0) {
      s += " Detail: " + this.detail;
    }

    if (this.requestId != null) {
      s += " Request-ID: " + this.requestId;
    }

    return s;
  }
}