[Communication] - Administration - Identity API Redesign (Azure#18614)

* Initial commit

* Completing administration client APIs

* Rename identity to user

* AccessToken renane

* Add generated code from latest identity swagger

* Add java doc

* Use old types and rename accessToken to Token

* Regenerate code from latest swagger and fix all compilation errors

* Extract Identity code to its package

* Remove phone number in README.md

* Add checkstyle supression for identity package

* Remove unnecessary files

* Address PR feedback

* Address PR feedback

* Rename Identities to Identity in generated code

* Adding client implementation and async tests

* Adding Identity tests

* Adding Identity tests

* Adding all redacted tests and updated documents

* Cleanup changes

* Addresing code review comments and removing custom token class

* Fixing version

* Fix build

* Update Chat recorded tests

* Revert pom

* Fix build

* Fix tests

* scope identity package to tests for chat package

Co-authored-by: Minnie Liu <peiliu@microsoft.com>
Co-authored-by: sacheu <sacheu@microsoft.com>

Author: 3 people

eng/.docsettings.yml

@@ -127,6 +127,7 @@ known_content_issues:
   - ['sdk/communication/azure-communication-chat/swagger/README.md', '#3113']
   - ['sdk/communication/azure-communication-sms/swagger/README.md', '#3113']
   - ['sdk/communication/azure-communication-administration/swagger/README.md', '#3113']
+  - ['sdk/communication/azure-communication-identity/swagger/README.md', '#3113']
   - ['sdk/cosmos/changelog/README.md', '#3113']
   - ['sdk/cosmos/faq/README.md', '#3113']
   - ['sdk/cosmos/azure-cosmos-benchmark/README.md', '#3113']

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

@@ -396,6 +396,9 @@ the main ServiceBusClientBuilder. -->
   <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 checks="com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck" files="com.azure.communication.administration.implementation.CommunicationIdentityImpl.java"/>
+  <suppress checks="com.azure.tools.checkstyle.checks.ServiceClientCheck" files="com.azure.communication.identity.CommunicationIdentityClient.java"/>
+  <suppress checks="com.azure.tools.checkstyle.checks.ServiceClientCheck" files="com.azure.communication.identity.CommunicationIdentityAsyncClient.java"/>
 
   <!-- Suppress the check on synapse code-gen classes -->
   <suppress checks="Indentation" files="com.azure.analytics.synapse.accesscontrol.implementation..*ClientImpl" />

eng/versioning/version_client.txt

@@ -49,6 +49,7 @@ com.azure:azure-communication-chat;1.0.0-beta.3;1.0.0-beta.4
 com.azure:azure-communication-common;1.0.0-beta.3;1.0.0-beta.4
 com.azure:azure-communication-administration;1.0.0-beta.3;1.0.0-beta.4
 com.azure:azure-communication-sms;1.0.0-beta.3;1.0.0-beta.4
+com.azure:azure-communication-identity;1.0.0-beta.4;1.0.0-beta.4
 com.azure:azure-core;1.12.0;1.13.0-beta.1
 com.azure:azure-core-amqp;2.0.1;2.1.0-beta.1
 com.azure:azure-core-amqp-experimental;1.0.0-beta.1;1.0.0-beta.1

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

@@ -1,7 +1,11 @@
 # Release History
 
 ## 1.0.0-beta.4 (Unreleased)
-- Added support for Azure Active Directory Authentication for both clients.
+### Added
+- Added support for Azure Active Directory Authentication.
+
+### Breaking Changes
+- CommunicationIdentityClient and CommunicationIdentityAsyncClient is moved to a new package, `azure-communication-identity`.
 
 ## 1.0.0-beta.3 (2020-11-16)
 ### Added

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

@@ -1,6 +1,6 @@
 # Azure Communication Administration client library for Java
 
-The administration package is used for managing users and tokens for Azure Communication Services. This package also provides capabilities for Phone Number Administration.
+The administration package provides capabilities for Phone Number Administration.
 
 Acquired phone numbers can come with many capabilities, depending on the country, number type and phone plan. Examples of capabilities are SMS inbound and outbound usage, PSTN inbound and outbound usage. Phone numbers can also be assigned to a bot via a webhook URL.
 
@@ -28,69 +28,10 @@ Acquired phone numbers can come with many capabilities, depending on the country
 
 ## Key concepts
 
-There are two forms of authentication to use the Administration SDK:
 
-### Azure Active Directory Token Authentication
-A `DefaultAzureCredential` object must be passed to the `CommunicationIdentityClientBuilder` or
-`PhoneNumberClientBuilder` via the credential() funtion. Endpoint and httpClient must also be set
-via the endpoint() and httpClient() functions respectively.
-
-`AZURE_CLIENT_SECRET`, `AZURE_CLIENT_ID` and `AZURE_TENANT_ID` environment variables 
-are needed to create a DefaultAzureCredential object.
-
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L377-L389 -->
-```java
-    String endpoint = "https://<RESOURCE_NAME>.communication.azure.com";
-
-    // Create an HttpClient builder of your choice and customize it
-    HttpClient httpClient = new NettyAsyncHttpClientBuilder().build();
-
-    CommunicationIdentityClient communicationIdentityClient = new CommunicationIdentityClientBuilder()
-        .endpoint(endpoint)
-        .credential(new DefaultAzureCredentialBuilder().build())
-        .httpClient(httpClient)
-        .buildClient();
-
-    return communicationIdentityClient;
-}
-```
-
-### Access Key Authentication
-Administration uses HMAC authentication with the resource access key.
-The access key must be provided to the `CommunicationIdentityClientBuilder`
-or the `PhoneNumberClientBuilder` via the accessKey() function. Endpoint and httpClient must also be set
-via the endpoint() and httpClient() functions respectively.
-
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L37-L48 -->
-```java
-// You can find your endpoint and access key from your resource in the Azure Portal
-String endpoint = "https://<RESOURCE_NAME>.communication.azure.com";
-String accessKey = "SECRET";
-
-// Create an HttpClient builder of your choice and customize it
-HttpClient httpClient = new NettyAsyncHttpClientBuilder().build();
-
-CommunicationIdentityClient communicationIdentityClient = new CommunicationIdentityClientBuilder()
-    .endpoint(endpoint)
-    .accessKey(accessKey)
-    .httpClient(httpClient)
-    .buildClient();
-```
-
-Alternatively, you can provide the entire connection string using the connectionString() function instead of providing the endpoint and access key. 
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L62-L68 -->
-```java
-// Your can find your connection string from your resource in the Azure Portal
-String connectionString = "<connection_string>";
-
-CommunicationIdentityClient communicationIdentityClient = new CommunicationIdentityClientBuilder()
-    .connectionString(connectionString)
-    .httpClient(httpClient)
-    .buildClient();
-```
 ### Initializing Phone Number Client
-As it was mentioned before, the PhoneNumberClientBuilder is also enabled to use Azure Active Directory Authentication
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L398-L407 -->
+The PhoneNumberClientBuilder is enabled to use Azure Active Directory Authentication
+<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L285-L294 -->
 ```java
 String endpoint = "https://<RESOURCE_NAME>.communication.azure.com";
 
@@ -105,7 +46,7 @@ PhoneNumberClient phoneNumberClient = new PhoneNumberClientBuilder()
 ```
 
 Using the endpoint and access key from the communication resource to authenticate is also posible.
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L128-L139 -->
+<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L36-L47 -->
 ```java
 // You can find your endpoint and access token from your resource in the Azure Portal
 String endpoint = "https://<RESOURCE_NAME>.communication.azure.com";
@@ -138,52 +79,9 @@ Phone numbers can be assigned to a callback URL via the configure number API. As
 
 ## Examples
 
-### Creating a new user
-Use the `createUser` function to create a new user. `user.getId()` gets the
-unique ID of the user that was created.
-
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L80-L81 -->
-```java
-CommunicationUserIdentifier user = communicationIdentityClient.createUser();
-System.out.println("User id: " + user.getId());
-```
-
-### Issuing or Refreshing a token for an existing user
-Use the `issueToken` function to issue or refresh a token for an existing user. The function
-also takes in a list of communication token scopes. Scope options include:
-- `chat` (Chat)
-- `pstn` (Public switched telephone network)
-- `voip` (Voice over IP)
-
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L93-L96 -->
-```java
-List<String> scopes = new ArrayList<>(Arrays.asList("chat"));
-CommunicationUserToken userToken = communicationIdentityClient.issueToken(user, scopes);
-System.out.println("Token: " + userToken.getToken());
-System.out.println("Expires On: " + userToken.getExpiresOn());
-```
-
-### Revoking all tokens for an existing user
-Use the `revokeTokens` function to revoke all the issued tokens of a user.
-
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L108-L109 -->
-```java
-// revoke tokens issued for the user prior to now
-communicationIdentityClient.revokeTokens(user, OffsetDateTime.now());
-```
-
-### Deleting a user
-Use the `deleteUser` function to delete a user.
-
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L118-L119 -->
-```java
-// delete a previously created user
-communicationIdentityClient.deleteUser(user);
-```
-
 ### Get Countries
 
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L151-L160 -->
+<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L59-L68 -->
 ```java
 PhoneNumberClient phoneNumberClient = createPhoneNumberClient();
 
@@ -201,10 +99,8 @@ for (PhoneNumberCountry phoneNumberCountry
 
 Phone plan groups come in two types, Geographic and Toll-Free.
 
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L193-L202 -->
+<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L103-L110 -->
 ```java
-PhoneNumberClient phoneNumberClient = createPhoneNumberClient();
-
 PagedIterable<PhonePlanGroup> phonePlanGroups = phoneNumberClient
     .listPhonePlanGroups(countryCode, locale, true);
 
@@ -219,10 +115,8 @@ for (PhonePlanGroup phonePlanGroup
 
 Unlike Toll-Free phone plans, area codes for Geographic Phone Plans are empty. Area codes are found in the Area Codes API.
 
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L216-L227 -->
+<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L126-L135 -->
 ```java
-PhoneNumberClient phoneNumberClient = createPhoneNumberClient();
-
 PagedIterable<PhonePlan> phonePlans = phoneNumberClient
     .listPhonePlans(countryCode, phonePlanGroupId, locale);
 
@@ -239,10 +133,8 @@ for (PhonePlan phonePlan
 
 For Geographic phone plans, you can query the available geographic locations. The locations options are structured like the geographic hierarchy of a country. For example, the US has states and within each state are cities.
 
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L242-L260 -->
+<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L152-L168 -->
 ```java
-PhoneNumberClient phoneNumberClient = createPhoneNumberClient();
-
 LocationOptions locationOptions = phoneNumberClient
     .getPhonePlanLocationOptions(countryCode, phonePlanGroupId, phonePlanId, locale)
     .getLocationOptions();
@@ -266,10 +158,8 @@ for (LocationOptionsDetails locationOptionsDetails
 
 Fetching area codes for geographic phone plans will require the the location options queries set. You must include the chain of geographic locations traversing down the location options object returned by the GetLocationOptions API.
 
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L284-L292 -->
+<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L194-L200 -->
 ```java
-PhoneNumberClient phoneNumberClient = createPhoneNumberClient();
-
 AreaCodes areaCodes = phoneNumberClient
     .getAllAreaCodes("selection", countryCode, phonePlanId, locationOptions);
 
@@ -281,7 +171,7 @@ for (String areaCode
 
 ### Configure Phone Number
 
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L306-L306 -->
+<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L214-L214 -->
 ```java
 phoneNumberClient.configureNumber(phoneNumber, pstnConfiguration);
 ```
@@ -292,7 +182,7 @@ The Phone Number Client supports a variety of long running operations that allow
 
 ### Create Search
 
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L313-L337 -->
+<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L221-L245 -->
 ```java
 String phonePlanId = "PHONE_PLAN_ID";
 
@@ -322,7 +212,7 @@ for (String phoneNumber: result.getPhoneNumbers()) {
 ```
 
 ### Purchase Search
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L344-L350 -->
+<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L252-L258 -->
 ```java
 Duration duration = Duration.ofSeconds(1);
 String phoneNumberReservationId = "RESERVATION_ID_TO_PURCHASE";
@@ -334,7 +224,7 @@ res.waitForCompletion();
 ```
 
 ### Release Phone Numbers
-<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L357-L367 -->
+<!-- embedme ./src/samples/java/com/azure/communication/administration/ReadmeSamples.java#L265-L275 -->
 ```java
 Duration duration = Duration.ofSeconds(1);
 PhoneNumberIdentifier phoneNumber = new PhoneNumberIdentifier("PHONE_NUMBER_TO_RELEASE");

sdk/communication/azure-communication-administration/pom.xml

@@ -49,7 +49,7 @@
   <properties>
     <src.dir>src/main</src.dir>
     <test.dir>src/test</test.dir>
-    <jacoco.min.linecoverage>0.75</jacoco.min.linecoverage>
+    <jacoco.min.linecoverage>0.70</jacoco.min.linecoverage>
     <jacoco.min.branchcoverage>0.55</jacoco.min.branchcoverage>
   </properties>