Added comments and removed suppressed warning

Author: Nakul Sabharwal

src/main/java/com/microsoft/graph/content/MSBatchRequestContent.java

@@ -7,17 +7,25 @@
 
 import org.json.simple.JSONArray;
 import org.json.simple.JSONObject;
+import org.json.simple.parser.JSONParser;
 import org.json.simple.parser.ParseException;
 
-import com.microsoft.graph.httpcore.RequestSerializer;
-
 import okhttp3.Headers;
+import okhttp3.Request;
 import okhttp3.RequestBody;
+import okio.Buffer;
 
 public class MSBatchRequestContent {
 	private Map<String, MSBatchRequestStep> batchRequestStepsHashMap;
+	
+	// Maximum number of requests that can be sent in a batch
 	public static final int MAX_NUMBER_OF_REQUESTS = 20;
 
+	/*
+	 * Creates Batch request content using list provided
+	 * 
+	 * @param batchRequestStepsArray List of batch steps for batching
+	 */
 	public MSBatchRequestContent(List<MSBatchRequestStep> batchRequestStepsArray) {
 		if(batchRequestStepsArray.size() > MAX_NUMBER_OF_REQUESTS)
 			throw new IllegalArgumentException("Number of batch request steps cannot exceed " + MAX_NUMBER_OF_REQUESTS);
@@ -27,31 +35,43 @@ public MSBatchRequestContent(List<MSBatchRequestStep> batchRequestStepsArray) {
 			addBatchRequestStep(requestStep);
 	}
 
+	/*
+	 * Creates empty batch request content
+	 */
 	public MSBatchRequestContent() {
 		batchRequestStepsHashMap = new HashMap<String, MSBatchRequestStep>();
 	}
 
+	/*
+	 * @param batchRequestStep Batch request step adding to batch content
+	 * @return true or false based on addition or no addition of batch request step given
+	 */
 	public boolean addBatchRequestStep(MSBatchRequestStep batchRequestStep) {
 		if(batchRequestStepsHashMap.containsKey(batchRequestStep.getRequestId())) 
 			return false;
 		batchRequestStepsHashMap.put(batchRequestStep.getRequestId(), batchRequestStep);
 		return true;
 	}
 
+	/*
+	 * @param requestId Id of Batch request step to be removed
+	 * @return true or false based on removal or no removal of batch request step with given id
+	 */
 	public boolean removeBatchRequestStepWithId(String requestId) {
 		boolean removed = false;
 		if(batchRequestStepsHashMap.containsKey(requestId)) {
 			batchRequestStepsHashMap.remove(requestId);
 			removed = true;
-		}
-		for(Map.Entry<String, MSBatchRequestStep> steps : batchRequestStepsHashMap.entrySet()) {
-			while(steps.getValue().getArrayOfDependsOnIds().remove(requestId))
-				removed = true;
+			for(Map.Entry<String, MSBatchRequestStep> steps : batchRequestStepsHashMap.entrySet()) {
+				while(steps.getValue().getArrayOfDependsOnIds().remove(requestId));
+			}
 		}
 		return removed;
 	}
 
-	@SuppressWarnings("unchecked")
+	/*
+	 * @return Batch request content's json as String
+	 */
 	public String getBatchRequestContent() {
 		JSONObject batchRequestContentMap = new JSONObject();
 		JSONArray batchContentArray = new JSONArray();
@@ -60,11 +80,10 @@ public String getBatchRequestContent() {
 		}
 		batchRequestContentMap.put("requests", batchContentArray);
 
-		String content =  batchRequestContentMap.toString();
+		String content = batchRequestContentMap.toString();
 		return content;
 	}
 
-	@SuppressWarnings("unchecked")
 	private JSONObject getBatchRequestObjectFromRequestStep(final MSBatchRequestStep batchRequestStep){
 		JSONObject contentmap = new JSONObject();
 		contentmap.put("id", batchRequestStep.getRequestId());
@@ -82,7 +101,7 @@ private JSONObject getBatchRequestObjectFromRequestStep(final MSBatchRequestStep
 		if(headers != null && headers.size() != 0) {
 			JSONObject headerMap = new JSONObject();
 			for(Map.Entry<String, List<String>> entry : headers.toMultimap().entrySet()) {
-				headerMap.put(entry.getKey(), RequestSerializer.getHeaderValuesAsString(entry.getValue()));
+				headerMap.put(entry.getKey(), getHeaderValuesAsString(entry.getValue()));
 			}
 			contentmap.put("headers", headerMap);
 		}
@@ -97,12 +116,32 @@ private JSONObject getBatchRequestObjectFromRequestStep(final MSBatchRequestStep
 		RequestBody body = batchRequestStep.getRequest().body(); 
 		if(body != null) {
 			try {
-				contentmap.put("body", RequestSerializer.requestBodyToJSONObject(batchRequestStep.getRequest()));
+				contentmap.put("body", requestBodyToJSONObject(batchRequestStep.getRequest()));
 			}catch(IOException | ParseException e) {
 				e.printStackTrace();
 			} 
 		}
 		return contentmap;
 	}
 
+	private String getHeaderValuesAsString(final List<String> list) {
+		if(list == null || list.size() == 0)return "";
+		StringBuilder builder = new StringBuilder(list.get(0));
+		for(int i=1;i<list.size();i++) {
+			builder.append(";");
+			builder.append(list.get(i));
+		}
+		return builder.toString();
+	}
+	
+	private JSONObject requestBodyToJSONObject(final Request request) throws IOException, ParseException{
+		if(request == null || request.body() == null)return null;
+		Request copy = request.newBuilder().build();
+		Buffer buffer = new Buffer();
+		copy.body().writeTo(buffer);
+		String requestBody = buffer.readUtf8();
+		JSONObject jsonObject = (JSONObject)new JSONParser().parse(requestBody);
+		return jsonObject;
+	}
+	
 }

src/main/java/com/microsoft/graph/content/MSBatchResponseContent.java

@@ -1,17 +1,20 @@
 package com.microsoft.graph.content;
 
 import java.io.IOException;
+import java.util.HashMap;
 import java.util.Map;
 
 import org.json.simple.JSONArray;
 import org.json.simple.JSONObject;
-
-import com.microsoft.graph.httpcore.RequestSerializer;
+import org.json.simple.parser.JSONParser;
+import org.json.simple.parser.ParseException;
 
 import okhttp3.MediaType;
 import okhttp3.Request;
+import okhttp3.RequestBody;
 import okhttp3.Response;
 import okhttp3.ResponseBody;
+import okio.Buffer;
 
 public class MSBatchResponseContent {
 
@@ -20,17 +23,20 @@ public class MSBatchResponseContent {
 	private Map<String, Request> batchRequestsHashMap;
 	private JSONArray batchResponseArray;
 
+	/*
+	 * @param batchResponse OkHttp batch response on execution of batch requests
+	 */
 	public MSBatchResponseContent(Response batchResponse) {
 		if(batchResponse == null)
 			throw new IllegalArgumentException("Batch Response cannot be null");
 
-		this.batchRequestsHashMap = RequestSerializer.createBatchRequestsHashMap(batchResponse);
+		this.batchRequestsHashMap = createBatchRequestsHashMap(batchResponse);
 		this.batchResponse = batchResponse;
 		if(batchResponse.body() != null) {
 			try {
 				String batchResponseData = batchResponse.body().string();
 				if(batchResponseData != null) {
-					batchResponseObj = RequestSerializer.stringToJSONObject(batchResponseData);
+					batchResponseObj = stringToJSONObject(batchResponseData);
 					if(batchResponseObj != null) {
 						batchResponseArray = (JSONArray)batchResponseObj.get("responses");
 					}
@@ -41,6 +47,12 @@ public MSBatchResponseContent(Response batchResponse) {
 		}
 	}
 
+	/*
+	 * Returns OkHttp Response of given request Id
+	 * 
+	 * @param requestId Request Id of batch step
+	 * @return OkHttp Response corresponding to requestId
+	 */
 	public Response getResponseById(String requestId) {
 		if(batchResponseObj == null)
 			return null;
@@ -107,4 +119,70 @@ public String nextLink() {
 		Object nextLinkObject = batchResponseObj.get("nextLink");
 		return nextLinkObject != null ? ((JSONObject)nextLinkObject).toString() : null;
 	}
+	
+	private Map<String, Request> createBatchRequestsHashMap(Response batchResponse) {
+		if(batchResponse == null)return null;
+		try {
+			Map<String, Request> batchRequestsHashMap = new HashMap<>();
+			JSONObject requestJSONObject = requestBodyToJSONObject(batchResponse.request());
+			JSONArray requestArray = (JSONArray)requestJSONObject.get("requests");
+			for(Object item : requestArray) {
+				JSONObject requestObject = (JSONObject)item;
+				
+				Request.Builder builder = new Request.Builder();
+				
+				if(requestObject.get("url") != null) {
+					StringBuilder fullUrl = new StringBuilder(batchResponse.request().url().toString().replace("$batch",""));
+					fullUrl.append(requestObject.get("url").toString());
+					builder.url(fullUrl.toString());
+				}
+				if(requestObject.get("headers") != null) {
+					JSONObject jsonheaders = (JSONObject)requestObject.get("headers");
+					for(Object key: jsonheaders.keySet()) {
+						String strkey = (String)key;
+						String strvalue = (String)jsonheaders.get(strkey);
+						for(String value : strvalue.split("; ")) {
+							builder.header(strkey, value);
+						}
+					}	
+				}
+				if(requestObject.get("body") != null) {
+					JSONObject jsonObject = (JSONObject)requestObject.get("body");
+					String bodyAsString = jsonObject.toJSONString();
+					RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), bodyAsString);
+					builder.method(requestObject.get("method").toString(), requestBody);
+				} else {
+					builder.method(requestObject.get("method").toString(), null);
+				}
+				batchRequestsHashMap.put(requestObject.get("id").toString(), builder.build());
+			}
+			return batchRequestsHashMap;
+			
+		} catch (IOException | ParseException e) { e.printStackTrace(); }
+		return null;
+	}
+	
+	private JSONObject stringToJSONObject(String input) {
+		JSONParser parser = new JSONParser();
+		JSONObject jsonObject = null;
+		try {
+			if(input != null) {
+				jsonObject = (JSONObject) parser.parse(input);
+			}
+		}
+		catch(Exception e) {
+			e.printStackTrace();
+		}
+		return jsonObject;
+	}
+	
+	private JSONObject requestBodyToJSONObject(final Request request) throws IOException, ParseException{
+		if(request == null || request.body() == null)return null;
+		Request copy = request.newBuilder().build();
+		Buffer buffer = new Buffer();
+		copy.body().writeTo(buffer);
+		String requestBody = buffer.readUtf8();
+		JSONObject jsonObject = (JSONObject)new JSONParser().parse(requestBody);
+		return jsonObject;
+	}
 }

src/main/java/com/microsoft/graph/httpcore/HttpClients.java

@@ -11,6 +11,8 @@ private HttpClients() {
     /**
      * Creates builder object for construction of custom
      * {@link OkHttpClient} instances.
+     * 
+     * @return OkHttpClient.Builder() custom builder for developer to add its own interceptors to it
      */
     public static Builder custom() {
         return new OkHttpClient.Builder();
@@ -19,6 +21,9 @@ public static Builder custom() {
     /**
      * Creates {@link OkHttpClient} instance with default
      * configuration and provided authProvider
+     * 
+     * @param auth Use IAuthenticationProvider instance provided while constructing http client
+     * @return OkHttpClient build with authentication provider given, default redirect and default retry handlers 
      */
     public static OkHttpClient createDefault(IAuthenticationProvider auth) {
     	return new OkHttpClient.Builder().addInterceptor(new AuthenticationHandler(auth))

src/main/java/com/microsoft/graph/httpcore/IAuthenticationProvider.java

@@ -7,6 +7,7 @@ public interface IAuthenticationProvider {
      * Authenticates the request
      * 
      * @param request the request to authenticate
+     * @return Request with Authorization header added to it
      */
     Request authenticateRequest(Request request);
 }

src/main/java/com/microsoft/graph/httpcore/RedirectHandler.java

@@ -40,7 +40,7 @@ public RedirectHandler(RedirectOptions redirectOptions) {
 		}
 	}
 
-    public boolean isRedirected(Request request, Response response, int redirectCount, RedirectOptions redirectOptions) throws IOException {
+    boolean isRedirected(Request request, Response response, int redirectCount, RedirectOptions redirectOptions) throws IOException {
         // Check max count of redirects reached
     	if(redirectCount > redirectOptions.maxRedirects()) return false;
 
@@ -61,7 +61,7 @@ public boolean isRedirected(Request request, Response response, int redirectCoun
         return false;
     }
 
-    public Request getRedirect(
+    Request getRedirect(
     		final Request request,
     		final Response userResponse) throws ProtocolException {    	
         String location = userResponse.header("Location");