[Communication]: Rename ConnectionString and move it to implementation (Azure#18794)

* Rename ConnectionString and move it to implementation

* Move HmacAuthenticationPolicy to implementation

* Rename token to initialToken

* Address review comments

* Remove CommunicationClientCredential

* Tidy up code styling

* Minor code style change

* IdentifierSerializer should throw when Id is null for TeamsUserIdentifier

* Update a javadoc to explain getId

* Make require core transitive in administration module

* Serializer should not throw for future kind

* Update sdk/communication/azure-communication-common/src/main/java/com/azure/communication/common/CommunicationIdentifierSerializer.java

Co-authored-by: Dominik <domessin@microsoft.com>

* Delete extra throws phrase

Co-authored-by: JP Chen <jiach@microsoft.com>
Co-authored-by: Dominik <domessin@microsoft.com>

Author: 3 people

eng/code-quality-reports/src/main/resources/checkstyle/checkstyle-suppressions.xml

@@ -393,6 +393,8 @@ the main ServiceBusClientBuilder. -->
   <suppress checks="com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck" files="com.azure.communication.chat.implementation.AzureCommunicationChatServiceImpl.java"/>
   <!-- Checkstyle suppressions for the auto generated Phone Number Administration Implementation -->
   <suppress checks="LineLength" files="com.azure.communication.administration.implementation.PhoneNumberAdministrationsImpl.java"/>
+  <suppress checks="com.azure.tools.checkstyle.checks.HttpPipelinePolicyCheck"
+            files="com.azure.communication.common.implementation.HmacAuthenticationPolicy.java"/>
   <suppress checks="[a-zA-Z0-9]*" files="com.azure.data.schemaregistry.implementation.*"/>
 
   <!-- Suppress the check on synapse code-gen classes -->

sdk/communication/azure-communication-administration/src/main/java/com/azure/communication/administration/CommunicationIdentityClientBuilder.java

@@ -3,13 +3,13 @@
 
 package com.azure.communication.administration;
 
-import com.azure.communication.common.CommunicationClientCredential;
-import com.azure.communication.common.ConnectionString;
-import com.azure.communication.common.HmacAuthenticationPolicy;
+import com.azure.communication.common.implementation.CommunicationConnectionString;
+import com.azure.communication.common.implementation.HmacAuthenticationPolicy;
 import com.azure.communication.administration.implementation.CommunicationIdentityClientImpl;
 import com.azure.communication.administration.implementation.CommunicationIdentityClientImplBuilder;
 import com.azure.core.annotation.ServiceClientBuilder;
 import com.azure.core.credential.TokenCredential;
+import com.azure.core.credential.AzureKeyCredential;
 import com.azure.core.http.HttpClient;
 import com.azure.core.http.HttpPipeline;
 import com.azure.core.http.HttpPipelineBuilder;
@@ -36,18 +36,18 @@
 public final class CommunicationIdentityClientBuilder {
     private static final String SDK_NAME = "name";
     private static final String SDK_VERSION = "version";
-    private static final String COMMUNICATION_ADMINISTRATION_PROPERTIES = 
+    private static final String COMMUNICATION_ADMINISTRATION_PROPERTIES =
         "azure-communication-administration.properties";
 
     private final ClientLogger logger = new ClientLogger(CommunicationIdentityClientBuilder.class);
     private String endpoint;
-    private CommunicationClientCredential accessKeyCredential;
+    private AzureKeyCredential azureKeyCredential;
     private TokenCredential tokenCredential;
     private HttpClient httpClient;
     private HttpLogOptions httpLogOptions = new HttpLogOptions();
     private HttpPipeline pipeline;
-    private Configuration configuration;    
-    private final Map<String, String> properties = CoreUtils.getProperties(COMMUNICATION_ADMINISTRATION_PROPERTIES);    
+    private Configuration configuration;
+    private final Map<String, String> properties = CoreUtils.getProperties(COMMUNICATION_ADMINISTRATION_PROPERTIES);
     private final List<HttpPipelinePolicy> customPolicies = new ArrayList<HttpPipelinePolicy>();
 
     /**
@@ -93,7 +93,7 @@ public CommunicationIdentityClientBuilder credential(TokenCredential tokenCreden
      */
     public CommunicationIdentityClientBuilder accessKey(String accessKey) {
         Objects.requireNonNull(accessKey, "'accessKey' cannot be null.");
-        this.accessKeyCredential = new CommunicationClientCredential(accessKey);
+        this.azureKeyCredential = new AzureKeyCredential(accessKey);
         return this;
     }
 
@@ -105,7 +105,7 @@ public CommunicationIdentityClientBuilder accessKey(String accessKey) {
      */
     public CommunicationIdentityClientBuilder connectionString(String connectionString) {
         Objects.requireNonNull(connectionString, "'connectionString' cannot be null.");
-        ConnectionString connectionStringObject = new ConnectionString(connectionString);
+        CommunicationConnectionString connectionStringObject = new CommunicationConnectionString(connectionString);
         String endpoint = connectionStringObject.getEndpoint();
         String accessKey = connectionStringObject.getAccessKey();
         this
@@ -129,7 +129,7 @@ public CommunicationIdentityClientBuilder httpClient(HttpClient httpClient) {
     /**
      * Apply additional HttpPipelinePolicy
      *
-     * @param customPolicy HttpPipelinePolicy object to be applied after 
+     * @param customPolicy HttpPipelinePolicy object to be applied after
      * AzureKeyCredentialPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy
      * @return CommunicationIdentityClientBuilder
      */
@@ -203,28 +203,28 @@ private CommunicationIdentityClientImpl createServiceImpl() {
 
         HttpPipeline builderPipeline = this.pipeline;
         if (this.pipeline == null) {
-            builderPipeline = createHttpPipeline(httpClient, 
-                createHttpPipelineAuthPolicy(), 
+            builderPipeline = createHttpPipeline(httpClient,
+                createHttpPipelineAuthPolicy(),
                 customPolicies);
         }
 
         CommunicationIdentityClientImplBuilder clientBuilder = new CommunicationIdentityClientImplBuilder();
         clientBuilder.endpoint(endpoint)
             .pipeline(builderPipeline);
-        
+
         return clientBuilder.buildClient();
     }
 
     private HttpPipelinePolicy createHttpPipelineAuthPolicy() {
-        if (this.tokenCredential != null && this.accessKeyCredential != null) {
+        if (this.tokenCredential != null && this.azureKeyCredential != null) {
             throw logger.logExceptionAsError(
                 new IllegalArgumentException("Both 'credential' and 'accessKey' are set. Just one may be used."));
         }
-        if (this.tokenCredential != null) { 
+        if (this.tokenCredential != null) {
             return new BearerTokenAuthenticationPolicy(
-                this.tokenCredential, "https://communication.azure.com//.default");          
-        } else if (this.accessKeyCredential != null) {
-            return new HmacAuthenticationPolicy(this.accessKeyCredential);            
+                this.tokenCredential, "https://communication.azure.com//.default");
+        } else if (this.azureKeyCredential != null) {
+            return new HmacAuthenticationPolicy(this.azureKeyCredential);
         } else {
             throw logger.logExceptionAsError(
                 new IllegalArgumentException("Missing credential information while building a client."));
@@ -257,5 +257,5 @@ private void applyRequiredPolicies(List<HttpPipelinePolicy> policies) {
         policies.add(new RetryPolicy());
         policies.add(new CookiePolicy());
         policies.add(new HttpLoggingPolicy(httpLogOptions));
-    }  
+    }
 }

sdk/communication/azure-communication-administration/src/main/java/com/azure/communication/administration/PhoneNumberClientBuilder.java

@@ -4,10 +4,10 @@
 
 import com.azure.communication.administration.implementation.PhoneNumberAdminClientImpl;
 import com.azure.communication.administration.implementation.PhoneNumberAdminClientImplBuilder;
-import com.azure.communication.common.CommunicationClientCredential;
-import com.azure.communication.common.ConnectionString;
-import com.azure.communication.common.HmacAuthenticationPolicy;
+import com.azure.communication.common.implementation.CommunicationConnectionString;
+import com.azure.communication.common.implementation.HmacAuthenticationPolicy;
 import com.azure.core.annotation.ServiceClientBuilder;
+import com.azure.core.credential.AzureKeyCredential;
 import com.azure.core.credential.TokenCredential;
 import com.azure.core.http.HttpClient;
 import com.azure.core.http.HttpPipeline;
@@ -46,7 +46,7 @@ public final class PhoneNumberClientBuilder {
     private HttpPipeline pipeline;
     private HttpClient httpClient;
     private HttpLogOptions httpLogOptions;
-    private CommunicationClientCredential accessKeyCredential;
+    private AzureKeyCredential azureKeyCredential;
     private TokenCredential tokenCredential;
     private Configuration configuration;
     private final List<HttpPipelinePolicy> additionalPolicies = new ArrayList<>();
@@ -103,15 +103,15 @@ public PhoneNumberClientBuilder httpLogOptions(HttpLogOptions httpLogOptions) {
     }
 
     /**
-     * Set CommunicationClientCredential for authorization
+     * Set AzureKeyCredential for authorization
      *
-     * @param accessKey access key for initalizing CommunicationClientCredential
+     * @param accessKey access key for initalizing AzureKeyCredential
      * @return The updated {@link PhoneNumberClientBuilder} object.
      * @throws NullPointerException If {@code accessKey} is {@code null}.
      */
     public PhoneNumberClientBuilder accessKey(String accessKey) {
         Objects.requireNonNull(accessKey, "'accessKey' cannot be null.");
-        this.accessKeyCredential = new CommunicationClientCredential(accessKey);
+        this.azureKeyCredential = new AzureKeyCredential(accessKey);
         return this;
     }
 
@@ -129,15 +129,15 @@ public PhoneNumberClientBuilder credential(TokenCredential tokenCredential) {
 
 
     /**
-     * Set the endpoint and CommunicationClientCredential for authorization
+     * Set the endpoint and AzureKeyCredential for authorization
      *
-     * @param connectionString connection string for setting endpoint and initalizing CommunicationClientCredential
+     * @param connectionString connection string for setting endpoint and initalizing AzureKeyCredential
      * @return The updated {@link PhoneNumberClientBuilder} object.
      * @throws NullPointerException If {@code connectionString} is {@code null}.
      */
     public PhoneNumberClientBuilder connectionString(String connectionString) {
         Objects.requireNonNull(connectionString, "'connectionString' cannot be null.");
-        ConnectionString connectionStringObject = new ConnectionString(connectionString);
+        CommunicationConnectionString connectionStringObject = new CommunicationConnectionString(connectionString);
         String endpoint = connectionStringObject.getEndpoint();
         String accessKey = connectionStringObject.getAccessKey();
         this
@@ -217,15 +217,15 @@ PhoneNumberAsyncClient createPhoneNumberAsyncClient(PhoneNumberAdminClientImpl p
     }
 
     HttpPipelinePolicy createAuthenticationPolicy() {
-        if (this.tokenCredential != null && this.accessKeyCredential != null) {
+        if (this.tokenCredential != null && this.azureKeyCredential != null) {
             throw logger.logExceptionAsError(
                 new IllegalArgumentException("Both 'credential' and 'accessKey' are set. Just one may be used."));
         }
-        if (this.tokenCredential != null) { 
+        if (this.tokenCredential != null) {
             return new BearerTokenAuthenticationPolicy(
-                this.tokenCredential, "https://communication.azure.com//.default");          
-        } else if (this.accessKeyCredential != null) {
-            return new HmacAuthenticationPolicy(this.accessKeyCredential);            
+                this.tokenCredential, "https://communication.azure.com//.default");
+        } else if (this.azureKeyCredential != null) {
+            return new HmacAuthenticationPolicy(this.azureKeyCredential);
         } else {
             throw logger.logExceptionAsError(
                 new NullPointerException("Missing credential information while building a client."));

sdk/communication/azure-communication-administration/src/main/java/module-info.java

@@ -4,6 +4,7 @@
 module com.azure.communication.administration {
 
     requires transitive com.azure.communication.common;
+    requires transitive com.azure.core;
 
     // public API surface area
     exports com.azure.communication.administration;

sdk/communication/azure-communication-administration/src/test/java/com/azure/communication/administration/PhoneNumberClientBuilderTest.java

@@ -3,7 +3,7 @@
 package com.azure.communication.administration;
 
 import com.azure.communication.administration.implementation.PhoneNumberAdminClientImpl;
-import com.azure.communication.common.HmacAuthenticationPolicy;
+import com.azure.communication.common.implementation.HmacAuthenticationPolicy;
 import com.azure.core.http.HttpClient;
 import com.azure.core.http.HttpPipeline;
 import com.azure.core.http.policy.*;

sdk/communication/azure-communication-administration/src/test/java/com/azure/communication/administration/PhoneNumberIntegrationTestBase.java

@@ -10,7 +10,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import com.azure.communication.common.ConnectionString;
+import com.azure.communication.common.implementation.CommunicationConnectionString;
 import com.azure.core.credential.AccessToken;
 import com.azure.core.credential.TokenCredential;
 import com.azure.core.credential.TokenRequestContext;
@@ -30,11 +30,11 @@ public class PhoneNumberIntegrationTestBase extends TestBase {
         Configuration.getGlobalConfiguration().get("COMMUNICATION_SERVICE_ENDPOINT", "https://REDACTED.communication.azure.com");
     private static final String CONNECTION_STRING = Configuration.getGlobalConfiguration()
         .get("COMMUNICATION_LIVETEST_CONNECTION_STRING", "endpoint=https://REDACTED.communication.azure.com/;accesskey=QWNjZXNzS2V5");
-    
-    protected static final String PHONE_NUMBER = 
+
+    protected static final String PHONE_NUMBER =
         Configuration.getGlobalConfiguration().get("COMMUNICATION_PHONE_NUMBER", "+11234567891");
     protected static final String COUNTRY_CODE =
-        Configuration.getGlobalConfiguration().get("COUNTRY_CODE", "US");   
+        Configuration.getGlobalConfiguration().get("COUNTRY_CODE", "US");
     protected static final String AREA_CODE =
         Configuration.getGlobalConfiguration().get("AREA_CODE", "619");
     protected static final String LOCALE =
@@ -93,16 +93,16 @@ protected PhoneNumberClientBuilder getClientBuilderWithConnectionString(HttpClie
             redactors.add(data -> redact(data, JSON_PROPERTY_VALUE_REDACTION_PATTERN.matcher(data), "REDACTED"));
             builder.addPolicy(interceptorManager.getRecordPolicy(redactors));
         }
-        
+
         return builder;
     }
 
     protected PhoneNumberClientBuilder getClientBuilderUsingManagedIdentity(HttpClient httpClient) {
         PhoneNumberClientBuilder builder = new PhoneNumberClientBuilder();
         builder
-            .endpoint(new ConnectionString(CONNECTION_STRING).getEndpoint())
+            .endpoint(new CommunicationConnectionString(CONNECTION_STRING).getEndpoint())
             .httpClient(httpClient == null ? interceptorManager.getPlaybackClient() : httpClient);
-        
+
         if (getTestMode() == TestMode.PLAYBACK) {
             builder.credential(new FakeCredentials());
         } else {

sdk/communication/azure-communication-common/src/main/java/com/azure/communication/common/CommunicationIdentifier.java

@@ -7,8 +7,8 @@
  */
 public abstract class CommunicationIdentifier {
     /**
-     * Get string representation of the identifier
-     * @return string representation of the identifier
+     * Get full id of the identifier
+     * @return full id of the identifier
      */
     public abstract String getId();
 

sdk/communication/azure-communication-common/src/main/java/com/azure/communication/common/CommunicationIdentifierSerializer.java

@@ -6,7 +6,13 @@
 import java.util.Objects;
 
 class CommunicationIdentifierSerializer {
+    /**
+     * Deserialize CommunicationIdentifierModel into CommunicationIdentifier
+     * @param identifier CommunicationIdentifierModel to be deserialized
+     * @return deserialized CommunicationIdentifier
+     */
     public static CommunicationIdentifier deserialize(CommunicationIdentifierModel identifier) {
+
         String id = identifier.getId();
         CommunicationIdentifierKind kind = identifier.getKind();
 
@@ -29,6 +35,7 @@ public static CommunicationIdentifier deserialize(CommunicationIdentifierModel i
         if (kind == CommunicationIdentifierKind.MICROSOFT_TEAMS_USER) {
             Objects.requireNonNull(identifier.getMicrosoftTeamsUserId());
             Objects.requireNonNull(identifier.getCloudEnvironmentModel());
+            Objects.requireNonNull(identifier.getId());
             return new MicrosoftTeamsUserIdentifier(identifier.getMicrosoftTeamsUserId(), identifier.isAnonymous())
                 .setId(identifier.getId())
                 .setCloudEnvironment(CommunicationCloudEnvironment.fromModel(identifier.getCloudEnvironmentModel()));
@@ -38,7 +45,15 @@ public static CommunicationIdentifier deserialize(CommunicationIdentifierModel i
         return new UnknownIdentifier(id);
     }
 
-    public static CommunicationIdentifierModel serialize(CommunicationIdentifier identifier) {
+    /**
+     * Serialize CommunicationIdentifier into CommunicationIdentifierModel
+     * @param identifier CommunicationIdentifier object to be serialized
+     * @return CommunicationIdentifierModel
+     * @throws IllegalArgumentException when identifier is an unknown class derived from
+     *          CommunicationIdentifier
+     */
+    public static CommunicationIdentifierModel serialize(CommunicationIdentifier identifier)
+        throws IllegalArgumentException {
         if (identifier instanceof CommunicationUserIdentifier) {
             return new CommunicationIdentifierModel()
                 .setKind(CommunicationIdentifierKind.COMMUNICATION_USER)
@@ -68,8 +83,12 @@ public static CommunicationIdentifierModel serialize(CommunicationIdentifier ide
                 .setCloudEnvironmentModel(new CommunicationCloudEnvironmentModel(teamsUserIdentifier.getCloudEnvironment().toString()));
         }
 
-        return new CommunicationIdentifierModel()
-            .setKind(CommunicationIdentifierKind.UNKNOWN)
-            .setId(((UnknownIdentifier) identifier).getId());
+        if (identifier instanceof UnknownIdentifier) {
+            return new CommunicationIdentifierModel()
+                .setKind(CommunicationIdentifierKind.UNKNOWN)
+                .setId(((UnknownIdentifier) identifier).getId());
+        }
+
+        throw new IllegalArgumentException(String.format("Unknown identifier class '%s'", identifier.getClass().getName()));
     }
 }