com.box.sdk

Class BoxAPIException

Object

Throwable

Exception

RuntimeException

BoxAPIException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BoxAPIResponseException

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 responseBody, Map<String,List<String>> responseHeaders) Constructs a BoxAPIException with details about the server's response, including response headers.
BoxAPIException(String message, int responseCode, String responseBody, Map<String,List<String>> responseHeaders, Throwable cause) Constructs a BoxAPIException that includes the response headers.
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
Map<String,List<String>>	getHeaders() Gets the response headers, if available.
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.
protected void	setHeaders(Map<String,List<String>> headers) Sets the response headers.
protected void	setResponse(String response) Sets the response returned by ther server.
protected void	setResponseCode(int responseCode) Sets the response code returned by the server.

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,
                       int responseCode,
                       String responseBody,
                       Map<String,List<String>> responseHeaders)

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

Parameters:

message - a message explaining why the exception occurred.

responseCode - the response code returned by the Box server.

responseBody - the response body returned by the Box server.

responseHeaders - the response headers 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.

BoxAPIException

public BoxAPIException(String message,
                       int responseCode,
                       String responseBody,
                       Map<String,List<String>> responseHeaders,
                       Throwable cause)

Constructs a BoxAPIException that includes the response headers.

Parameters:

message - a message explaining why the exception occurred.

responseCode - the response code returned by the Box server.

responseBody - the response body returned by the Box server.

responseHeaders - the response headers 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.

setResponseCode

protected void setResponseCode(int responseCode)

Sets the response code returned by the server.

Parameters:

responseCode - 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.

setResponse

protected void setResponse(String response)

Sets the response returned by ther server.

Parameters:

response - the response returned by the server.

getHeaders

public Map<String,List<String>> getHeaders()

Gets the response headers, if available.

Returns:

the response headers, or empty map if not available.

setHeaders

protected void setHeaders(Map<String,List<String>> headers)

Sets the response headers.

Parameters:

headers - headers to set.