com.box.sdk

Class BoxAPIException

Object

Throwable

Exception

RuntimeException

BoxAPIException

All Implemented Interfaces:

Serializable

public class BoxAPIException
extends RuntimeException

Thrown to indicate that an error occurred while communicating with the Box API.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BoxAPIException(String message) Constructs a BoxAPIException with a specified message.
BoxAPIException(String message, int responseCode, String response) Constructs a BoxAPIException with details about the server's response.
BoxAPIException(String message, int responseCode, String response, Throwable cause) Constructs a BoxAPIException that wraps another underlying exception with details about the server's response.
BoxAPIException(String message, Throwable cause) Constructs a BoxAPIException that wraps another underlying exception.

Method Summary

Modifier and Type	Method and Description
String	getResponse() Gets the body of the response returned by the server when this exception was thrown.
int	getResponseCode() Gets the response code returned by the server when this exception was thrown.

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BoxAPIException

public BoxAPIException(String message)

Constructs a BoxAPIException with a specified message.

Parameters:

message - a message explaining why the exception occurred.

BoxAPIException

public BoxAPIException(String message,
                       int responseCode,
                       String response)

Constructs a BoxAPIException with details about the server's response.

Parameters:

message - a message explaining why the exception occurred.

responseCode - the response code returned by the Box server.

response - the response body returned by the Box server.

BoxAPIException

public BoxAPIException(String message,
                       Throwable cause)

Constructs a BoxAPIException that wraps another underlying exception.

Parameters:

message - a message explaining why the exception occurred.

cause - an underlying exception.

BoxAPIException

public BoxAPIException(String message,
                       int responseCode,
                       String response,
                       Throwable cause)

Constructs a BoxAPIException that wraps another underlying exception with details about the server's response.

Parameters:

message - a message explaining why the exception occurred.

responseCode - the response code returned by the Box server.

response - the response body returned by the Box server.

cause - an underlying exception.

Method Detail

getResponseCode

public int getResponseCode()

Gets the response code returned by the server when this exception was thrown.

Returns:

the response code returned by the server.

getResponse

public String getResponse()

Gets the body of the response returned by the server when this exception was thrown.

Returns:

the body of the response returned by the server.