Merge pull request #60 from davidmoten/rework-client-2

rework GraphServiceClient

Author: Caitlin Bales (MSFT)

README.md

@@ -43,12 +43,10 @@ For an example of authentication in a client application, see the [MSGraph SDK A
 After you have set the correct application ID and URL, you must get a **GraphServiceClient** object to make requests against the service. The SDK stores the account information for you, but when a user signs in for the first time, it invokes the UI to get the user's account information.
 
 ```java
-IClientConfig clientConfig = 
-  DefaultClientConfig.createWithAuthenticationProvider(mAuthenticationProvider);
-
 IGraphServiceClient graphClient = 
-  GraphServiceClient.builder()
-    .fromConfig(mClientConfig)
+  GraphServiceClient
+    .builder()
+    .authenticationProvider(authenticationProvider)
     .buildClient();
 ```
 

src/main/java/com/microsoft/graph/concurrency/DefaultExecutors.java

@@ -23,6 +23,7 @@
 package com.microsoft.graph.concurrency;
 
 import com.microsoft.graph.logger.ILogger;
+import com.google.common.annotations.VisibleForTesting;
 import com.microsoft.graph.core.ClientException;
 
 import java.util.concurrent.Executors;
@@ -139,4 +140,9 @@ public void run() {
         });
     }
 
+    @VisibleForTesting
+    public ILogger getLogger() {
+        return logger;
+    }
+
 }

src/main/java/com/microsoft/graph/core/DefaultClientConfig.java

@@ -37,11 +37,6 @@
  */
 public abstract class DefaultClientConfig implements IClientConfig {
 
-    /**
-     * The authentication provider instance
-     */
-    private IAuthenticationProvider authenticationProvider;
-
     /**
      * The executors instance
      */
@@ -72,8 +67,12 @@ public static IClientConfig createWithAuthenticationProvider(
             final IAuthenticationProvider authenticationProvider
     ) {
         DefaultClientConfig config = new DefaultClientConfig() {
+
+            @Override
+            public IAuthenticationProvider getAuthenticationProvider() {
+                return authenticationProvider;
+            }
         };
-        config.authenticationProvider = authenticationProvider;
         config.getLogger()
               .logDebug(
                         "Using provided auth provider "
@@ -90,10 +89,7 @@ public static IClientConfig createWithAuthenticationProvider(
      * @return the authentication provider
      */
     @Override
-    public IAuthenticationProvider getAuthenticationProvider() {
-        return authenticationProvider;
-    }
-
+    public abstract IAuthenticationProvider getAuthenticationProvider();
     /**
      * Gets the HTTP provider
      *

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

@@ -453,4 +453,19 @@ static boolean hasHeader(List<HeaderOption> headers, String header) {
         }
         return false;
     }
+
+    @VisibleForTesting
+    public ILogger getLogger() {
+        return logger;
+    }
+
+    @VisibleForTesting
+    public IExecutors getExecutors() {
+        return executors;
+    }
+
+    @VisibleForTesting
+    public IAuthenticationProvider getAuthenticationProvider() {
+        return authenticationProvider;
+    }
 }

src/main/java/com/microsoft/graph/requests/extensions/GraphServiceClient.java

@@ -27,124 +27,199 @@ public class GraphServiceClient extends BaseGraphServiceClient implements IGraph
      */
     protected GraphServiceClient() {
     }
-    
+
     /**
      * Send a custom request to Graph
      * 
-     * @param url          the full URL to make a request with
-     * @param responseType the response class to deserialize the response into
+     * @param url
+     *            the full URL to make a request with
+     * @param responseType
+     *            the response class to deserialize the response into
      * @return the instance of this builder
      */
-    public CustomRequestBuilder customRequest(final String url, final Class responseType) {
-    	return new CustomRequestBuilder(getServiceRoot() + url, (IGraphServiceClient)this, null, responseType);
+    public <T> CustomRequestBuilder<T> customRequest(final String url, final Class<T> responseType) {
+        return new CustomRequestBuilder<T>(getServiceRoot() + url, (IGraphServiceClient) this, null, responseType);
     }
-    
+
     /**
      * Send a custom request to Graph
      * 
-     * @param url the full URL to make a request with
+     * @param url
+     *            the full URL to make a request with
      * @return the instance of this builder
      */
-    public CustomRequestBuilder customRequest(final String url) {
-    	return new CustomRequestBuilder(getServiceRoot() + url, (IGraphServiceClient)this, null, JsonObject.class);
-    }
-    
-    public static Builder builder() {
-        return new Builder();
+    public CustomRequestBuilder<JsonObject> customRequest(final String url) {
+        return new CustomRequestBuilder<JsonObject>(getServiceRoot() + url, (IGraphServiceClient) this, null,
+                JsonObject.class);
     }
 
     /**
-     * The builder for this GraphServiceClient
+     * Returns a Graph service client using the given configuration.
+     * 
+     * @param config
+     *            the client configuration
+     * @return a Graph service client
      */
-    public static class Builder  {
+    public static IGraphServiceClient fromConfig(final IClientConfig config) {
+        GraphServiceClient client = new GraphServiceClient();
+        client.setAuthenticationProvider(config.getAuthenticationProvider());
+        client.setExecutors(config.getExecutors());
+        client.setHttpProvider(config.getHttpProvider());
+        client.setLogger(config.getLogger());
+        client.setSerializer(config.getSerializer());
+        client.validate();
+        return client;
+    }
+
+    public static Builder builder() {
+        return new Builder();
+    }
+    
+    public static final class Builder {
 
         Builder() {
-            // ensure instantiation only from static factory method 
+            // restrict instantiation
         }
 
         /**
-         * The client under construction
-         */
-        private final GraphServiceClient client = new GraphServiceClient();
-
-        /**
-         * Sets the serializer
+         * Sets the authentication provider
          * 
-         * @param serializer the serializer
-         * @return the instance of this builder
+         * @param authenticationProvider
+         *            the authentication provider
+         * @return a new builder that allows specification of other aspects of the GraphServiceClient
          */
-        public Builder serializer(final ISerializer serializer) {
-            client.setSerializer(serializer);
-            return this;
+        public Builder2 authenticationProvider(IAuthenticationProvider authenticationProvider) {
+            checkNotNull(authenticationProvider, "authenticationProvider");
+            return new Builder2(authenticationProvider);
+        }
+    }
+    
+    /**
+     * The builder for this GraphServiceClient
+     */
+    public static final class Builder2 {
+        
+        private final IAuthenticationProvider authenticationProvider;
+        private ISerializer serializer;
+        private IHttpProvider httpProvider;
+        private IExecutors executors;
+        private ILogger logger;
+
+        
+        Builder2(IAuthenticationProvider authenticationProvider) {
+            this.authenticationProvider = authenticationProvider;
         }
 
         /**
-         * Sets the httpProvider
+         * Sets the serializer.
          * 
-         * @param httpProvider the httpProvider
+         * @param serializer
+         *            the serializer
          * @return the instance of this builder
          */
-        public Builder httpProvider(final IHttpProvider httpProvider) {
-            client.setHttpProvider(httpProvider);
+        public Builder2 serializer(final ISerializer serializer) {
+            checkNotNull(serializer, "serializer");
+            this.serializer = serializer;
             return this;
         }
 
         /**
-         * Sets the authentication provider
+         * Sets the httpProvider
          * 
-         * @param authenticationProvider the authentication provider
+         * @param httpProvider
+         *            the httpProvider
          * @return the instance of this builder
          */
-        public Builder authenticationProvider(final IAuthenticationProvider authenticationProvider) {
-            client.setAuthenticationProvider(authenticationProvider);
+        public Builder2 httpProvider(final IHttpProvider httpProvider) {
+            checkNotNull(httpProvider, "httpProvider");
+            this.httpProvider = httpProvider;
             return this;
         }
 
         /**
          * Sets the executors
          * 
-         * @param executors the executors
+         * @param executors
+         *            the executors
          * @return the instance of this builder
          */
-        public Builder executors(final IExecutors executors) {
-            client.setExecutors(executors);
+        public Builder2 executors(final IExecutors executors) {
+            checkNotNull(executors, "executors");
+            this.executors = executors;
             return this;
         }
 
         /**
          * Sets the logger
          * 
-         * @param logger the logger
+         * @param logger
+         *            the logger
          * @return the instance of this builder
          */
-        public Builder logger(final ILogger logger) {
-            client.setLogger(logger);
+        public Builder2 logger(final ILogger logger) {
+            checkNotNull(logger, "logger");
+            this.logger = logger;
             return this;
         }
 
         /**
-         * Set this builder based on the client configuration
+         * Builds and returns the Graph service client.
          * 
-         * @param clientConfig the client configuration
-         * @return the instance of this builder
+         * @return the Graph service client object
+         * @throws ClientException
+         *             if there was an exception creating the client
          */
-        public Builder fromConfig(final IClientConfig clientConfig) {
-            return this.authenticationProvider(clientConfig.getAuthenticationProvider())
-                       .executors(clientConfig.getExecutors())
-                       .httpProvider(clientConfig.getHttpProvider())
-                       .logger(clientConfig.getLogger())
-                       .serializer(clientConfig.getSerializer());
-        }
+        public IGraphServiceClient buildClient() throws ClientException {
+            DefaultClientConfig config = new DefaultClientConfig() {
 
-        /**
-         * Builds and returns the GraphServiceClient
-         * 
-         * @return the GraphServiceClient object
-         * @throws ClientException if there was an exception creating the client
-         */
-        public IGraphServiceClient buildClient() throws ClientException  {
-            client.validate();
-            return client;
+                @Override
+                public IAuthenticationProvider getAuthenticationProvider() {
+                    return authenticationProvider; 
+                }
+
+                @Override
+                public IHttpProvider getHttpProvider() {
+                    if (httpProvider != null) {
+                        return httpProvider;
+                    } else {
+                        return super.getHttpProvider();
+                    }
+                }
+
+                @Override
+                public IExecutors getExecutors() {
+                    if (executors != null) {
+                        return executors;
+                    } else {
+                        return super.getExecutors();
+                    }
+                }
+
+                @Override
+                public ILogger getLogger() {
+                    if (logger !=null) {
+                        return logger;
+                    } else {
+                        return super.getLogger();
+                    }
+                }
+
+                @Override
+                public ISerializer getSerializer() {
+                    if (serializer != null) {
+                        return serializer;
+                    } else {
+                        return super.getSerializer();
+                    }
+                }
+            };
+            return GraphServiceClient.fromConfig(config);
+        }
+    }
+    
+    private static void checkNotNull(Object o, String name) {
+        if (o==null) {
+            throw new NullPointerException(name + " cannot be null");
         }
     }
 }

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

@@ -22,6 +22,7 @@
 
 package com.microsoft.graph.serializer;
 
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.CaseFormat;
 import com.google.gson.Gson;
 import com.google.gson.JsonElement;
@@ -252,4 +253,9 @@ private Class<?> getDerivedClass(JsonObject jsonObject, Class<?> parentClass) {
         //If there is no defined OData type, return null
         return null;
     }
+
+    @VisibleForTesting
+    public ILogger getLogger() {
+        return logger;
+    }
 }

src/test/java/com/microsoft/graph/core/DefaultClientConfigTests.java

@@ -49,6 +49,11 @@ public ILogger getLogger() {
                 return logger;
             }
 
+            @Override
+            public IAuthenticationProvider getAuthenticationProvider() {
+                return new MockAuthenticationProvider();
+            }
+
         };
         config.getExecutors();
         config.getAuthenticationProvider();

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

@@ -53,7 +53,7 @@ public void authenticateRequest(final IHttpRequest request) {
                 };
                 IClientConfig mClientConfig = DefaultClientConfig.createWithAuthenticationProvider(mAuthenticationProvider);
 
-                graphClient = GraphServiceClient.builder().fromConfig(mClientConfig).buildClient();
+                graphClient = GraphServiceClient.fromConfig(mClientConfig);
             }
             catch (Exception e)
             {