Merge pull request #15 from microsoftgraph/response-headers

Return response headers for successful calls against the API

Author: Caitlin Bales (MSFT)

src/main/java/com/microsoft/graph/http/DefaultHttpProvider.java

@@ -35,6 +35,7 @@
 
 import java.io.BufferedInputStream;
 import java.io.BufferedOutputStream;
+import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
@@ -297,13 +298,13 @@ private <Result, Body, DeserializeType> Result sendRequestInternal(final IHttpRe
 
                 if (connection.getResponseCode() == HttpResponseCode.HTTP_NOBODY
                         || connection.getResponseCode() == HttpResponseCode.HTTP_NOT_MODIFIED) {
-                    logger.logDebug("Handling response with no body");
-                    return null;
+                    logger.logDebug("Handling response with no body");                  
+                    return handleEmptyResponse(connection.getResponseHeaders(), resultClass);
                 }
 
                 if (connection.getResponseCode() == HttpResponseCode.HTTP_ACCEPTED) {
                     logger.logDebug("Handling accepted response");
-                    return null;
+                    return handleEmptyResponse(connection.getResponseHeaders(), resultClass);
                 }
 
                 in = new BufferedInputStream(connection.getInputStream());
@@ -313,7 +314,7 @@ private <Result, Body, DeserializeType> Result sendRequestInternal(final IHttpRe
                 final String contentType = headers.get(CONTENT_TYPE_HEADER_NAME);
                 if (contentType.contains(JSON_CONTENT_TYPE)) {
                     logger.logDebug("Response json");
-                    return handleJsonResponse(in, resultClass);
+                    return handleJsonResponse(in, connection.getResponseHeaders(), resultClass);
                 } else {
                     logger.logDebug("Response binary");
                     isBinaryStreamInput = true;
@@ -372,18 +373,33 @@ private InputStream handleBinaryStream(final InputStream in) {
     /**
      * Handles the cause where the response is a JSON object.
      *
-     * @param in       The input stream from the response.
-     * @param clazz    The class of the response object.
+     * @param in              The input stream from the response.
+     * @param responseHeaders The response headers
+     * @param clazz           The class of the response object.
      * @param <Result> The type of the response object.
      * @return The JSON object.
      */
-    private <Result> Result handleJsonResponse(final InputStream in, final Class<Result> clazz) {
+    private <Result> Result handleJsonResponse(final InputStream in, Map<String, List<String>> responseHeaders, final Class<Result> clazz) {
         if (clazz == null) {
             return null;
         }
 
         final String rawJson = streamToString(in);
-        return getSerializer().deserializeObject(rawJson, clazz);
+        return getSerializer().deserializeObject(rawJson, clazz, responseHeaders);
+    }
+    
+    /**
+     * Handles the case where the response body is empty.
+     * 
+     * @param responseHeaders The response headers
+     * @param clazz           The type of the response object
+     * @return The JSON object
+     */
+    private <Result> Result handleEmptyResponse(Map<String, List<String>> responseHeaders, final Class<Result> clazz) {
+    	//Create an empty object to attach the response headers to
+        InputStream in = new ByteArrayInputStream("{}".getBytes());
+        
+    	return handleJsonResponse(in, responseHeaders, clazz);
     }
 
     /**

src/main/java/com/microsoft/graph/http/GraphServiceException.java

@@ -283,7 +283,7 @@ public static <T> GraphServiceException createFromConnection(final IHttpRequest
         final String rawOutput = DefaultHttpProvider.streamToString(connection.getInputStream());
         GraphErrorResponse error;
         try {
-            error = serializer.deserializeObject(rawOutput, GraphErrorResponse.class);
+            error = serializer.deserializeObject(rawOutput, GraphErrorResponse.class, connection.getResponseHeaders());
         } catch (final Exception ex) {
             error = new GraphErrorResponse();
             error.error = new GraphError();

src/main/java/com/microsoft/graph/http/IConnection.java

@@ -25,6 +25,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
+import java.util.List;
 import java.util.Map;
 
 /**
@@ -90,6 +91,8 @@ public interface IConnection {
      * @return The map of headers.
      */
     Map<String, String> getHeaders();
+    
+    Map<String, List<String>> getResponseHeaders();
 
     /**
      * Gets the HTTP request method.

src/main/java/com/microsoft/graph/http/UrlConnection.java

@@ -29,7 +29,9 @@
 import java.io.OutputStream;
 import java.net.HttpURLConnection;
 import java.net.ProtocolException;
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 /**
@@ -107,6 +109,23 @@ public int getContentLength() {
     public int getResponseCode() throws IOException {
         return connection.getResponseCode();
     }
+    
+    public Map<String, List<String>> getResponseHeaders() {
+    	// Copy unmodifiable map to hashmap
+    	HashMap<String, List<String>> headerFields = new HashMap<>();
+    	headerFields.putAll(connection.getHeaderFields());
+    	
+    	// Add the response code
+    	List<String> list = new ArrayList<>();
+    	try {
+			list.add(String.format("%d", connection.getResponseCode()));
+		} catch (IOException e) {
+			throw new IllegalArgumentException("Invalid connection response code: could not connect to server", e);
+		}
+    
+    	headerFields.put("responseCode", list);
+    	return headerFields;
+    }
 
     @Override
     public String getResponseMessage() throws IOException {

src/main/java/com/microsoft/graph/serializer/DefaultSerializer.java

@@ -67,6 +67,11 @@ public DefaultSerializer(final ILogger logger) {
      */
     @Override
     public <T> T deserializeObject(final String inputString, final Class<T> clazz) {
+    	return deserializeObject(inputString, clazz, null);
+    }
+    
+    @Override
+    public <T> T deserializeObject(final String inputString, final Class<T> clazz, Map<String, java.util.List<String>> responseHeaders) {
         T jsonObject = gson.fromJson(inputString, clazz);
 
         // Populate the JSON-backed fields for any annotations that are not in the object model
@@ -82,6 +87,12 @@ public <T> T deserializeObject(final String inputString, final Class<T> clazz) {
 			}
 
             jsonBackedObject.setRawObject(this, rawObject);
+
+            if (responseHeaders != null) {
+	            JsonElement convertedHeaders = gson.toJsonTree(responseHeaders);
+	            jsonBackedObject.additionalDataManager().put("graphResponseHeaders", convertedHeaders);
+            }
+            
             jsonBackedObject.additionalDataManager().setAdditionalData(rawObject);
         } else {
             logger.logDebug("Deserializing a non-IJsonBackedObject type " + clazz.getSimpleName());

src/main/java/com/microsoft/graph/serializer/ISerializer.java

@@ -22,6 +22,9 @@
 
 package com.microsoft.graph.serializer;
 
+import java.util.List;
+import java.util.Map;
+
 /**
  * Serializes and deserializes items from strings into their types.
  */
@@ -35,6 +38,15 @@ public interface ISerializer {
      * @return The deserialized item from the input string.
      */
     <T> T deserializeObject(final String inputString, Class<T> clazz);
+    
+    /**
+     * Deserialize an object from the input string.
+     * @param inputString The string that stores the representation of the item.
+     * @param clazz The .class of the item to be deserialized.
+     * @param <T> The type of the item to be deserialized.
+     * @return The deserialized item from the input string.
+     */
+    <T> T deserializeObject(final String inputString, Class<T> clazz, Map<String, List<String>> responseHeaders);
 
     /**
      * Serializes an object into a string.

src/test/java/com/microsoft/graph/functional/TestBase.java

@@ -98,7 +98,7 @@ private String GetAccessToken()
             conn.disconnect();
 
             JsonObject res = new GsonBuilder().create().fromJson(jsonString.toString(), JsonObject.class);
-            return res.get("access_token").toString();
+            return res.get("access_token").toString().replaceAll("\"", "");
 
         } catch (Exception e) {
             throw new Error("Error retrieving access token: " + e.getLocalizedMessage());

src/test/java/com/microsoft/graph/http/MockConnection.java

@@ -5,7 +5,9 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 /**
@@ -76,4 +78,14 @@ public void setContentLength(int length) {
         // noop
     }
 
+	@Override
+	public Map<String, List<String>> getResponseHeaders() {
+		Map<String, List<String>> headers = new HashMap<String, List<String>>();
+		ArrayList<String> headerValues = new ArrayList<String>();
+		headerValues.add("value1");
+		headers.put("header1", headerValues);
+		
+		return headers;
+	}
+
 }

src/test/java/com/microsoft/graph/serializer/DefaultSeralizerTests.java

@@ -2,14 +2,15 @@
 
 import static org.junit.Assert.*;
 
-import org.junit.After;
-import org.junit.Before;
 import org.junit.Test;
 
 import com.microsoft.graph.models.extensions.Drive;
+import com.microsoft.graph.models.extensions.User;
 import com.microsoft.graph.models.extensions.FileAttachment;
 import com.microsoft.graph.models.generated.RecurrenceRangeType;
 import com.microsoft.graph.models.generated.BaseRecurrenceRange;
+import com.google.gson.JsonElement;
+import com.microsoft.graph.http.MockConnection;
 import com.microsoft.graph.logger.DefaultLogger;
 import com.microsoft.graph.models.extensions.Attachment;
 import com.microsoft.graph.models.extensions.DateOnly;
@@ -68,6 +69,21 @@ public void testRecurrenceRangeSerialization() throws Exception {
     }
 
 	@Test
+	public void testResponseHeaders() throws Exception {
+		MockConnection connection = new MockConnection(null);
+		final DefaultSerializer serializer = new DefaultSerializer(new DefaultLogger());
+		User user = serializer.deserializeObject("{\"id\":\"1\"}", User.class, connection.getResponseHeaders());
+		
+		JsonElement responseHeaders = user.additionalDataManager().get("graphResponseHeaders");
+		assertNotNull(responseHeaders);
+		
+		JsonElement responseHeader = responseHeaders.getAsJsonObject().get("header1");
+		assertNotNull(responseHeader);
+		
+		assertEquals("value1", responseHeader.getAsJsonArray().get(0).getAsString());
+	}
+
+  @Test
 	public void testDeserializeDerivedType() throws Exception {
 		final DefaultSerializer serializer = new DefaultSerializer(new DefaultLogger());
 		String source = "{\"@odata.context\": \"/attachments/$entity\",\"@odata.type\": \"#microsoft.graph.fileAttachment\",\"id\": \"AAMkAGQ0MjBmNWVkLTYxZjUtNDRmYi05Y2NiLTBlYjIwNzJjNmM1NgBGAAAAAAC6ff7latYeQqu_gLrhSAIhBwCF7iGjpaOmRqVwbZc-xXzwAAAAAAEMAACF7iGjpaOmRqVwbZc-xXzwAABQStA0AAABEgAQAFbGmeisbjtLnQdp7kC_9Fk=\",\"lastModifiedDateTime\": \"2018-01-23T21:50:22Z\",\"name\": \"Test Book.xlsx\",\"contentType\": \"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\",\"size\": 8457,\"isInline\": false,\"contentId\": null,\"contentLocation\": null,\"contentBytes\": \"bytedata\"}";

src/test/java/com/microsoft/graph/serializer/MockSerializer.java

@@ -22,6 +22,9 @@
 
 package com.microsoft.graph.serializer;
 
+import java.util.List;
+import java.util.Map;
+
 /**
  * Mock instance of the {@see ISerializer}
  */
@@ -56,4 +59,10 @@ public <T> T deserializeObject(final String inputString, final Class<T> clazz) {
     public <T> String serializeObject(final T serializableObject) {
         return mSerializeReturn;
     }
+
+	@Override
+	public <T> T deserializeObject(String inputString, Class<T> clazz, Map<String, List<String>> responseHeaders) {
+		// TODO Auto-generated method stub
+		return (T) mDeserializeReturn;
+	}
 }