Modify spring-cloud-azure-core, spring-cloud-azure-service, and sprin…

…g-cloud-azure-resourcemanager according to API review comments (#25851)

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

@@ -489,7 +489,6 @@ the main ServiceBusClientBuilder. -->
   <!--BlacklistedWordsCheck: URL is the name -->
   <suppress checks="com.azure.tools.checkstyle.checks.BlacklistedWordsCheck" files="com.azure.spring.core.resource.StorageBlobResource.java"/>
   <suppress checks="com.azure.tools.checkstyle.checks.BlacklistedWordsCheck" files="com.azure.spring.core.resource.StorageFileResource.java"/>
-  <suppress checks="com.azure.tools.checkstyle.checks.BlacklistedWordsCheck" files="com.azure.spring.core.util.URLValidator.java"/>
 
   <!-- EnforceFinalFieldsCheck: The property will be filled by Spring framework -->
   <suppress checks="com.azure.tools.checkstyle.checks.EnforceFinalFieldsCheck" files="com.azure.spring.data.cosmos.config.AbstractCosmosConfiguration.java"/>

eng/code-quality-reports/src/main/resources/spotbugs/spotbugs-exclude.xml

@@ -2277,10 +2277,10 @@
   <Match>
     <And>
       <Or>
-        <Class name="com.azure.spring.core.credential.resolver.AzureKeyCredentialResolver"/>
-        <Class name="com.azure.spring.core.credential.resolver.AzureNamedKeyCredentialResolver"/>
-        <Class name="com.azure.spring.core.credential.resolver.AzureSasCredentialResolver"/>
-        <Class name="com.azure.spring.service.storage.common.credential.StorageSharedKeyCredentialResolver" />
+        <Class name="com.azure.spring.core.implementation.credential.resolver.AzureKeyCredentialResolver"/>
+        <Class name="com.azure.spring.core.implementation.credential.resolver.AzureNamedKeyCredentialResolver"/>
+        <Class name="com.azure.spring.core.implementation.credential.resolver.AzureSasCredentialResolver"/>
+        <Class name="com.azure.spring.service.implementation.storage.credential.StorageSharedKeyCredentialResolver" />
       </Or>
       <Method name="resolve"/>
     </And>

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/AzureServiceConfigurationBase.java

@@ -8,7 +8,7 @@
 import com.azure.spring.core.aware.ProxyAware;
 import com.azure.spring.core.aware.RetryAware;
 import com.azure.spring.core.properties.AzureProperties;
-import com.azure.spring.core.properties.util.AzurePropertiesUtils;
+import com.azure.spring.core.util.AzurePropertiesUtils;
 import org.springframework.beans.BeanUtils;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Configuration;
@@ -26,6 +26,16 @@ public AzureServiceConfigurationBase(AzureGlobalProperties azureProperties) {
         this.azureGlobalProperties = azureProperties;
     }
 
+    /**
+     * Load the default value to an Azure Service properties from the global Azure properties.
+     *
+     * @param source The global Azure properties.
+     * @param target The properties of an Azure Service, such as Event Hubs properties. Some common components of the
+     *               service's properties have default value as set to the global properties. For example, the proxy of
+     *               the Event Hubs properties takes the proxy set to the global Azure properties as default.
+     * @param <T> The type of the properties of an Azure Service.
+     * @return The Azure Service's properties.
+     */
     protected <T extends AzureProperties> T loadProperties(AzureGlobalProperties source, T target) {
         AzurePropertiesUtils.copyAzureCommonProperties(source, target);
 

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/aadb2c/properties/AADB2CProperties.java

@@ -3,13 +3,13 @@
 package com.azure.spring.cloud.autoconfigure.aadb2c.properties;
 
 import com.azure.spring.cloud.autoconfigure.aadb2c.implementation.AADB2CConfigurationException;
-import com.azure.spring.core.util.URLValidator;
 import com.nimbusds.jose.jwk.source.RemoteJWKSet;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.boot.context.properties.DeprecatedConfigurationProperty;
 import org.springframework.util.CollectionUtils;
 import org.springframework.util.StringUtils;
 
+import java.net.MalformedURLException;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Optional;
@@ -156,14 +156,31 @@ private void validateCommonProperties() {
      * Validate URL properties configuration.
      */
     private void validateURLProperties() {
-        if (!URLValidator.isValidURL(logoutSuccessUrl)) {
+        if (!isValidUrl(logoutSuccessUrl)) {
             throw new AADB2CConfigurationException("logout success should be valid URL.");
         }
-        if (!URLValidator.isValidURL(baseUri)) {
+        if (!isValidUrl(baseUri)) {
             throw new AADB2CConfigurationException("baseUri should be valid URL.");
         }
     }
 
+    /**
+     * Used to validate uri, the uri is allowed to be empty.
+     * @param uri the uri to be validated.
+     * @return whether is uri is valid or not.
+     */
+    private static boolean isValidUrl(String uri) {
+        if (!StringUtils.hasLength(uri)) {
+            return true;
+        }
+        try {
+            new java.net.URL(uri);
+        } catch (MalformedURLException var) {
+            return false;
+        }
+        return true;
+    }
+
 
     /**
      * Gets the password reset.

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/appconfiguration/AzureAppConfigurationAutoConfiguration.java

@@ -24,7 +24,7 @@
 import org.springframework.context.annotation.Bean;
 
 /**
- * Auto-configuration for a {@link ConfigurationClientBuilder} and Azure App Configuration clients.
+ * Autoconfiguration for a {@link ConfigurationClientBuilder} and Azure App Configuration clients.
  */
 @ConditionalOnClass(ConfigurationClientBuilder.class)
 @ConditionalOnProperty(value = "spring.cloud.azure.appconfiguration.enabled", havingValue = "true", matchIfMissing = true)

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/appconfiguration/properties/AzureAppConfigurationProperties.java

@@ -4,19 +4,28 @@
 package com.azure.spring.cloud.autoconfigure.appconfiguration.properties;
 
 import com.azure.data.appconfiguration.ConfigurationServiceVersion;
-import com.azure.spring.cloud.autoconfigure.properties.AbstractAzureHttpCP;
-import com.azure.spring.service.appconfiguration.AppConfigurationProperties;
+import com.azure.spring.cloud.autoconfigure.properties.core.AbstractAzureHttpCP;
+import com.azure.spring.service.appconfiguration.ConfigurationClientProperties;
 
 /**
  * Properties for Azure App Configuration.
  */
 public class AzureAppConfigurationProperties extends AbstractAzureHttpCP
-    implements AppConfigurationProperties {
+    implements ConfigurationClientProperties {
 
     public static final String PREFIX = "spring.cloud.azure.appconfiguration";
 
+    /**
+     * Endpoint of the Azure App Configuration instance.
+     */
     private String endpoint;
+    /**
+     * Connection string of the Azure App Configuration instance.
+     */
     private String connectionString;
+    /**
+     * Version of the service to be used when making request.
+     */
     private ConfigurationServiceVersion serviceVersion;
 
     @Override

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/condition/ConditionalOnAnyProperty.java

@@ -29,19 +29,19 @@
     /**
      * A prefix that should be applied to each property. The prefix automatically ends
      * with a dot if not specified. A valid prefix is defined by one or more words
-     * separated with dots (e.g. {@code "azure.spring.cloud"}).
+     * separated with dots (e.g. {@code "spring.cloud.azure"}).
      * @return the prefix
      */
     String prefix() default "";
 
     /**
      * The name of the properties to test. If a prefix has been defined, it is applied to
-     * compute the full key of each property. For instance if the prefix is
-     * {@code azure.spring.cloud} and one value is {@code my-value}, the full key would be
-     * {@code azure.spring.cloud.my-value}
+     * compute the full key of each property. For instance if the prefix is {@code "spring.cloud.azure"}
+     * and one value is {@code "my-value"}, the full key would be
+     * {@code "spring.cloud.azure.my-value"}
      * <p>
      * Use the dashed notation to specify each property, that is all lower case with a "-"
-     * to separate words (e.g. {@code my-long-property}).
+     * to separate words (e.g. {@code "my-long-property"}).
      * @return the names
      */
     String[] name() default {};

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/condition/ConditionalOnMissingProperty.java

@@ -29,19 +29,19 @@
     /**
      * A prefix that should be applied to each property. The prefix automatically ends
      * with a dot if not specified. A valid prefix is defined by one or more words
-     * separated with dots (e.g. {@code "azure.spring.cloud"}).
+     * separated with dots (e.g. {@code "spring.cloud.azure"}).
      * @return the prefix
      */
     String prefix() default "";
 
     /**
      * The name of the properties to test. If a prefix has been defined, it is applied to
      * compute the full key of each property. For instance if the prefix is
-     * {@code azure.spring.cloud} and one value is {@code my-value}, the full key would be
-     * {@code azure.spring.cloud.my-value}
+     * {@code "spring.cloud.azure"} and one value is {@code "my-value"}, the full key would be
+     * {@code "spring.cloud.azure.my-value"}
      * <p>
      * Use the dashed notation to specify each property, that is all lower case with a "-"
-     * to separate words (e.g. {@code my-long-property}).
+     * to separate words (e.g. {@code "my-long-property"}).
      * @return the names
      */
     String[] name() default {};

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/cosmos/properties/AzureCosmosProperties.java

@@ -12,7 +12,7 @@
 import com.azure.spring.cloud.autoconfigure.properties.core.AbstractAzureServiceCP;
 import com.azure.spring.cloud.autoconfigure.properties.core.client.ClientCP;
 import com.azure.spring.cloud.autoconfigure.properties.core.proxy.HttpProxyCP;
-import com.azure.spring.service.cosmos.CosmosProperties;
+import com.azure.spring.service.cosmos.CosmosClientProperties;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
 
 import java.util.ArrayList;
@@ -21,7 +21,7 @@
 /**
  * Configuration properties for Cosmos database, consistency, telemetry, connection, query metrics and diagnostics.
  */
-public class AzureCosmosProperties extends AbstractAzureServiceCP implements CosmosProperties {
+public class AzureCosmosProperties extends AbstractAzureServiceCP implements CosmosClientProperties {
 
     public static final String PREFIX = "spring.cloud.azure.cosmos";
 

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/eventhubs/AzureBlobCheckpointStoreConfiguration.java

@@ -25,7 +25,7 @@
 import java.time.Duration;
 
 import static com.azure.spring.cloud.autoconfigure.context.AzureContextUtils.EVENT_HUB_PROCESSOR_CHECKPOINT_STORE_STORAGE_CLIENT_BUILDER_FACTORY_BEAN_NAME;
-import static com.azure.spring.core.properties.util.AzurePropertiesUtils.mergeAzureCommonProperties;
+import static com.azure.spring.core.util.AzurePropertiesUtils.mergeAzureCommonProperties;
 
 /**
  * Configures a {@link BlobCheckpointStore}

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/eventhubs/AzureEventHubsConsumerClientConfiguration.java

@@ -12,14 +12,14 @@
 import com.azure.spring.core.AzureSpringIdentifier;
 import com.azure.spring.core.connectionstring.ConnectionStringProvider;
 import com.azure.spring.core.customizer.AzureServiceClientBuilderCustomizer;
-import com.azure.spring.core.properties.util.PropertyMapper;
 import com.azure.spring.core.service.AzureServiceType;
 import com.azure.spring.service.eventhubs.factory.EventHubClientBuilderFactory;
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.context.properties.PropertyMapper;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
@@ -51,7 +51,7 @@ static class SharedConsumerConnectionConfiguration {
         SharedConsumerConnectionConfiguration(AzureEventHubsProperties properties, EventHubClientBuilder builder) {
             this.builder = builder;
 
-            PropertyMapper mapper = new PropertyMapper();
+            PropertyMapper mapper = PropertyMapper.get().alwaysApplyingWhenNonNull();
             mapper.from(properties.getConsumer().getConsumerGroup()).to(builder::consumerGroup);
             mapper.from(properties.getConsumer().getPrefetchCount()).to(builder::prefetchCount);
         }

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/eventhubs/AzureEventHubsMessagingAutoConfiguration.java

@@ -6,7 +6,7 @@
 import com.azure.messaging.eventhubs.CheckpointStore;
 import com.azure.spring.cloud.autoconfigure.condition.ConditionalOnAnyProperty;
 import com.azure.spring.cloud.autoconfigure.eventhubs.properties.AzureEventHubsProperties;
-import com.azure.spring.core.properties.util.AzurePropertiesUtils;
+import com.azure.spring.core.util.AzurePropertiesUtils;
 import com.azure.spring.eventhubs.core.EventHubsProcessorContainer;
 import com.azure.spring.eventhubs.core.EventHubsTemplate;
 import com.azure.spring.eventhubs.core.processor.DefaultEventHubsNamespaceProcessorFactory;
@@ -29,7 +29,7 @@
 import org.springframework.context.annotation.Import;
 import reactor.util.function.Tuple2;
 
-import static com.azure.spring.core.properties.util.AzurePropertiesUtils.copyAzureCommonProperties;
+import static com.azure.spring.core.util.AzurePropertiesUtils.copyAzureCommonProperties;
 
 /**
  * An auto-configuration for Event Hub, which provides {@link EventHubsTemplate} and {@link

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/eventhubs/kafka/AzureEventHubsKafkaAutoConfiguration.java

@@ -7,7 +7,7 @@
 import com.azure.spring.cloud.autoconfigure.resourcemanager.AzureEventHubsResourceManagerAutoConfiguration;
 import com.azure.spring.core.connectionstring.ConnectionStringProvider;
 import com.azure.spring.core.connectionstring.StaticConnectionStringProvider;
-import com.azure.spring.core.connectionstring.implementation.EventHubsConnectionString;
+import com.azure.spring.core.implementation.connectionstring.EventHubsConnectionString;
 import com.azure.spring.core.service.AzureServiceType;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/eventhubs/properties/AzureEventHubsCommonProperties.java

@@ -3,8 +3,8 @@
 
 package com.azure.spring.cloud.autoconfigure.eventhubs.properties;
 
-import com.azure.spring.cloud.autoconfigure.properties.AbstractAzureAmqpCP;
-import com.azure.spring.core.connectionstring.implementation.EventHubsConnectionString;
+import com.azure.spring.cloud.autoconfigure.properties.core.AbstractAzureAmqpCP;
+import com.azure.spring.core.implementation.connectionstring.EventHubsConnectionString;
 
 /**
  * Azure Event Hubs related properties.
@@ -36,7 +36,7 @@ protected String extractEventHubNameFromConnectionString() {
     // servicebus.windows.net)
     // Endpoint=sb://<FQDN>/;SharedAccessKeyName=<KeyName>;SharedAccessKey=<KeyValue>
     // https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string
-    public String getFQDN() {
+    public String getFullyQualifiedNamespace() {
         return this.namespace == null ? extractFqdnFromConnectionString() : (this.namespace + "." + domainName);
     }
 

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/eventhubs/properties/AzureEventHubsProperties.java

@@ -4,11 +4,11 @@
 package com.azure.spring.cloud.autoconfigure.eventhubs.properties;
 
 import com.azure.spring.cloud.autoconfigure.storage.blob.properties.AzureStorageBlobProperties;
-import com.azure.spring.core.properties.util.AzurePropertiesUtils;
-import com.azure.spring.service.eventhubs.properties.EventHubsConsumerDescriptor;
-import com.azure.spring.service.eventhubs.properties.EventHubsNamespaceDescriptor;
-import com.azure.spring.service.eventhubs.properties.EventHubsProcessorDescriptor;
-import com.azure.spring.service.eventhubs.properties.EventHubsProducerDescriptor;
+import com.azure.spring.core.util.AzurePropertiesUtils;
+import com.azure.spring.service.eventhubs.properties.EventHubConsumerProperties;
+import com.azure.spring.service.eventhubs.properties.EventHubProducerProperties;
+import com.azure.spring.service.eventhubs.properties.EventHubsNamespaceProperties;
+import com.azure.spring.service.eventhubs.properties.EventProcessorClientProperties;
 import org.springframework.beans.BeanUtils;
 import org.springframework.boot.context.properties.PropertyMapper;
 
@@ -19,7 +19,7 @@
 /**
  * Azure Event Hubs related properties.
  */
-public class AzureEventHubsProperties extends AzureEventHubsCommonProperties implements EventHubsNamespaceDescriptor {
+public class AzureEventHubsProperties extends AzureEventHubsCommonProperties implements EventHubsNamespaceProperties {
 
     public static final String PREFIX = "spring.cloud.azure.eventhubs";
 
@@ -129,14 +129,14 @@ public Processor getProcessor() {
     /**
      * Properties of an Event Hub producer.
      */
-    public static class Producer extends AzureEventHubsCommonProperties implements EventHubsProducerDescriptor {
+    public static class Producer extends AzureEventHubsCommonProperties implements EventHubProducerProperties {
 
     }
 
     /**
      * Properties of an Event Hub consumer.
      */
-    public static class Consumer extends AzureEventHubsCommonProperties implements EventHubsConsumerDescriptor {
+    public static class Consumer extends AzureEventHubsCommonProperties implements EventHubConsumerProperties {
 
         /**
          * Name of the consumer group this consumer is associated with.
@@ -170,12 +170,12 @@ public void setPrefetchCount(Integer prefetchCount) {
     /**
      * Properties of an Event Hub processor.
      */
-    public static class Processor extends Consumer implements EventHubsProcessorDescriptor {
+    public static class Processor extends Consumer implements EventProcessorClientProperties {
 
         private Boolean trackLastEnqueuedEventProperties;
         private Map<String, StartPosition> initialPartitionEventPosition = new HashMap<>();
         private Duration partitionOwnershipExpirationInterval;
-        private final Batch batch = new Batch();
+        private final EventBatch batch = new EventBatch();
         private final LoadBalancing loadBalancing = new LoadBalancing();
         private final BlobCheckpointStore checkpointStore = new BlobCheckpointStore();
 
@@ -203,7 +203,7 @@ public void setPartitionOwnershipExpirationInterval(Duration partitionOwnershipE
             this.partitionOwnershipExpirationInterval = partitionOwnershipExpirationInterval;
         }
 
-        public Batch getBatch() {
+        public EventBatch getBatch() {
             return batch;
         }
 
@@ -218,21 +218,21 @@ public BlobCheckpointStore getCheckpointStore() {
         /**
          * Event processor load balancing properties.
          */
-        public static class LoadBalancing extends EventHubsProcessorDescriptor.LoadBalancing {
+        public static class LoadBalancing extends EventProcessorClientProperties.LoadBalancing {
 
         }
 
         /**
          * Event processor batch properties.
          */
-        public static class Batch extends EventHubsProcessorDescriptor.Batch {
+        public static class EventBatch extends EventProcessorClientProperties.EventBatch {
 
         }
 
         /**
          * Blob checkpoint store.
          */
-        public static class BlobCheckpointStore extends AzureStorageBlobProperties  {
+        public static class BlobCheckpointStore extends AzureStorageBlobProperties {
 
             private Boolean createContainerIfNotExists;
 

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/jms/NonPremiumServiceBusJmsAutoConfiguration.java

@@ -4,7 +4,7 @@
 package com.azure.spring.cloud.autoconfigure.jms;
 
 import com.azure.spring.cloud.autoconfigure.jms.properties.AzureServiceBusJmsProperties;
-import com.azure.spring.core.connectionstring.implementation.ServiceBusConnectionString;
+import com.azure.spring.core.implementation.connectionstring.ServiceBusConnectionString;
 import org.apache.qpid.jms.JmsConnectionFactory;
 import org.apache.qpid.jms.policy.JmsDefaultPrefetchPolicy;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;