Add support for TokenCredential auth in CallingServerClientBuilder (Azure#23831)

* Add support for TokenCredential auth in CallingServerClientBuilder

* Changelog update

Co-authored-by: Melissa Neubert <[email protected]>

Author: melneubert

sdk/communication/azure-communication-callingserver/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History
 
+## 1.0.0-beta.6 (Unreleased)
+### Features Added
+- Add support for TokenCredential authentication with CallingServerClientBuilder.
+
 ## 1.0.0-beta.5 (2021-08-30)
 ### Dependency updates
 - Upgraded `azure-communication-common` to 1.0.4

sdk/communication/azure-communication-callingserver/README.md

@@ -46,7 +46,7 @@ Based on if the Contoso app join a call or not, APIs can be divided into two cat
 
 
 You can provide the connection string using the connectionString() function of `CallingServerClientBuilder`. Once you initialized a `CallingServerClient` class, you can do the different server calling operations.
-<!-- embedme src/samples/java/com/azure/communication/callingserver/ReadmeSamples.java#L31-L37 -->
+<!-- embedme src/samples/java/com/azure/communication/callingserver/ReadmeSamples.java#L33-L39 -->
 ```java
 // Your connectionString retrieved from your Azure Communication Service
 String connectionString = "endpoint=https://<resource-name>.communication.azure.com/;accesskey=<access-key>";
@@ -57,10 +57,28 @@ builder.connectionString(connectionString);
 CallingServerClient callingServerClient = builder.buildClient();
 ```
 
+Alternatively, calling clients can also be authenticated using a valid token credential. With this option,
+`AZURE_CLIENT_SECRET`, `AZURE_CLIENT_ID` and `AZURE_TENANT_ID` environment variables need to be set up for authentication. 
+<!-- embedme src/samples/java/com/azure/communication/callingserver/ReadmeSample.java#L117-128 -->
+```java
+// Your endpoint retrieved from your Azure Communication Service
+String endpoint = "https://<resource-name>.communication.azure.com";
+
+// Token credential used for managed identity authentication. Depends on `AZURE_CLIENT_SECRET`,
+// `AZURE_CLIENT_ID`, and `AZURE_TENANT_ID` environment variables to be set up.
+TokenCredential tokenCredential = new DefaultAzureCredentialBuilder().build();
+
+// Initialize the calling server client
+CallingServerClient callingServerClient  = new CallingServerClientBuilder()
+    .endpoint(endpoint)
+    .credential(tokenCredential)
+    .buildClient();
+```
+
 ### Create call, Add participant and Hangup a call
 
 #### Create a Call: 
-<!-- embedme src/samples/java/com/azure/communication/callingserver/ReadmeSamples.java#L49-L68 -->
+<!-- embedme src/samples/java/com/azure/communication/callingserver/ReadmeSamples.java#L51-L70 -->
 ```java
 CommunicationIdentifier source = new CommunicationUserIdentifier("<acs-user-identity>");
 CommunicationIdentifier firstCallee = new CommunicationUserIdentifier("<acs-user-identity-1>");
@@ -85,22 +103,22 @@ CallConnection callConnection = callingServerClient.createCallConnection(source,
 ```
 
 #### Add a participant to a Call:
-<!-- embedme src/samples/java/com/azure/communication/callingserver/ReadmeSamples.java#L88-L89 -->
+<!-- embedme src/samples/java/com/azure/communication/callingserver/ReadmeSamples.java#L90-L91 -->
 ```java
 CommunicationIdentifier thirdCallee = new CommunicationUserIdentifier("<acs-user-identity-3>");
 callConnection.addParticipant(thirdCallee, "ACS User 3", "<string-for-tracing-responses>");
 ```
 
 #### Hangup a Call:
-<!-- embedme src/samples/java/com/azure/communication/callingserver/ReadmeSamples.java#L78-L78 -->
+<!-- embedme src/samples/java/com/azure/communication/callingserver/ReadmeSamples.java#L80-L80 -->
 ```java
 callConnection.hangup();
 ```
 
 ### Start, Pause, Resume, Stop and Get a recording
 
 #### Start a Recording: 
-<!-- embedme src/samples/java/com/azure/communication/callingserver/ConversationClientReadmeSamples.java#L47-L51 -->
+<!-- embedme src/samples/java/com/azure/communication/callingserver/ConversationClientReadmeSamples.java#L49-L53 -->
 ```java
 String serverCallId = "<serverCallId received from starting call>";
 String recordingStateCallbackUri = "<webhook endpoint to which calling service can report status>";
@@ -110,31 +128,31 @@ String recordingId = response.getRecordingId();
 ```
 
 #### Pause a Recording: 
-<!-- embedme src/samples/java/com/azure/communication/callingserver/ConversationClientReadmeSamples.java#L65-L65 -->
+<!-- embedme src/samples/java/com/azure/communication/callingserver/ConversationClientReadmeSamples.java#L67-L67 -->
 ```java
 serverCall.pauseRecording(recordingId);
 ```
 
 #### Resume a Recording: 
-<!-- embedme src/samples/java/com/azure/communication/callingserver/ConversationClientReadmeSamples.java#L78-L78 -->
+<!-- embedme src/samples/java/com/azure/communication/callingserver/ConversationClientReadmeSamples.java#L80-L80 -->
 ```java
 serverCall.resumeRecording(recordingId);
 ```
 
 #### Stop a Recording: 
-<!-- embedme src/samples/java/com/azure/communication/callingserver/ConversationClientReadmeSamples.java#L91-L91 -->
+<!-- embedme src/samples/java/com/azure/communication/callingserver/ConversationClientReadmeSamples.java#L93-L93 -->
 ```java
 serverCall.stopRecording(recordingId);
 ```
 
 #### Get the Recording State: 
-<!-- embedme src/samples/java/com/azure/communication/callingserver/ConversationClientReadmeSamples.java#L105-L105 -->
+<!-- embedme src/samples/java/com/azure/communication/callingserver/ConversationClientReadmeSamples.java#L107-L107 -->
 ```java
 CallRecordingStateResult callRecordingStateResult = serverCall.getRecordingState(recordingId);
 ```
 
 #### Download a Recording into a file:
-<!-- embedme src/samples/java/com/azure/communication/callingserver/ReadmeSamples.java#L100-L100 -->
+<!-- embedme src/samples/java/com/azure/communication/callingserver/ReadmeSamples.java#L102-L102 -->
 ```java
 callingServerClient.downloadTo(
             recordingUrl,
@@ -146,7 +164,7 @@ callingServerClient.downloadTo(
 ### Play Audio in Call
 
 #### Play Audio: 
-<!-- embedme src/samples/java/com/azure/communication/callingserver/ConversationClientReadmeSamples.java#L122-L127 -->
+<!-- embedme src/samples/java/com/azure/communication/callingserver/ConversationClientReadmeSamples.java#L124-L129 -->
 ```java
 String audioFileUri = "<uri of the file to play>";
 String audioFileId = "<a name to use for caching the audio file>";

sdk/communication/azure-communication-callingserver/src/main/java/com/azure/communication/callingserver/CallingServerClientBuilder.java

@@ -91,7 +91,7 @@ public CallingServerClientBuilder pipeline(HttpPipeline pipeline) {
      * @return Updated {@link CallingServerClientBuilder} object.
      * @throws NullPointerException If {@code tokenCredential} is null.
      */
-    CallingServerClientBuilder credential(TokenCredential tokenCredential) {
+    public CallingServerClientBuilder credential(TokenCredential tokenCredential) {
         this.tokenCredential = Objects.requireNonNull(tokenCredential, "'tokenCredential' cannot be null.");
         return this;
     }

sdk/communication/azure-communication-callingserver/src/samples/java/com/azure/communication/callingserver/ReadmeSamples.java

@@ -8,6 +8,8 @@
 import com.azure.communication.callingserver.models.MediaType;
 import com.azure.communication.common.CommunicationIdentifier;
 import com.azure.communication.common.CommunicationUserIdentifier;
+import com.azure.core.credential.TokenCredential;
+import com.azure.identity.DefaultAzureCredentialBuilder;
 
 import java.nio.file.Paths;
 import java.util.Arrays;
@@ -104,4 +106,26 @@ public void getRecordingStream() {
             true
         );
     }
+
+    /**
+     * Sample code for creating async calling server client with token credential.
+     *
+     * @return the calling server client.
+     */
+    public CallingServerClient createCallingServerClientWithTokenCredential() {
+        // Your endpoint retrieved from your Azure Communication Service
+        String endpoint = "https://<resource-name>.communication.azure.com";
+
+        // Token credential used for managed identity authentication. Depends on `AZURE_CLIENT_SECRET`,
+        // `AZURE_CLIENT_ID`, and `AZURE_TENANT_ID` environment variables to be set up.
+        TokenCredential tokenCredential = new DefaultAzureCredentialBuilder().build();
+
+        // Initialize the calling server client
+        CallingServerClient callingServerClient  = new CallingServerClientBuilder()
+            .endpoint(endpoint)
+            .credential(tokenCredential)
+            .buildClient();
+
+        return callingServerClient;
+    }
 }

sdk/communication/azure-communication-callingserver/src/test/java/com/azure/communication/callingserver/CallConnectionAsyncLiveTests.java

@@ -34,7 +34,7 @@ public class CallConnectionAsyncLiveTests extends CallingServerTestBase {
         matches = "(?i)(true)",
         disabledReason = "Requires human intervention")
     public void runCreatePlayCancelHangupScenarioAsync(HttpClient httpClient) {
-        CallingServerClientBuilder builder = getCallClientUsingConnectionString(httpClient);
+        CallingServerClientBuilder builder = getCallingServerClientUsingConnectionString(httpClient);
         CallingServerAsyncClient callingServerAsyncClient =
             setupAsyncClient(builder, "runCreatePlayCancelHangupScenarioAsync");
 
@@ -86,7 +86,7 @@ public void runCreatePlayCancelHangupScenarioAsync(HttpClient httpClient) {
         matches = "(?i)(true)",
         disabledReason = "Requires human intervention")
     public void runCreatePlayCancelHangupScenarioWithResponseAsync(HttpClient httpClient) {
-        CallingServerClientBuilder builder = getCallClientUsingConnectionString(httpClient);
+        CallingServerClientBuilder builder = getCallingServerClientUsingConnectionString(httpClient);
         CallingServerAsyncClient callingServerAsyncClient =
             setupAsyncClient(builder, "runCreatePlayCancelHangupScenarioWithResponseAsync");
 
@@ -143,7 +143,7 @@ public void runCreatePlayCancelHangupScenarioWithResponseAsync(HttpClient httpCl
         matches = "(?i)(true)",
         disabledReason = "Requires human intervention")
     public void runCreateAddRemoveHangupScenarioAsync(HttpClient httpClient) {
-        CallingServerClientBuilder builder = getCallClientUsingConnectionString(httpClient);
+        CallingServerClientBuilder builder = getCallingServerClientUsingConnectionString(httpClient);
         CallingServerAsyncClient callingServerAsyncClient =
             setupAsyncClient(builder, "runCreateAddRemoveHangupScenarioAsync");
 
@@ -190,7 +190,7 @@ public void runCreateAddRemoveHangupScenarioAsync(HttpClient httpClient) {
         matches = "(?i)(true)",
         disabledReason = "Requires human intervention")
     public void runCreateAddRemoveHangupScenarioWithResponseAsync(HttpClient httpClient) {
-        CallingServerClientBuilder builder = getCallClientUsingConnectionString(httpClient);
+        CallingServerClientBuilder builder = getCallingServerClientUsingConnectionString(httpClient);
         CallingServerAsyncClient callingServerAsyncClient =
             setupAsyncClient(builder, "runCreateAddRemoveHangupScenarioWithResponseAsync");
 
@@ -243,11 +243,27 @@ public void runCreateAddRemoveHangupScenarioWithResponseAsync(HttpClient httpCli
         named = "SKIP_LIVE_TEST",
         matches = "(?i)(true)",
         disabledReason = "Requires human intervention")
-    public void runCreateJoinHangupScenarioAsync(HttpClient httpClient) {
-        CallingServerClientBuilder builder = getCallClientUsingConnectionString(httpClient);
+    public void runCreateJoinHangupScenarioWithConnectionStringAsyncClient(HttpClient httpClient) {
+        CallingServerClientBuilder builder = getCallingServerClientUsingConnectionString(httpClient);
         CallingServerAsyncClient callingServerAsyncClient =
-            setupAsyncClient(builder, "runCreateJoinHangupScenarioAsync");
+            setupAsyncClient(builder, "runCreateJoinHangupScenarioWithConnectionStringAsyncClient");
+        runCreateJoinHangupScenarioAsync(callingServerAsyncClient);
+    }
+
+    @ParameterizedTest
+    @MethodSource("com.azure.core.test.TestBase#getHttpClients")
+    @DisabledIfEnvironmentVariable(
+        named = "SKIP_LIVE_TEST",
+        matches = "(?i)(true)",
+        disabledReason = "Requires human intervention")
+    public void runCreateJoinHangupScenarioWithTokenCredentialAsyncClient(HttpClient httpClient) {
+        CallingServerClientBuilder builder = getCallingServerClientUsingTokenCredential(httpClient);
+        CallingServerAsyncClient callingServerAsyncClient =
+            setupAsyncClient(builder, "runCreateJoinHangupScenarioWithTokenCredentialAsyncClient");
+        runCreateJoinHangupScenarioAsync(callingServerAsyncClient);
+    }
 
+    private void runCreateJoinHangupScenarioAsync(CallingServerAsyncClient callingServerAsyncClient) {
         try {
             // Establish a call
             CreateCallOptions options = new CreateCallOptions(
@@ -299,7 +315,7 @@ public void runCreateJoinHangupScenarioAsync(HttpClient httpClient) {
         matches = "(?i)(true)",
         disabledReason = "Requires human intervention")
     public void runCreateJoinHangupScenarioWithResponseAsync(HttpClient httpClient) {
-        CallingServerClientBuilder builder = getCallClientUsingConnectionString(httpClient);
+        CallingServerClientBuilder builder = getCallingServerClientUsingConnectionString(httpClient);
         CallingServerAsyncClient callingServerAsyncClient =
             setupAsyncClient(builder, "runCreateJoinHangupScenarioWithResponseAsync");
 

sdk/communication/azure-communication-callingserver/src/test/java/com/azure/communication/callingserver/CallConnectionLiveTests.java

@@ -33,7 +33,7 @@ public class CallConnectionLiveTests extends CallingServerTestBase {
         matches = "(?i)(true)",
         disabledReason = "Requires human intervention")
     public void runCreatePlayCancelHangupScenario(HttpClient httpClient) {
-        CallingServerClientBuilder builder = getCallClientUsingConnectionString(httpClient);
+        CallingServerClientBuilder builder = getCallingServerClientUsingConnectionString(httpClient);
         CallingServerClient callingServerClient = setupClient(builder, "runCreatePlayCancelHangupScenario");
 
         try {
@@ -83,7 +83,7 @@ public void runCreatePlayCancelHangupScenario(HttpClient httpClient) {
         matches = "(?i)(true)",
         disabledReason = "Requires human intervention")
     public void runCreatePlayCancelHangupScenarioWithResponse(HttpClient httpClient) {
-        CallingServerClientBuilder builder = getCallClientUsingConnectionString(httpClient);
+        CallingServerClientBuilder builder = getCallingServerClientUsingConnectionString(httpClient);
         CallingServerClient callingServerClient =
             setupClient(builder, "runCreatePlayCancelHangupScenarioWithResponse");
 
@@ -140,7 +140,7 @@ public void runCreatePlayCancelHangupScenarioWithResponse(HttpClient httpClient)
         matches = "(?i)(true)",
         disabledReason = "Requires human intervention")
     public void runCreateAddRemoveHangupScenario(HttpClient httpClient) {
-        CallingServerClientBuilder builder = getCallClientUsingConnectionString(httpClient);
+        CallingServerClientBuilder builder = getCallingServerClientUsingConnectionString(httpClient);
         CallingServerClient callingServerClient = setupClient(builder, "runCreateAddRemoveHangupScenario");
 
         try {
@@ -181,7 +181,7 @@ public void runCreateAddRemoveHangupScenario(HttpClient httpClient) {
         matches = "(?i)(true)",
         disabledReason = "Requires human intervention")
     public void runCreateAddRemoveHangupScenarioWithResponse(HttpClient httpClient) {
-        CallingServerClientBuilder builder = getCallClientUsingConnectionString(httpClient);
+        CallingServerClientBuilder builder = getCallingServerClientUsingConnectionString(httpClient);
         CallingServerClient callingServerClient =
             setupClient(builder, "runCreateAddRemoveHangupScenarioWithResponse");
 
@@ -234,9 +234,25 @@ public void runCreateAddRemoveHangupScenarioWithResponse(HttpClient httpClient)
         named = "SKIP_LIVE_TEST",
         matches = "(?i)(true)",
         disabledReason = "Requires human intervention")
-    public void runCreateJoinHangupScenario(HttpClient httpClient) {
-        CallingServerClientBuilder builder = getCallClientUsingConnectionString(httpClient);
-        CallingServerClient callingServerClient = setupClient(builder, "runCreateJoinHangupScenario");
+    public void runCreateJoinHangupScenarioWithConnectionStringClient(HttpClient httpClient) {
+        CallingServerClientBuilder builder = getCallingServerClientUsingConnectionString(httpClient);
+        CallingServerClient callingServerClient = setupClient(builder, "runCreateJoinHangupScenarioWithConnectionStringClient");
+        runCreateJoinHangupScenario(callingServerClient);
+    }
+
+    @ParameterizedTest
+    @MethodSource("com.azure.core.test.TestBase#getHttpClients")
+    @DisabledIfEnvironmentVariable(
+        named = "SKIP_LIVE_TEST",
+        matches = "(?i)(true)",
+        disabledReason = "Requires human intervention")
+    public void runCreateJoinHangupScenarioWithTokenCredentialClient(HttpClient httpClient) {
+        CallingServerClientBuilder builder = getCallingServerClientUsingTokenCredential(httpClient);
+        CallingServerClient callingServerClient = setupClient(builder, "runCreateJoinHangupScenarioWithTokenCredentialClient");
+        runCreateJoinHangupScenario(callingServerClient);
+    }
+
+    private void runCreateJoinHangupScenario(CallingServerClient callingServerClient) {
 
         try {
             // Establish a call
@@ -284,7 +300,7 @@ public void runCreateJoinHangupScenario(HttpClient httpClient) {
         matches = "(?i)(true)",
         disabledReason = "Requires human intervention")
     public void runCreateJoinHangupScenarioWithResponse(HttpClient httpClient) {
-        CallingServerClientBuilder builder = getCallClientUsingConnectionString(httpClient);
+        CallingServerClientBuilder builder = getCallingServerClientUsingConnectionString(httpClient);
         CallingServerClient callingServerClient =
             setupClient(builder, "runCreateJoinHangupScenarioWithResponse");