Access response headers

Author: Caitlin Bales (MSFT)

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

@@ -313,7 +313,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;
@@ -377,13 +377,13 @@ private InputStream handleBinaryStream(final InputStream in) {
      * @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);
     }
 
     /**

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

@@ -30,6 +30,7 @@
 import java.net.HttpURLConnection;
 import java.net.ProtocolException;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 /**
@@ -107,6 +108,10 @@ public int getContentLength() {
     public int getResponseCode() throws IOException {
         return connection.getResponseCode();
     }
+    
+    public Map<String, List<String>> getResponseHeaders() {
+    	return connection.getHeaderFields();
+    }
 
     @Override
     public String getResponseMessage() throws IOException {

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

@@ -64,6 +64,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) {
         final T jsonObject = gson.fromJson(inputString, clazz);
 
         // Populate the json backed fields for any annotations that are not in the object model
@@ -72,6 +77,12 @@ public <T> T deserializeObject(final String inputString, final Class<T> clazz) {
             final IJsonBackedObject jsonBackedObject = (IJsonBackedObject) jsonObject;
             final JsonObject rawObject = gson.fromJson(inputString, JsonObject.class);
             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/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/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;
+	}
 }