Merge pull request #1755 from microsoftgraph/feat/auth-handler

Support Authorization Handler in Graph Client Factory

Author: baywet

README.md

@@ -59,23 +59,23 @@ The nature of the Graph API is such that the SDK needs quite a large set of clas
 
 Register your application by following the steps at [Register your app with the Microsoft Identity Platform](https://docs.microsoft.com/graph/auth-register-app-v2).
 
-### 2.2 Create an IAuthenticationProvider object
+### 2.2 Create an AuthenticationProvider object
 
-An instance of the **HttpClients** class handles building client. To create a new instance of this class, you need to provide an instance of `IAuthenticationProvider`, which can authenticate requests to Microsoft Graph.
+[Initialize an `AuthenticationProvider`](https://learn.microsoft.com/en-us/graph/sdks/choose-authentication-providers?view=graph-rest-1.0&tabs=java) based on your preferred authentication flow
 
-For an example of how to get an authentication provider, see [choose a Microsoft Graph authentication provider](https://docs.microsoft.com/graph/sdks/choose-authentication-providers?tabs=Java).
+### 2.3 Get a OkHttpClient object
 
-### 2.3 Get a HttpClients object
+You must get an **OkHttpClient** object to make requests against the service.
 
-You must get a **HttpClients** object to make requests against the service.
+Using the `GraphClientFactory`, you can initialize an `OkHttpClient` pre-configured for use with Microsoft Graph
 
 ```java
-OkHttpClient client = HttpClients.createDefault(iAuthenticationProvider);
+OkHttpClient client = GraphClientFactory.create(authenticationProvider).build();
 ```
 
 ## 3. Make requests against the service
 
-After you have a HttpClients that is authenticated, you can begin making calls against the service. The requests against the service look like our [REST API](https://developer.microsoft.com/en-us/graph/docs/concepts/overview).
+After you have an OkHttpClient that is authenticated, you can begin making calls against the service. The requests against the service look like our [REST API](https://developer.microsoft.com/en-us/graph/docs/concepts/overview).
 
 ### 3.1 Get the user's details
 

gradle/dependencies.gradle

@@ -14,11 +14,11 @@ dependencies {
     api 'com.squareup.okhttp3:okhttp:4.12.0'
     api 'com.azure:azure-core:1.52.0'
 
-    api 'com.microsoft.kiota:microsoft-kiota-abstractions:1.4.0'
-    api 'com.microsoft.kiota:microsoft-kiota-authentication-azure:1.4.0'
-    implementation 'com.microsoft.kiota:microsoft-kiota-http-okHttp:1.4.0'
-    implementation 'com.microsoft.kiota:microsoft-kiota-serialization-json:1.4.0'
-    implementation 'com.microsoft.kiota:microsoft-kiota-serialization-text:1.4.0'
-    implementation 'com.microsoft.kiota:microsoft-kiota-serialization-form:1.4.0'
-    implementation 'com.microsoft.kiota:microsoft-kiota-serialization-multipart:1.4.0'
+    api 'com.microsoft.kiota:microsoft-kiota-abstractions:1.5.0'
+    api 'com.microsoft.kiota:microsoft-kiota-authentication-azure:1.5.0'
+    implementation 'com.microsoft.kiota:microsoft-kiota-http-okHttp:1.5.0'
+    implementation 'com.microsoft.kiota:microsoft-kiota-serialization-json:1.5.0'
+    implementation 'com.microsoft.kiota:microsoft-kiota-serialization-text:1.5.0'
+    implementation 'com.microsoft.kiota:microsoft-kiota-serialization-form:1.5.0'
+    implementation 'com.microsoft.kiota:microsoft-kiota-serialization-multipart:1.5.0'
 }

src/main/java/com/microsoft/graph/core/requests/GraphClientFactory.java

@@ -3,7 +3,9 @@
 import com.microsoft.graph.core.CoreConstants;
 import com.microsoft.graph.core.requests.middleware.GraphTelemetryHandler;
 import com.microsoft.graph.core.requests.options.GraphClientOption;
+import com.microsoft.kiota.authentication.BaseBearerTokenAuthenticationProvider;
 import com.microsoft.kiota.http.KiotaClientFactory;
+import com.microsoft.kiota.http.middleware.AuthorizationHandler;
 import com.microsoft.kiota.http.middleware.UrlReplaceHandler;
 import com.microsoft.kiota.http.middleware.options.UrlReplaceHandlerOption;
 import okhttp3.Interceptor;
@@ -37,6 +39,33 @@ public static OkHttpClient.Builder create() {
     public static OkHttpClient.Builder create(@Nonnull Interceptor... interceptors) {
         return create(new GraphClientOption(), interceptors);
     }
+
+    /**
+     * OkHttpClient Builder for Graph with specified Interceptors
+     * @param interceptors desired interceptors for use in requests.
+     * @return an OkHttpClient Builder instance.
+     */
+    @Nonnull
+    public static OkHttpClient.Builder create(@Nonnull List<Interceptor> interceptors) {
+        return create(new GraphClientOption(), interceptors.toArray(new Interceptor[0]));
+    }
+
+    /**
+     * OkHttpClient Builder for Graph with specified AuthenticationProvider.
+     * Adds an AuthorizationHandler to the OkHttpClient Builder.
+     * @param authenticationProvider the AuthenticationProvider to use for requests.
+     * @return an OkHttpClient Builder instance.
+     */
+    @Nonnull
+    public static OkHttpClient.Builder create(@Nonnull BaseBearerTokenAuthenticationProvider authenticationProvider) {
+        final GraphClientOption graphClientOption = new GraphClientOption();
+        final Interceptor[] interceptors = createDefaultGraphInterceptors(graphClientOption);
+        final ArrayList<Interceptor> interceptorList = new ArrayList<>(Arrays.asList(interceptors));
+        interceptorList.add(new AuthorizationHandler(authenticationProvider));
+        graphClientOption.featureTracker.setFeatureUsage(FeatureFlag.AUTH_HANDLER_FLAG);
+        return create(graphClientOption, interceptorList);
+    }
+
     /**
      * OkHttpClient Builder for Graph with specified Interceptors and GraphClientOption.
      *
@@ -60,6 +89,18 @@ public static OkHttpClient.Builder create(@Nonnull GraphClientOption graphClient
         }
         return builder;
     }
+
+    /**
+     * OkHttpClient Builder for Graph with specified Interceptors and GraphClientOption.
+     * @param graphClientOption the GraphClientOption for use in requests.
+     * @param interceptors desired interceptors for use in requests.
+     * @return an OkHttpClient Builder instance.
+     */
+    @Nonnull
+    public static OkHttpClient.Builder create(@Nonnull GraphClientOption graphClientOption, @Nonnull List<Interceptor> interceptors) {
+        return create(graphClientOption, interceptors.toArray(new Interceptor[0]));
+    }
+
     /**
      * The OkHttpClient Builder with optional GraphClientOption
      *
@@ -92,6 +133,5 @@ private static void addDefaultFeatureUsages(GraphClientOption graphClientOption)
         graphClientOption.featureTracker.setFeatureUsage(FeatureFlag.RETRY_HANDLER_FLAG);
         graphClientOption.featureTracker.setFeatureUsage(FeatureFlag.REDIRECT_HANDLER_FLAG);
         graphClientOption.featureTracker.setFeatureUsage(FeatureFlag.URL_REPLACEMENT_FLAG);
-        graphClientOption.featureTracker.setFeatureUsage(FeatureFlag.BATCH_REQUEST_FLAG);
     }
 }

src/test/java/com/microsoft/graph/core/requests/GraphClientFactoryTest.java

@@ -0,0 +1,56 @@
+package com.microsoft.graph.core.requests;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyMap;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import java.io.IOException;
+import java.net.URI;
+
+import org.junit.jupiter.api.Test;
+
+import com.microsoft.graph.core.authentication.AzureIdentityAccessTokenProvider;
+import com.microsoft.graph.core.authentication.AzureIdentityAuthenticationProvider;
+import com.microsoft.kiota.authentication.AccessTokenProvider;
+import com.microsoft.kiota.authentication.AllowedHostsValidator;
+import com.microsoft.kiota.authentication.BaseBearerTokenAuthenticationProvider;
+
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.Response;
+
+class GraphClientFactoryTest {
+
+    private static final String ACCESS_TOKEN_STRING = "token";
+
+    @Test
+    void testCreateWithAuthenticationProvider() throws IOException {
+        final BaseBearerTokenAuthenticationProvider mockAuthenticationProvider =
+                getMockAuthenticationProvider();
+        OkHttpClient graphClient = GraphClientFactory.create(mockAuthenticationProvider).addInterceptor(new MockResponseHandler()).build();
+
+        Request request = new Request.Builder().url("https://graph.microsoft.com/v1.0/me").build();
+        Response response = graphClient.newCall(request).execute();
+
+        assertEquals(200, response.code());
+        assertNotNull(response.request());
+        assertTrue(response.request().headers().names().contains("Authorization"));
+        assertEquals("Bearer " + ACCESS_TOKEN_STRING, response.request().header("Authorization"));
+    }
+
+    private static BaseBearerTokenAuthenticationProvider getMockAuthenticationProvider() {
+        final AccessTokenProvider mockAccessTokenProvider = mock(AzureIdentityAccessTokenProvider.class);
+        when(mockAccessTokenProvider.getAuthorizationToken(any(URI.class), anyMap()))
+                .thenReturn(ACCESS_TOKEN_STRING);
+        when(mockAccessTokenProvider.getAllowedHostsValidator()).thenReturn(new AllowedHostsValidator("graph.microsoft.com"));
+        final AzureIdentityAuthenticationProvider mockAuthenticationProvider =
+                mock(AzureIdentityAuthenticationProvider.class);
+        when(mockAuthenticationProvider.getAccessTokenProvider())
+                .thenReturn(mockAccessTokenProvider);
+        return mockAuthenticationProvider;
+    }
+}

src/test/java/com/microsoft/graph/core/requests/MockResponseHandler.java

@@ -0,0 +1,50 @@
+package com.microsoft.graph.core.requests;
+
+import java.io.IOException;
+
+import okhttp3.Interceptor;
+import okhttp3.MediaType;
+import okhttp3.Protocol;
+import okhttp3.Response;
+import okhttp3.ResponseBody;
+import okio.Buffer;
+
+class MockResponseHandler implements Interceptor {
+
+    private int statusCode;
+
+    public MockResponseHandler(int statusCode) {
+        this.statusCode = statusCode;
+    }
+
+    public MockResponseHandler() {
+        this.statusCode = 200;
+    }
+
+    @Override
+    public Response intercept(Chain chain) throws IOException {
+        final var request = chain.request();
+        final var requestBody = request.body();
+        if (request != null && requestBody != null) {
+            final var buffer = new Buffer();
+            requestBody.writeTo(buffer);
+            return new Response.Builder()
+                    .code(this.statusCode)
+                    .message("OK")
+                    .protocol(Protocol.HTTP_1_1)
+                    .request(request)
+                    .body(
+                            ResponseBody.create(
+                                    buffer.readByteArray(), MediaType.parse("application/json")))
+                    .build();
+        }
+        return new Response.Builder()
+                .code(this.statusCode)
+                .message("OK")
+                .protocol(Protocol.HTTP_1_1)
+                .request(request)
+                .body(ResponseBody.create("", MediaType.parse("application/json")))
+                .build();
+    }
+
+}