com.box.sdk.BoxAPIResponseException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of box-java-sdk Show documentation
The Box SDK for Java.
There is a newer version: 4.11.1
package com.box.sdk;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

import com.eclipsesource.json.JsonObject;

/**
 * Thrown to indicate than an error occured while returning with a response from the Box API.
 */
public class BoxAPIResponseException extends BoxAPIException {

    private String message;
    private BoxAPIResponse responseObj;

    /**
     * Constructs a BoxAPIException that contains detailed message for underlying exception.
     *
     * @param message     a message explaining why the error occurred.
     * @param responseObj a response object from the server.
     */
    public BoxAPIResponseException(String message, BoxAPIResponse responseObj) {
        super(message, responseObj.getResponseCode(), responseObj.bodyToString());
        String requestId = "";
        String apiMessage = "";
        JsonObject responseJSON = null;
        this.responseObj = responseObj;

        Map> responseHeaders = new TreeMap>(String.CASE_INSENSITIVE_ORDER);
        for (String headerKey : responseObj.getHeaders().keySet()) {
            List headerValues = new ArrayList();
            headerValues.add(responseObj.getHeaderField(headerKey));
            responseHeaders.put(headerKey, headerValues);
        }

        this.setHeaders(responseHeaders);

        if (this.getHeaders().containsKey("BOX-REQUEST-ID")) {
            requestId += "." + this.getHeaders().get("BOX-REQUEST-ID").get(0).toString();
        }

        try {
            responseJSON = JsonObject.readFrom(responseObj.bodyToString());
        } catch (Exception ex) {
            // Continue because we will construct the exception message below and return it to user.
        }

        if (responseJSON != null) {
            if (responseJSON.get("request_id") != null) {
                requestId = responseJSON.get("request_id").asString() + requestId;
            }

            if (responseJSON.get("code") != null) {
                apiMessage += " " + responseJSON.get("code").asString();
            } else  if (responseJSON.get("error") != null) {
                apiMessage += " " + responseJSON.get("error").asString();
            }

            if (responseJSON.get("message") != null) {
                apiMessage += " - " + responseJSON.get("message").asString();
            } else if (responseJSON.get("error_description") != null) {
                apiMessage += " - " + responseJSON.get("error_description").asString();
            }
        }

        if (!requestId.isEmpty()) {
            this.setMessage(message + " [" + responseObj.getResponseCode() + " | " + requestId + "]"
                    + apiMessage);
        } else {
            this.setMessage(message + " [" + responseObj.getResponseCode() + "]" + apiMessage);
        }
    }

    /**
     * The message to return for the API exception.
     * @param message the constructed for the API exception.
     */
    protected void setMessage(String message) {
        this.message = message;
    }

    /**
     *
     * @return The constructed message for the API exception.
     */
    public String getMessage() {
        return this.message;
    }
}