com.box.sdk

Class BatchAPIRequest

Object

BoxAPIRequest

BoxJSONRequest

BatchAPIRequest

public class BatchAPIRequest
extends BoxJSONRequest

Used to make a bunch of HTTP Requests as a batch. Currently the number of requests that can be batched at once is capped at 20 by the API layer. Also there are certain requests which cannot be performed by Batch API. Check API documentation for more information.

The request itself is a BoxJSONRequest but extends it to provide additional functionality for aggregating a bunch of requests and responding with multiple responses as if the requests were called individually

Nested Class Summary

Nested classes/interfaces inherited from class BoxAPIRequest

BoxAPIRequest.RequestHeader

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	BATCH_URL_TEMPLATE Batch URL Template.

Constructor Summary

Constructors

Constructor and Description
BatchAPIRequest(BoxAPIConnection api) Constructs an authenticated BatchRequest using a provided BoxAPIConnection.

Method Summary

Modifier and Type	Method and Description
List<BoxAPIResponse>	execute(List<BoxAPIRequest> requests) Execute a set of API calls as batch request.
protected List<BoxAPIResponse>	parseResponse(BoxJSONResponse batchResponse) Parses btch api response to create a list of BoxAPIResponse objects.
protected void	prepareRequest(List<BoxAPIRequest> requests) Prepare a batch api request using list of individual reuests.

Methods inherited from class BoxJSONRequest

bodyToString, getBodyAsJsonObject, setBody, setBody

Methods inherited from class BoxAPIRequest

addHeader, getBody, getHeaders, getMethod, getUrl, resetBody, send, send, setBody, setBody, setConnectTimeout, setFollowRedirects, setReadTimeout, toString, writeBody

Methods inherited from class Object

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

Field Detail

BATCH_URL_TEMPLATE

public static final URLTemplate BATCH_URL_TEMPLATE

Batch URL Template.

Constructor Detail

BatchAPIRequest

public BatchAPIRequest(BoxAPIConnection api)

Constructs an authenticated BatchRequest using a provided BoxAPIConnection.

Parameters:

api - an API connection for authenticating the request.

Method Detail

execute

public List<BoxAPIResponse> execute(List<BoxAPIRequest> requests)

Execute a set of API calls as batch request.

Parameters:

requests - list of api requests that has to be executed in batch.

Returns:

list of BoxAPIResponses

prepareRequest

protected void prepareRequest(List<BoxAPIRequest> requests)

Prepare a batch api request using list of individual reuests.

Parameters:

requests - list of api requests that has to be executed in batch.

parseResponse

protected List<BoxAPIResponse> parseResponse(BoxJSONResponse batchResponse)

Parses btch api response to create a list of BoxAPIResponse objects.

Parameters:

batchResponse - response of a batch api request

Returns:

list of BoxAPIResponses