PR feedback

Author: sgonzalezMSFT

src/main/java/com/microsoft/aad/msal4j/ClientApplicationBase.java

@@ -346,9 +346,11 @@ public T executorService(ExecutorService val) {
         }
 
         /**
-         * Sets Proxy configuration to be used by the client application for all network communication.
-         * Default is null and system defined properties if any, would be used. If HTTP client is set on
-         * the client application, proxy configuration should be configured on the HTTP client object,
+         * Sets Proxy configuration to be used by the client application (MSAL4J by default uses
+         * {@link javax.net.ssl.HttpsURLConnection}) for all network communication.
+         * If no proxy value is passed in, system defined properties are used. If HTTP client is set on
+         * the client application (via ClientApplication.builder().httpClient()),
+         * proxy configuration should be done on the HTTP client object being passed in,
          * and not through this method.
          *
          * @param val an instance of Proxy
@@ -377,8 +379,8 @@ public T httpClient(IHttpClient val){
 
         /**
          * Sets SSLSocketFactory to be used by the client application for all network communication.
-         * If HTTP client is set on the client application, any configuration of SSL should be done on the
-         * HTTP client and not through this method.
+         * If HTTP client is set on the client application (via ClientApplication.builder().httpClient()),
+         * any configuration of SSL should be done on the HTTP client and not through this method.
          *
          * @param val an instance of SSLSocketFactory
          * @return instance of the Builder on which method was called

src/main/java/com/microsoft/aad/msal4j/HttpHeaders.java

@@ -10,22 +10,22 @@
 
 final class HttpHeaders {
 
-    private final static String PRODUCT_HEADER_NAME = "x-client-SKU";
-    private final static String PRODUCT_HEADER_VALUE = "MSAL.Java";
+    final static String PRODUCT_HEADER_NAME = "x-client-SKU";
+    final static String PRODUCT_HEADER_VALUE = "MSAL.Java";
 
-    private  final static String PRODUCT_VERSION_HEADER_NAME = "x-client-VER";
-    private  final static String PRODUCT_VERSION_HEADER_VALUE = getProductVersion();
+    final static String PRODUCT_VERSION_HEADER_NAME = "x-client-VER";
+    final static String PRODUCT_VERSION_HEADER_VALUE = getProductVersion();
 
-    private final static String CPU_HEADER_NAME = "x-client-CPU";
-    private final static String CPU_HEADER_VALUE = System.getProperty("os.arch");
+    final static String CPU_HEADER_NAME = "x-client-CPU";
+    final static String CPU_HEADER_VALUE = System.getProperty("os.arch");
 
-    private final static String OS_HEADER_NAME = "x-client-OS";
-    private final static String OS_HEADER_VALUE = System.getProperty("os.name");
+    final static String OS_HEADER_NAME = "x-client-OS";
+    final static String OS_HEADER_VALUE = System.getProperty("os.name");
 
-    private final static String APPLICATION_NAME_HEADER_NAME = "x-app-name";
+    final static String APPLICATION_NAME_HEADER_NAME = "x-app-name";
     private final String applicationNameHeaderValue;
 
-    private final static String APPLICATION_VERSION_HEADER_NAME = "x-app-ver";
+    final static String APPLICATION_VERSION_HEADER_NAME = "x-app-ver";
     private final String applicationVersionHeaderValue;
 
     final static String CORRELATION_ID_HEADER_NAME = "client-request-id";

src/test/java/com/microsoft/aad/msal4j/HttpHeaderTest.java

@@ -27,13 +27,13 @@ public void testHttpHeaderConstructor(){
 
         Map<String, String> httpHeaderMap = httpHeaders.getReadonlyHeaderMap();
 
-        Assert.assertEquals(httpHeaderMap.get("x-client-SKU"), "MSAL.Java");
-        Assert.assertEquals(httpHeaderMap.get("x-client-VER"), "1.0");
-        Assert.assertEquals(httpHeaderMap.get("x-client-CPU"), System.getProperty("os.arch"));
-        Assert.assertEquals(httpHeaderMap.get("x-client-OS"), System.getProperty("os.name"));
-        Assert.assertEquals(httpHeaderMap.get("x-app-name"), "app-name");
-        Assert.assertEquals(httpHeaderMap.get("x-app-ver"), "app-version");
-        Assert.assertEquals(httpHeaderMap.get("client-request-id"), "correlation-id");
+        Assert.assertEquals(httpHeaderMap.get(HttpHeaders.PRODUCT_HEADER_NAME), HttpHeaders.PRODUCT_HEADER_VALUE);
+        Assert.assertEquals(httpHeaderMap.get(HttpHeaders.PRODUCT_VERSION_HEADER_NAME), HttpHeaders.PRODUCT_VERSION_HEADER_VALUE);
+        Assert.assertEquals(httpHeaderMap.get(HttpHeaders.OS_HEADER_NAME), HttpHeaders.OS_HEADER_VALUE);
+        Assert.assertEquals(httpHeaderMap.get(HttpHeaders.CPU_HEADER_NAME), HttpHeaders.CPU_HEADER_VALUE);
+        Assert.assertEquals(httpHeaderMap.get(HttpHeaders.APPLICATION_NAME_HEADER_NAME), "app-name");
+        Assert.assertEquals(httpHeaderMap.get(HttpHeaders.APPLICATION_VERSION_HEADER_NAME), "app-version");
+        Assert.assertEquals(httpHeaderMap.get(HttpHeaders.CORRELATION_ID_HEADER_NAME), "correlation-id");
     }
 
     @Test
@@ -49,12 +49,12 @@ public void testHttpHeaderConstructor_valuesNotSet(){
 
         Map<String, String> httpHeaderMap = httpHeaders.getReadonlyHeaderMap();
 
-        Assert.assertEquals(httpHeaderMap.get("x-client-SKU"), "MSAL.Java");
-        Assert.assertEquals(httpHeaderMap.get("x-client-VER"), "1.0");
-        Assert.assertEquals(httpHeaderMap.get("x-client-CPU"), System.getProperty("os.arch"));
-        Assert.assertEquals(httpHeaderMap.get("x-client-OS"), System.getProperty("os.name"));
-        Assert.assertNull(httpHeaderMap.get("x-app-name"));
-        Assert.assertNull(httpHeaderMap.get("x-app-ver"));
-        Assert.assertNotNull(httpHeaderMap.get("client-request-id"));
+        Assert.assertEquals(httpHeaderMap.get(HttpHeaders.PRODUCT_HEADER_NAME), HttpHeaders.PRODUCT_HEADER_VALUE);
+        Assert.assertEquals(httpHeaderMap.get(HttpHeaders.PRODUCT_VERSION_HEADER_NAME), HttpHeaders.PRODUCT_VERSION_HEADER_VALUE);
+        Assert.assertEquals(httpHeaderMap.get(HttpHeaders.OS_HEADER_NAME), HttpHeaders.OS_HEADER_VALUE);
+        Assert.assertEquals(httpHeaderMap.get(HttpHeaders.CPU_HEADER_NAME), HttpHeaders.CPU_HEADER_VALUE);
+        Assert.assertNull(httpHeaderMap.get(HttpHeaders.APPLICATION_NAME_HEADER_NAME));
+        Assert.assertNull(httpHeaderMap.get(HttpHeaders.APPLICATION_VERSION_HEADER_NAME));
+        Assert.assertNotNull(httpHeaderMap.get(HttpHeaders.CORRELATION_ID_HEADER_NAME));
     }
 }