Use spring.factories to provide bean: KeyVaultHealthIndicator. (Azure…

…#14337) * Use spring.factories to provide bean: KeyVaultHealthIndicator. * Fix error reported by maven-checkstyle-plugin. Co-authored-by: Rujun Chen <[email protected]>
ping9802 · Aug 24, 2020 · 822baf6 · 822baf6
1 parent 6027874
commit 822baf6
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 12 deletions.
diff --git a/sdk/spring/azure-spring-boot-samples/azure-spring-boot-sample-keyvault-secrets/pom.xml b/sdk/spring/azure-spring-boot-samples/azure-spring-boot-sample-keyvault-secrets/pom.xml
@@ -27,13 +27,11 @@
     </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>
-      <artifactId>spring-boot-actuator-autoconfigure</artifactId>
-      <version>2.3.3.RELEASE</version> <!-- {x-version-update;org.springframework.boot:spring-boot-actuator-autoconfigure;external_dependency} -->
+      <artifactId>spring-boot-starter-actuator</artifactId>
     </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
-      <version>2.3.3.RELEASE</version> <!-- {x-version-update;org.springframework.boot:spring-boot-starter-web;external_dependency} -->
     </dependency>
   </dependencies>
 

diff --git a/...oft/azure/keyvault/SampleApplication.java → ...ult/sample/KeyVaultSampleApplication.java b/...oft/azure/keyvault/SampleApplication.java → ...ult/sample/KeyVaultSampleApplication.java
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-package com.microsoft.azure.keyvault;
+package com.microsoft.azure.keyvault.sample;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -11,15 +11,15 @@
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
 @SpringBootApplication
-public class SampleApplication implements CommandLineRunner {
+public class KeyVaultSampleApplication implements CommandLineRunner {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(SampleApplication.class);
+    private static final Logger LOGGER = LoggerFactory.getLogger(KeyVaultSampleApplication.class);
 
     @Value("${keyVaultSecretName}")
     private String keyVaultSecretName;
 
     public static void main(String[] args) {
-        SpringApplication.run(SampleApplication.class, args);
+        SpringApplication.run(KeyVaultSampleApplication.class, args);
     }
 
     public void run(String[] args) {

diff --git a/...-boot-test-cosmosdb/src/test/java/com/microsoft/azure/test/cosmosdb/CosmosActuatorIT.java b/...-boot-test-cosmosdb/src/test/java/com/microsoft/azure/test/cosmosdb/CosmosActuatorIT.java
@@ -1,3 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
 package com.microsoft.azure.test.cosmosdb;
 
 import com.microsoft.azure.test.utils.AppRunner;

diff --git a/...g-boot/src/main/java/com/microsoft/azure/keyvault/spring/KeyVaultHealthConfiguration.java b/...g-boot/src/main/java/com/microsoft/azure/keyvault/spring/KeyVaultHealthConfiguration.java
@@ -0,0 +1,25 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.microsoft.azure.keyvault.spring;
+
+import com.azure.security.keyvault.secrets.SecretClient;
+import org.springframework.boot.actuate.autoconfigure.health.ConditionalOnEnabledHealthIndicator;
+import org.springframework.boot.actuate.health.HealthIndicator;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.PropertySource;
+import org.springframework.core.env.ConfigurableEnvironment;
+
+@Configuration
+@ConditionalOnClass({ SecretClient.class, HealthIndicator.class })
+@PropertySource("classpath:/azure-spring-actuator.properties")
+public class KeyVaultHealthConfiguration {
+
+    @Bean
+    @ConditionalOnEnabledHealthIndicator("azure-key-vault")
+    KeyVaultHealthIndicator keyVaultHealthIndicator(ConfigurableEnvironment environment) {
+        return new KeyVaultHealthIndicator(environment);
+    }
+}
diff --git a/...pring-boot/src/main/java/com/microsoft/azure/keyvault/spring/KeyVaultHealthIndicator.java b/...pring-boot/src/main/java/com/microsoft/azure/keyvault/spring/KeyVaultHealthIndicator.java
@@ -3,14 +3,10 @@
 
 package com.microsoft.azure.keyvault.spring;
 
-import org.springframework.boot.actuate.autoconfigure.health.ConditionalOnEnabledHealthIndicator;
 import org.springframework.boot.actuate.health.Health;
 import org.springframework.boot.actuate.health.HealthIndicator;
 import org.springframework.core.env.ConfigurableEnvironment;
-import org.springframework.stereotype.Component;
 
-@ConditionalOnEnabledHealthIndicator("azure-key-vault")
-@Component
 public class KeyVaultHealthIndicator implements HealthIndicator {
 
     private final ConfigurableEnvironment environment;

diff --git a/sdk/spring/azure-spring-boot/src/main/resources/META-INF/spring.factories b/sdk/spring/azure-spring-boot/src/main/resources/META-INF/spring.factories
@@ -10,4 +10,5 @@ com.microsoft.azure.spring.autoconfigure.aad.AADOAuth2AutoConfiguration,\
 com.microsoft.azure.spring.autoconfigure.b2c.AADB2CAutoConfiguration,\
 com.microsoft.azure.spring.autoconfigure.metrics.AzureMonitorMetricsExportAutoConfiguration,\
 com.microsoft.azure.spring.autoconfigure.jms.ServiceBusJMSAutoConfiguration,\
-com.microsoft.azure.spring.autoconfigure.cosmosdb.CosmosHealthConfiguration
+com.microsoft.azure.spring.autoconfigure.cosmosdb.CosmosHealthConfiguration,\
+com.microsoft.azure.keyvault.spring.KeyVaultHealthConfiguration