add spring cloud context tool

jitendrazkumar · jitendrazkumar · commit b4b755f14be9 · 2023-08-18T13:33:49.000+05:30
diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ This project has dependency and transitive dependencies on Spring Projects. The
 
 | Spring Cloud OCI  | Spring Cloud    | Spring Boot         | OCI Java SDK |
 |-------------------|-----------------|---------------------|--------------|
-| 1.0.0  	        | <to-be-checked> | 3.0.x, 3.1.x  |  3.19.0      |
+| 1.0.0  	        | 2021.0.x        | 2.7.x               |  3.19.0      |
 
 
 ## Try out samples
diff --git a/docs/src/main/asciidoc/index.adoc b/docs/src/main/asciidoc/index.adoc
@@ -29,3 +29,46 @@ include::logging.adoc[]
 == Configuration properties
 
 To see the list of all OCI related configuration properties please check link:appendix.html[the Appendix page].
+
+=== Configuration Refresh
+
+The following properties are supported for Configuration auto-refresh at runtime without the need to restart applications
+
+|===
+|Name | Default
+
+|spring.cloud.oci.config.profile | `DEFAULT`
+|spring.cloud.oci.config.file | NA
+|spring.cloud.oci.config.type | NA
+|spring.cloud.oci.config.userId | NA
+|spring.cloud.oci.config.tenantId | NA
+|spring.cloud.oci.config.fingerprint | NA
+|spring.cloud.oci.config.privateKey | NA
+|spring.cloud.oci.config.passPhrase | NA
+|spring.cloud.oci.config.region | NA
+|spring.cloud.oci.region.static | NA
+|spring.cloud.oci.compartment.static | NA
+|spring.cloud.oci.logging.logId | NA
+
+|===
+
+Spring Boot Actuator can be used to explicitly refresh the externalized configuration during runtime. Add the corresponding build dependency to enable the Actuator:
+
+Maven:
+----
+<dependency>
+    <groupId>org.springframework.boot</groupId>
+    <artifactId>spring-boot-starter-actuator</artifactId>
+</dependency>
+----
+
+Gradle:
+----
+dependencies {
+    implementation("org.springframework.boot:spring-boot-starter-actuator")
+}
+----
+
+Set `management.endpoints.web.exposure.include=refresh` in the externalized configuration file of the Spring Boot Application to enable /actuator/refresh endpoint.
+
+To refresh the updated Configuration properties at runtime make a POST API call to /actuator/refresh endpoint
diff --git a/pom.xml b/pom.xml
@@ -54,7 +54,7 @@ Licensed under the Universal Permissive License v 1.0 as shown at https://oss.or
 
     <properties>
         <spring-cloud-oci-dependencies.version>${project.version}</spring-cloud-oci-dependencies.version>
-        <!-- spring-cloud-dependencies.version>2022.0.1</spring-cloud-dependencies.version -->
+        <spring-cloud-dependencies.version>2021.0.2</spring-cloud-dependencies.version>
         <spring-boot-dependencies.version>2.7.4</spring-boot-dependencies.version>
         <oci-sdk.version>3.19.0</oci-sdk.version>
         <spring-boot-maven-plugin.version>3.1.2</spring-boot-maven-plugin.version>
@@ -128,13 +128,13 @@ Licensed under the Universal Permissive License v 1.0 as shown at https://oss.or
                 <scope>import</scope>
             </dependency>
 
-            <!-- dependency>
+            <dependency>
                 <groupId>org.springframework.cloud</groupId>
                 <artifactId>spring-cloud-dependencies</artifactId>
                 <version>${spring-cloud-dependencies.version}</version>
                 <type>pom</type>
                 <scope>import</scope>
-            </dependency -->
+            </dependency>
         </dependencies>
     </dependencyManagement>
 
diff --git a/spring-cloud-oci-autoconfigure/pom.xml b/spring-cloud-oci-autoconfigure/pom.xml
@@ -88,5 +88,9 @@ Licensed under the Universal Permissive License v 1.0 as shown at https://oss.or
             <groupId>com.oracle.oci.sdk</groupId>
             <artifactId>oci-java-sdk-common-httpclient-jersey3</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-context</artifactId>
+        </dependency>
     </dependencies>
 </project>
diff --git a/spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/autoconfigure/core/CompartmentProviderAutoConfiguration.java b/spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/autoconfigure/core/CompartmentProviderAutoConfiguration.java
@@ -12,6 +12,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.cloud.context.config.annotation.RefreshScope;
 import org.springframework.context.annotation.Bean;
 
 /**
@@ -29,6 +30,7 @@ public CompartmentProviderAutoConfiguration(CompartmentProperties properties) {
     }
 
     @Bean
+    @RefreshScope
     @ConditionalOnMissingBean
     public CompartmentProvider compartmentProvider() {
         return createCompartmentProvider(properties);
diff --git a/spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/autoconfigure/core/CredentialsProviderAutoConfiguration.java b/spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/autoconfigure/core/CredentialsProviderAutoConfiguration.java
@@ -18,6 +18,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.cloud.context.config.annotation.RefreshScope;
 import org.springframework.context.annotation.Bean;
 
 import java.io.IOException;
@@ -47,6 +48,7 @@ public CredentialsProviderAutoConfiguration(CredentialsProperties properties) {
      * @throws IOException
      */
     @Bean (name = credentialsProviderQualifier)
+    @RefreshScope
     @ConditionalOnMissingBean
     public BasicAuthenticationDetailsProvider credentialsProvider() throws IOException {
         return createCredentialsProvider(properties);
diff --git a/spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/autoconfigure/core/RegionProviderAutoConfiguration.java b/spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/autoconfigure/core/RegionProviderAutoConfiguration.java
@@ -12,6 +12,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.cloud.context.config.annotation.RefreshScope;
 import org.springframework.context.annotation.Bean;
 
 /**
@@ -30,6 +31,7 @@ public RegionProviderAutoConfiguration(RegionProperties properties) {
     }
 
     @Bean (name = regionProviderQualifier)
+    @RefreshScope
     @ConditionalOnMissingBean
     public RegionProvider regionProvider() {
         return createRegionProvider(properties);
diff --git a/spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/logging/LoggingAutoConfiguration.java b/spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/logging/LoggingAutoConfiguration.java
@@ -15,6 +15,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.cloud.context.config.annotation.RefreshScope;
 import org.springframework.context.annotation.Bean;
 
 import static com.oracle.cloud.spring.autoconfigure.core.CredentialsProviderAutoConfiguration.credentialsProviderQualifier;
@@ -41,12 +42,14 @@ public LoggingAutoConfiguration(LoggingProperties properties) {
     }
 
     @Bean
+    @RefreshScope
     @ConditionalOnMissingBean(LogService.class)
     LogService getLoggingImpl(Logging logging) {
         return new LogServiceImpl(logging, properties.getLogId());
     }
 
     @Bean
+    @RefreshScope
     @ConditionalOnMissingBean
     Logging loggingClient(@Qualifier(regionProviderQualifier) RegionProvider regionProvider,
                                                           @Qualifier(credentialsProviderQualifier)
diff --git a/spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/notification/NotificationAutoConfiguration.java b/spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/notification/NotificationAutoConfiguration.java
@@ -16,6 +16,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.cloud.context.config.annotation.RefreshScope;
 import org.springframework.context.annotation.Bean;
 
 import static com.oracle.cloud.spring.autoconfigure.core.CredentialsProviderAutoConfiguration.credentialsProviderQualifier;
@@ -35,12 +36,14 @@
 public class NotificationAutoConfiguration {
 
     @Bean
+    @RefreshScope
     @ConditionalOnMissingBean(Notification.class)
     Notification getNotificationImpl(NotificationDataPlane notificationDataPlane, NotificationControlPlane notificationControlPlane ) {
         return new NotificationImpl(notificationDataPlane, notificationControlPlane);
     }
 
     @Bean
+    @RefreshScope
     @ConditionalOnMissingBean
     NotificationDataPlane notificationDataPlaneClient(@Qualifier(regionProviderQualifier) RegionProvider regionProvider,
                                                       @Qualifier(credentialsProviderQualifier)
@@ -51,6 +54,7 @@ NotificationDataPlane notificationDataPlaneClient(@Qualifier(regionProviderQuali
     }
 
     @Bean
+    @RefreshScope
     @ConditionalOnMissingBean
     NotificationControlPlane notificationControlPlaneClient(@Qualifier(regionProviderQualifier) RegionProvider regionProvider,
                                                             @Qualifier(credentialsProviderQualifier)
diff --git a/spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/storage/StorageAutoConfiguration.java b/spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/storage/StorageAutoConfiguration.java
@@ -16,6 +16,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.cloud.context.config.annotation.RefreshScope;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Import;
 
@@ -40,6 +41,7 @@
 public class StorageAutoConfiguration {
 
     @Bean
+    @RefreshScope
     @ConditionalOnMissingBean(Storage.class)
     @ConditionalOnBean(StorageObjectConverter.class)
     Storage storageActions(ObjectStorageClient osClient, StorageObjectConverter storageObjectConverter,
@@ -51,6 +53,7 @@ Storage storageActions(ObjectStorageClient osClient, StorageObjectConverter stor
     }
 
     @Bean
+    @RefreshScope
     @ConditionalOnMissingBean
     ObjectStorageClient objectStorageClient(@Qualifier(regionProviderQualifier) RegionProvider regionProvider,
                                             @Qualifier(credentialsProviderQualifier)
diff --git a/spring-cloud-oci-samples/spring-cloud-oci-logging-sample/pom.xml b/spring-cloud-oci-samples/spring-cloud-oci-logging-sample/pom.xml
@@ -48,6 +48,10 @@ Licensed under the Universal Permissive License v 1.0 as shown at https://oss.or
 			<groupId>org.springdoc</groupId>
 			<artifactId>springdoc-openapi-ui</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-actuator</artifactId>
+		</dependency>
 	</dependencies>
 
 	<build>
diff --git a/spring-cloud-oci-samples/spring-cloud-oci-notification-sample/pom.xml b/spring-cloud-oci-samples/spring-cloud-oci-notification-sample/pom.xml
@@ -52,6 +52,10 @@ Licensed under the Universal Permissive License v 1.0 as shown at https://oss.or
 			<groupId>org.springdoc</groupId>
 			<artifactId>springdoc-openapi-ui</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-actuator</artifactId>
+		</dependency>
 	</dependencies>
 
 	<build>
diff --git a/spring-cloud-oci-samples/spring-cloud-oci-storage-sample/pom.xml b/spring-cloud-oci-samples/spring-cloud-oci-storage-sample/pom.xml
@@ -48,6 +48,10 @@ Licensed under the Universal Permissive License v 1.0 as shown at https://oss.or
              <groupId>org.springdoc</groupId>
              <artifactId>springdoc-openapi-ui</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
     </dependencies>
 
     <build>
