com.box.sdk.BatchAPIRequest Maven / Gradle / Ivy
package com.box.sdk;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import com.box.sdk.http.HttpHeaders;
import com.box.sdk.http.HttpMethod;
import com.eclipsesource.json.JsonArray;
import com.eclipsesource.json.JsonObject;
import com.eclipsesource.json.JsonValue;
/**
* 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
*/
public class BatchAPIRequest extends BoxJSONRequest {
/**
* Batch URL Template.
*/
public static final URLTemplate BATCH_URL_TEMPLATE = new URLTemplate("batch");
private final BoxAPIConnection api;
/**
* Constructs an authenticated BatchRequest using a provided BoxAPIConnection.
* @param api an API connection for authenticating the request.
*/
public BatchAPIRequest(BoxAPIConnection api) {
super(api, BATCH_URL_TEMPLATE.build(api.getBaseURL()), HttpMethod.GET);
this.api = api;
}
/**
* Execute a set of API calls as batch request.
* @param requests list of api requests that has to be executed in batch.
* @return list of BoxAPIResponses
*/
public List execute(List requests) {
this.prepareRequest(requests);
BoxJSONResponse batchResponse = (BoxJSONResponse) send();
return this.parseResponse(batchResponse);
}
/**
* Prepare a batch api request using list of individual reuests.
* @param requests list of api requests that has to be executed in batch.
*/
protected void prepareRequest(List requests) {
JsonObject body = new JsonObject();
JsonArray requestsJSONArray = new JsonArray();
for (BoxAPIRequest request: requests) {
JsonObject batchRequest = new JsonObject();
batchRequest.add("method", request.getMethod());
batchRequest.add("relative_url", request.getUrl().toString().substring(this.api.getBaseURL().length() - 1));
//If the actual request has a JSON body then add it to vatch request
if (request instanceof BoxJSONRequest) {
BoxJSONRequest jsonRequest = (BoxJSONRequest) request;
batchRequest.add("body", jsonRequest.getBodyAsJsonValue());
}
//Add any headers that are in the request, except Authorization
if (request.getHeaders() != null) {
JsonObject batchRequestHeaders = new JsonObject();
for (RequestHeader header: request.getHeaders()) {
if (header.getKey() != null && !header.getKey().isEmpty()
&& HttpHeaders.AUTHORIZATION.equals(header.getKey())) {
batchRequestHeaders.add(header.getKey(), header.getValue());
}
}
batchRequest.add("headers", batchRequestHeaders);
}
//Add the request to array
requestsJSONArray.add(batchRequest);
}
//Add the requests array to body
body.add("requests", requestsJSONArray);
super.setBody(body);
}
/**
* Parses btch api response to create a list of BoxAPIResponse objects.
* @param batchResponse response of a batch api request
* @return list of BoxAPIResponses
*/
protected List parseResponse(BoxJSONResponse batchResponse) {
JsonObject responseJSON = JsonObject.readFrom(batchResponse.getJSON());
List responses = new ArrayList();
Iterator responseIterator = responseJSON.get("responses").asArray().iterator();
while (responseIterator.hasNext()) {
JsonObject jsonResponse = responseIterator.next().asObject();
BoxAPIResponse response = null;
//Gather headers
Map responseHeaders = new HashMap();
if (jsonResponse.get("headers") != null) {
JsonObject batchResponseHeadersObject = jsonResponse.get("headers").asObject();
for (JsonObject.Member member : batchResponseHeadersObject) {
String headerName = member.getName();
String headerValue = member.getValue().asString();
responseHeaders.put(headerName, headerValue);
}
}
// Construct a BoxAPIResponse when response is null, or a BoxJSONResponse when there's a response
// (not anticipating any other response as per current APIs.
// Ideally we should do it based on response header)
if (jsonResponse.get("response") == null || jsonResponse.get("response").isNull()) {
response =
new BoxAPIResponse(jsonResponse.get("status").asInt(), responseHeaders);
} else {
response =
new BoxJSONResponse(jsonResponse.get("status").asInt(), responseHeaders,
jsonResponse.get("response").asObject());
}
responses.add(response);
}
return responses;
}
}