com.box.sdk

Class BoxJSONResponse

Object

BoxAPIResponse

BoxJSONResponse

All Implemented Interfaces:

Closeable, AutoCloseable

public class BoxJSONResponse
extends BoxAPIResponse

Used to read HTTP responses containing JSON from the Box API.

This request type extends BoxAPIResponse to provide additional functionality for handling JSON strings. It reads the response body into a string and allows the JSON in the response to be logged.

Constructor Summary

Constructors

Constructor and Description
BoxJSONResponse() Constructs a BoxJSONResponse without an associated HttpURLConnection.
BoxJSONResponse(int responseCode, String requestMethod, String requestUrl, Map<String,List<String>> headers, JsonObject body) Constructs a BoxAPIResponse with an http response code and response body.

Method Summary

Modifier and Type	Method and Description
protected String	bodyToString() Returns a string representation of this response's body.
String	getJSON() Gets the body of the response as a JSON string.
JsonObject	getJsonObject() Get response as Json Object.

Methods inherited from class BoxAPIResponse

close, disconnect, getBody, getBody, getContentLength, getHeaderField, getHeaders, getRequestMethod, getRequestUrl, getResponseCode, toString

Methods inherited from class Object

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

Constructor Detail

BoxJSONResponse

public BoxJSONResponse()

Constructs a BoxJSONResponse without an associated HttpURLConnection.

BoxJSONResponse

public BoxJSONResponse(int responseCode,
                       String requestMethod,
                       String requestUrl,
                       Map<String,List<String>> headers,
                       JsonObject body)

Constructs a BoxAPIResponse with an http response code and response body.

Parameters:

responseCode - http response code

headers - map of http headers

body - response body as Json Object

Method Detail

getJsonObject

public JsonObject getJsonObject()

Get response as Json Object.

Returns:

response as JsonObject

getJSON

public String getJSON()

Gets the body of the response as a JSON string. When this method is called, the response's body will be read and the response will be disconnected, meaning that the stream returned by BoxAPIResponse.getBody() can no longer be used.

Returns:

the body of the response as a JSON string.

bodyToString

protected String bodyToString()

Description copied from class: BoxAPIResponse

Returns a string representation of this response's body. This method is used when logging this response's body. By default, it returns an empty string (to avoid accidentally logging binary data) unless the response contained an error message.

Overrides:

bodyToString in class BoxAPIResponse

Returns:

a string representation of this response's body.