Merge pull request eclipse#534 from Emily-Jiang/configsource-issue

eclipse#431 improve configsource api
dmlloyd · Mar 10, 2020 · 7f2f0b9 · 7f2f0b9
2 parents 102386b + fafb7ce
commit 7f2f0b9
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 22 deletions.
diff --git a/api/src/main/java/org/eclipse/microprofile/config/spi/ConfigSource.java b/api/src/main/java/org/eclipse/microprofile/config/spi/ConfigSource.java
@@ -1,6 +1,6 @@
 /*
  ******************************************************************************
- * Copyright (c) 2009-2018 Contributors to the Eclipse Foundation
+ * Copyright (c) 2009-2020 Contributors to the Eclipse Foundation
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -28,6 +28,7 @@
  *******************************************************************************/
 package org.eclipse.microprofile.config.spi;
 
+import java.util.HashMap;
 import java.util.Map;
 import java.util.Set;
 
@@ -108,10 +109,16 @@ public interface ConfigSource {
  *
  * @return a map containing properties of this configuration source
  */
- Map<String, String> getProperties();
+ default Map<String, String> getProperties() {
+ Map<String, String> props = new HashMap<>();
+ getPropertyNames().stream().forEach((prop) -> props.put(prop, getValue(prop)));
+ return props;
+ }
+
+
 
  /**
- * Gets all property names known to this configuration source, without evaluating the values.
+ * Gets all property names known to this configuration source, potentially without evaluating the values.
  * <p>
  * For backwards compatibility, there is a default implementation that just returns the keys of {@code getProperties()}.
  * Implementations should consider replacing this with a more performant implementation.
@@ -120,9 +127,7 @@ public interface ConfigSource {
  *
  * @return a set of property names that are known to this configuration source
  */
- default Set<String> getPropertyNames() {
- return getProperties().keySet();
- }
+ Set<String> getPropertyNames();
 
  /**
  * Return the ordinal priority value of this configuration source.

diff --git a/api/src/main/java/org/eclipse/microprofile/config/spi/package-info.java b/api/src/main/java/org/eclipse/microprofile/config/spi/package-info.java
@@ -33,5 +33,5 @@
  * @author <a href="mailto:struberg@apache.org">Mark Struberg</a>
  *
  */
-@org.osgi.annotation.versioning.Version("1.4")
+@org.osgi.annotation.versioning.Version("2.0")
 package org.eclipse.microprofile.config.spi;
diff --git a/tck/src/main/java/org/eclipse/microprofile/config/tck/CDIPlainInjectionTest.java b/tck/src/main/java/org/eclipse/microprofile/config/tck/CDIPlainInjectionTest.java
@@ -27,6 +27,7 @@
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Set;
 
 import javax.enterprise.context.Dependent;
 import javax.enterprise.inject.spi.CDI;
@@ -310,5 +311,10 @@ public String getValue(String propertyName) {
  public String getName() {
  return this.getClass().getName();
  }
+
+ @Override
+ public Set<String> getPropertyNames() {
+ return properties.keySet();
+ }
  }
 }
diff --git a/...src/main/java/org/eclipse/microprofile/config/tck/configsources/CustomDbConfigSource.java b/...src/main/java/org/eclipse/microprofile/config/tck/configsources/CustomDbConfigSource.java
@@ -21,6 +21,7 @@
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Set;
 
 import org.eclipse.microprofile.config.spi.ConfigSource;
 
@@ -41,12 +42,6 @@ public CustomDbConfigSource() {
  public int getOrdinal() {
  return 112;
  }
-
- @Override
- public Map<String, String> getProperties() {
- return readPropertiesFromDb();
- }
-
  @Override
  public String getValue(String key) {
  return readPropertyFromDb(key);
@@ -57,13 +52,15 @@ public String getName() {
  return "customDbConfig";
  }
 
- private Map<String, String> readPropertiesFromDb() {
- return configValues;
- }
-
  private String readPropertyFromDb(String key) {
  return configValues.get(key);
  }
 
+ @Override
+ public Set<String> getPropertyNames() {
+
+ return configValues.keySet();
+ }
+
 
 }
diff --git a/...c/main/java/org/eclipse/microprofile/config/tck/configsources/SampleYamlConfigSource.java b/...c/main/java/org/eclipse/microprofile/config/tck/configsources/SampleYamlConfigSource.java
@@ -22,6 +22,7 @@
 import java.net.URL;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Set;
 
 import org.eclipse.microprofile.config.spi.ConfigSource;
 
@@ -40,11 +41,6 @@ public int getOrdinal() {
  return 110;
  }
 
- @Override
- public Map<String, String> getProperties() {
- return config;
- }
-
  @Override
  public String getValue(String key) {
  return config.get(key);
@@ -55,4 +51,10 @@ public String getName() {
  return null;
  }
 
+ @Override
+ public Set<String> getPropertyNames() {
+
+ return config.keySet();
+ }
+
 }