Update Identity to Use Static ClientLoggers (Azure#27374)

Author: alzimmermsft

sdk/identity/azure-identity/src/main/java/com/azure/identity/AadCredentialBuilderBase.java

@@ -3,6 +3,7 @@
 
 package com.azure.identity;
 
+import com.azure.core.util.logging.ClientLogger;
 import com.azure.identity.implementation.util.ValidationUtil;
 
 import java.util.concurrent.ExecutorService;
@@ -13,6 +14,8 @@
  * @param <T> the type of the credential builder
  */
 public abstract class AadCredentialBuilderBase<T extends AadCredentialBuilderBase<T>> extends CredentialBuilderBase<T> {
+    private static final ClientLogger LOGGER = new ClientLogger(AadCredentialBuilderBase.class);
+
     String clientId;
     String tenantId;
 
@@ -23,7 +26,7 @@ public abstract class AadCredentialBuilderBase<T extends AadCredentialBuilderBas
      */
     @SuppressWarnings("unchecked")
     public T authorityHost(String authorityHost) {
-        ValidationUtil.validateAuthHost(getClass().getSimpleName(), authorityHost);
+        ValidationUtil.validateAuthHost(authorityHost, LOGGER);
         this.identityClientOptions.setAuthorityHost(authorityHost);
         return (T) this;
     }
@@ -48,7 +51,7 @@ public T clientId(String clientId) {
      */
     @SuppressWarnings("unchecked")
     public T tenantId(String tenantId) {
-        ValidationUtil.validateTenantIdCharacterRange(getClass().getSimpleName(), tenantId);
+        ValidationUtil.validateTenantIdCharacterRange(tenantId, LOGGER);
         this.tenantId = tenantId;
         return (T) this;
     }

sdk/identity/azure-identity/src/main/java/com/azure/identity/AksExchangeTokenCredential.java

@@ -14,7 +14,7 @@
  * Authenticates a service principal with AAD using a client assertion.
  */
 class AksExchangeTokenCredential extends ManagedIdentityServiceCredential {
-    private final ClientLogger logger = new ClientLogger(AksExchangeTokenCredential.class);
+    private static final ClientLogger LOGGER = new ClientLogger(AksExchangeTokenCredential.class);
 
     /**
      * Creates an instance of AksExchangeTokenCredential.
@@ -29,10 +29,10 @@ class AksExchangeTokenCredential extends ManagedIdentityServiceCredential {
     @Override
     public Mono<AccessToken> authenticate(TokenRequestContext request) {
         if (this.getClientId() == null) {
-            return Mono.error(logger.logExceptionAsError(new IllegalStateException("The client id is not configured via"
+            return Mono.error(LOGGER.logExceptionAsError(new IllegalStateException("The client id is not configured via"
                 + " 'AZURE_CLIENT_ID' environment variable or through the credential builder."
                 + " Please ensure client id is provided to authenticate via token exchange in AKS environment.")));
         }
-        return identityClient.authenticatewithExchangeToken(request);
+        return identityClient.authenticateWithExchangeToken(request);
     }
 }

sdk/identity/azure-identity/src/main/java/com/azure/identity/AppServiceMsiCredential.java

@@ -16,9 +16,10 @@
  */
 @Immutable
 class AppServiceMsiCredential extends ManagedIdentityServiceCredential {
+    private static final ClientLogger LOGGER = new ClientLogger(AppServiceMsiCredential.class);
+
     private final String identityEndpoint;
     private final String identityHeader;
-    private final ClientLogger logger = new ClientLogger(AppServiceMsiCredential.class);
 
     /**
      * Creates an instance of {@link AppServiceMsiCredential}.
@@ -32,7 +33,7 @@ class AppServiceMsiCredential extends ManagedIdentityServiceCredential {
         this.identityEndpoint = configuration.get(Configuration.PROPERTY_IDENTITY_ENDPOINT);
         this.identityHeader = configuration.get(Configuration.PROPERTY_IDENTITY_HEADER);
         if (identityEndpoint != null) {
-            validateEndpointProtocol(this.identityEndpoint, "MSI", logger);
+            validateEndpointProtocol(this.identityEndpoint, "MSI", LOGGER);
         }
     }
 

sdk/identity/azure-identity/src/main/java/com/azure/identity/ArcIdentityCredential.java

@@ -17,8 +17,9 @@
  */
 @Immutable
 class ArcIdentityCredential extends ManagedIdentityServiceCredential {
+    private static final ClientLogger LOGGER = new ClientLogger(ArcIdentityCredential.class);
+
     private final String identityEndpoint;
-    private final ClientLogger logger = new ClientLogger(ArcIdentityCredential.class);
 
     /**
      * Creates an instance of {@link ArcIdentityCredential}.
@@ -31,7 +32,7 @@ class ArcIdentityCredential extends ManagedIdentityServiceCredential {
         Configuration configuration = Configuration.getGlobalConfiguration().clone();
         this.identityEndpoint = configuration.get(Configuration.PROPERTY_IDENTITY_ENDPOINT);
         if (identityEndpoint != null) {
-            validateEndpointProtocol(this.identityEndpoint, "Identity", logger);
+            validateEndpointProtocol(this.identityEndpoint, "Identity", LOGGER);
         }
     }
 
@@ -43,7 +44,7 @@ class ArcIdentityCredential extends ManagedIdentityServiceCredential {
      */
     public Mono<AccessToken> authenticate(TokenRequestContext request) {
         if  (getClientId() != null) {
-            return Mono.error(logger.logExceptionAsError(new ClientAuthenticationException(
+            return Mono.error(LOGGER.logExceptionAsError(new ClientAuthenticationException(
                 "User assigned identity is not supported by the Azure Arc Managed Identity Endpoint. To authenticate "
                     + "with the system assigned identity omit the client id when constructing the"
                     + " ManagedIdentityCredential.", null)));

sdk/identity/azure-identity/src/main/java/com/azure/identity/AuthorizationCodeCredential.java

@@ -24,11 +24,12 @@
  */
 @Immutable
 public class AuthorizationCodeCredential implements TokenCredential {
+    private static final ClientLogger LOGGER = new ClientLogger(AuthorizationCodeCredential.class);
+
     private final String authCode;
     private final URI redirectUri;
     private final IdentityClient identityClient;
     private final AtomicReference<MsalAuthenticationAccount> cachedToken;
-    private final ClientLogger logger = new ClientLogger(AuthorizationCodeCredential.class);
 
     /**
      * Creates an AuthorizationCodeCredential with the given identity client options.
@@ -70,8 +71,8 @@ public Mono<AccessToken> getToken(TokenRequestContext request) {
                                         identityClient.getTenantId(), identityClient.getClientId())));
                    return (AccessToken) msalToken;
                })
-            .doOnNext(token -> LoggingUtil.logTokenSuccess(logger, request))
-            .doOnError(error -> LoggingUtil.logTokenError(logger, identityClient.getIdentityClientOptions(),
+            .doOnNext(token -> LoggingUtil.logTokenSuccess(LOGGER, request))
+            .doOnError(error -> LoggingUtil.logTokenError(LOGGER, identityClient.getIdentityClientOptions(),
                 request, error));
     }
 }

sdk/identity/azure-identity/src/main/java/com/azure/identity/AuthorizationCodeCredentialBuilder.java

@@ -16,7 +16,7 @@
  * @see AuthorizationCodeCredential
  */
 public class AuthorizationCodeCredentialBuilder extends AadCredentialBuilderBase<AuthorizationCodeCredentialBuilder> {
-    private final ClientLogger logger = new ClientLogger(AuthorizationCodeCredentialBuilder.class);
+    private static final ClientLogger LOGGER = new ClientLogger(AuthorizationCodeCredentialBuilder.class);
 
     private String authCode;
     private String redirectUrl;
@@ -36,7 +36,7 @@ public AuthorizationCodeCredentialBuilder authorizationCode(String authCode) {
     /**
      * Sets redirect URL for the Oauth 2.0 login request, which must be
      * registered as a valid redirect URL on the application. The authorization code
-     * will be sent to this URL so it must be listening on this server and is able
+     * will be sent to this URL, so it must be listening on this server and is able
      * to complete the {@link AuthorizationCodeCredential} construction from there.
      * This is also called Reply URLs in some contexts.
      *
@@ -70,12 +70,12 @@ public AuthorizationCodeCredential build() {
                 put("clientId", clientId);
                 put("authorizationCode", authCode);
                 put("redirectUrl", redirectUrl);
-            }});
+            }}, LOGGER);
         try {
             return new AuthorizationCodeCredential(clientId, clientSecret, tenantId, authCode, new URI(redirectUrl),
                 identityClientOptions);
         } catch (URISyntaxException e) {
-            throw logger.logExceptionAsError(new RuntimeException(e));
+            throw LOGGER.logExceptionAsError(new RuntimeException(e));
         }
     }
 }

sdk/identity/azure-identity/src/main/java/com/azure/identity/AzureApplicationCredentialBuilder.java

@@ -17,9 +17,10 @@
  * @see AzureApplicationCredential
  */
 class AzureApplicationCredentialBuilder extends CredentialBuilderBase<AzureApplicationCredentialBuilder> {
+    private static final ClientLogger LOGGER = new ClientLogger(AzureApplicationCredentialBuilder.class);
+
     private String managedIdentityClientId;
-    private String managedIdentityResouceId;
-    private final ClientLogger logger = new ClientLogger(AzureApplicationCredentialBuilder.class);
+    private String managedIdentityResourceId;
 
     /**
      * Creates an instance of a AzureApplicationCredentialBuilder.
@@ -62,7 +63,7 @@ public AzureApplicationCredentialBuilder managedIdentityClientId(String clientId
      * @return An updated instance of this builder with the managed identity client id set as specified.
      */
     public AzureApplicationCredentialBuilder managedIdentityResourceId(String resourceId) {
-        this.managedIdentityResouceId = resourceId;
+        this.managedIdentityResourceId = resourceId;
         return this;
     }
 
@@ -93,8 +94,8 @@ public AzureApplicationCredentialBuilder executorService(ExecutorService executo
      * @throws IllegalStateException if clientId and resourceId are both set.
      */
     public AzureApplicationCredential build() {
-        if (managedIdentityClientId != null && managedIdentityResouceId != null) {
-            throw logger.logExceptionAsError(
+        if (managedIdentityClientId != null && managedIdentityResourceId != null) {
+            throw LOGGER.logExceptionAsError(
                 new IllegalStateException("Only one of managedIdentityClientId and managedIdentityResourceId can be specified."));
         }
 
@@ -104,7 +105,7 @@ public AzureApplicationCredential build() {
     private ArrayList<TokenCredential> getCredentialsChain() {
         ArrayList<TokenCredential> output = new ArrayList<TokenCredential>(2);
         output.add(new EnvironmentCredential(identityClientOptions));
-        output.add(new ManagedIdentityCredential(managedIdentityClientId, managedIdentityResouceId, identityClientOptions));
+        output.add(new ManagedIdentityCredential(managedIdentityClientId, managedIdentityResourceId, identityClientOptions));
         return output;
     }
 }

sdk/identity/azure-identity/src/main/java/com/azure/identity/AzureCliCredential.java

@@ -20,8 +20,9 @@
  */
 @Immutable
 public class AzureCliCredential implements TokenCredential {
+    private static final ClientLogger LOGGER = new ClientLogger(AzureCliCredential.class);
+
     private final IdentityClient identityClient;
-    private final ClientLogger logger = new ClientLogger(AzureCliCredential.class);
 
     /**
      * Creates an AzureCliSecretCredential with default identity client options.
@@ -37,7 +38,8 @@ public class AzureCliCredential implements TokenCredential {
     @Override
     public Mono<AccessToken> getToken(TokenRequestContext request) {
         return identityClient.authenticateWithAzureCli(request)
-            .doOnNext(token -> LoggingUtil.logTokenSuccess(logger, request))
-            .doOnError(error -> LoggingUtil.logTokenError(logger, identityClient.getIdentityClientOptions(), request, error));
+            .doOnNext(token -> LoggingUtil.logTokenSuccess(LOGGER, request))
+            .doOnError(error -> LoggingUtil.logTokenError(LOGGER, identityClient.getIdentityClientOptions(), request,
+                error));
     }
 }

sdk/identity/azure-identity/src/main/java/com/azure/identity/AzureCliCredentialBuilder.java

@@ -3,6 +3,7 @@
 
 package com.azure.identity;
 
+import com.azure.core.util.logging.ClientLogger;
 import com.azure.identity.implementation.util.ValidationUtil;
 
 /**
@@ -11,6 +12,8 @@
  * @see AzureCliCredential
  */
 public class AzureCliCredentialBuilder extends CredentialBuilderBase<AzureCliCredentialBuilder> {
+    private static final ClientLogger LOGGER = new ClientLogger(AzureCliCredentialBuilder.class);
+
     private String tenantId;
 
     /**
@@ -20,7 +23,7 @@ public class AzureCliCredentialBuilder extends CredentialBuilderBase<AzureCliCre
      * @return An updated instance of this builder with the tenant id set as specified.
      */
     public AzureCliCredentialBuilder tenantId(String tenantId) {
-        ValidationUtil.validateTenantIdCharacterRange(getClass().getSimpleName(), tenantId);
+        ValidationUtil.validateTenantIdCharacterRange(tenantId, LOGGER);
         this.tenantId = tenantId;
         return this;
     }

sdk/identity/azure-identity/src/main/java/com/azure/identity/AzurePowerShellCredential.java

@@ -15,12 +15,13 @@
 import reactor.core.publisher.Mono;
 
 /**
- * A credential provider that provides token credentials based on Azure Power Shell command.
+ * A credential provider that provides token credentials based on Azure PowerShell command.
  */
 @Immutable
 public class AzurePowerShellCredential implements TokenCredential {
+    private static final ClientLogger LOGGER = new ClientLogger(AzurePowerShellCredential.class);
+
     private final IdentityClient identityClient;
-    private final ClientLogger logger = new ClientLogger(AzurePowerShellCredential.class);
 
     AzurePowerShellCredential(String tenantId, IdentityClientOptions options) {
         identityClient = new IdentityClientBuilder()
@@ -32,7 +33,8 @@ public class AzurePowerShellCredential implements TokenCredential {
     @Override
     public Mono<AccessToken> getToken(TokenRequestContext request) {
         return identityClient.authenticateWithAzurePowerShell(request)
-            .doOnNext(token -> LoggingUtil.logTokenSuccess(logger, request))
-            .doOnError(error -> LoggingUtil.logTokenError(logger, identityClient.getIdentityClientOptions(), request, error));
+            .doOnNext(token -> LoggingUtil.logTokenSuccess(LOGGER, request))
+            .doOnError(error -> LoggingUtil.logTokenError(LOGGER, identityClient.getIdentityClientOptions(), request,
+                error));
     }
 }