com.box.sdk

Class BoxJSONRequest

Object

BoxAPIRequest

BoxJSONRequest

Direct Known Subclasses:

BatchAPIRequest

public class BoxJSONRequest
extends BoxAPIRequest

Used to make HTTP requests containing JSON to the Box API.

This request type extends BoxAPIRequest to provide additional functionality for handling JSON strings. It automatically sets the appropriate "Content-Type" HTTP headers and allows the JSON in the request to be logged.

Nested Class Summary

Nested classes/interfaces inherited from class BoxAPIRequest

BoxAPIRequest.RequestHeader

Constructor Summary

Constructors

Constructor and Description
BoxJSONRequest(BoxAPIConnection api, URL url, HttpMethod method) Constructs an authenticated BoxJSONRequest using a provided BoxAPIConnection.
BoxJSONRequest(BoxAPIConnection api, URL url, String method) Constructs an authenticated BoxJSONRequest using a provided BoxAPIConnection.
BoxJSONRequest(URL url, HttpMethod method) Constructs an authenticated BoxJSONRequest.

Method Summary

Modifier and Type	Method and Description
protected String	bodyToString() Returns a String representation of this request's body used in BoxAPIRequest.toString().
JsonObject	getBodyAsJsonObject() Gets the body of this request as a JsonObject.
JsonValue	getBodyAsJsonValue() Gets the body of this request as a JsonValue.
void	setBody(JsonObject body) Sets the body of this request to a given JsonObject.
void	setBody(String body) Sets the body of this request to a given JSON string.

Methods inherited from class BoxAPIRequest

addHeader, getBody, getConnectTimeout, getHeaders, getMethod, getReadTimeout, getUrl, isResponseRetryable, resetBody, send, send, sendWithoutRetry, setBody, setBody, setConnectTimeout, setFollowRedirects, setReadTimeout, toString, writeBody

Methods inherited from class Object

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

Constructor Detail

BoxJSONRequest

public BoxJSONRequest(BoxAPIConnection api,
                      URL url,
                      String method)

Constructs an authenticated BoxJSONRequest using a provided BoxAPIConnection.

Parameters:

api - an API connection for authenticating the request.

url - the URL of the request.

method - the HTTP method of the request.

BoxJSONRequest

public BoxJSONRequest(BoxAPIConnection api,
                      URL url,
                      HttpMethod method)

Constructs an authenticated BoxJSONRequest using a provided BoxAPIConnection.

Parameters:

api - an API connection for authenticating the request.

url - the URL of the request.

method - the HTTP method of the request.

BoxJSONRequest

public BoxJSONRequest(URL url,
                      HttpMethod method)

Constructs an authenticated BoxJSONRequest.

Parameters:

url - the URL of the request.

method - the HTTP method of the request.

Method Detail

setBody

public void setBody(String body)

Sets the body of this request to a given JSON string.

Overrides:

setBody in class BoxAPIRequest

Parameters:

body - the JSON string to use as the body.

setBody

public void setBody(JsonObject body)

Sets the body of this request to a given JsonObject.

Parameters:

body - the JsonObject to use as the body.

getBodyAsJsonObject

public JsonObject getBodyAsJsonObject()

Gets the body of this request as a JsonObject.

Returns:

body represented as JsonObject.

getBodyAsJsonValue

public JsonValue getBodyAsJsonValue()

Gets the body of this request as a JsonValue.

Returns:

body represented as JsonValue

bodyToString

protected String bodyToString()

Description copied from class: BoxAPIRequest

Returns a String representation of this request's body used in BoxAPIRequest.toString(). This method returns null by default.

A subclass may want override this method if the body can be converted to a String for logging or debugging purposes.

Overrides:

bodyToString in class BoxAPIRequest

Returns:

a String representation of this request's body.