Add URI Loader SPI

avaje-config-toml/src/main/java/module-info.java

@@ -1,12 +1,13 @@
+import io.avaje.config.ConfigExtension;
 import io.avaje.config.toml.TomlParser;
 
 module io.avaje.config.toml {
 
-  requires io.avaje.config;
+  requires transitive io.avaje.config;
   requires org.tomlj;
 
   exports io.avaje.config.toml;
 
-  provides io.avaje.config.ConfigExtension with TomlParser;
+  provides ConfigExtension with TomlParser;
 
 }

avaje-config/src/main/java/io/avaje/config/Parsers.java → avaje-config/src/main/java/io/avaje/config/ConfigParsers.java

@@ -6,13 +6,13 @@
 import java.util.Set;
 
 /**
- * Holds the non-properties ConfigParsers.
+ * Holds the ConfigParsers for various extension types.
  */
-final class Parsers {
+public final class ConfigParsers {
 
   private final Map<String, ConfigParser> parserMap = new HashMap<>();
 
-  Parsers(List<ConfigParser> otherParsers) {
+  ConfigParsers(List<ConfigParser> otherParsers) {
     parserMap.put("properties", new PropertiesParser());
     if (!"true".equals(System.getProperty("skipYaml"))) {
       initYamlParser();
@@ -45,28 +45,28 @@ private void initParsers(List<ConfigParser> otherParsers) {
   /**
    * Return the extension ConfigParser pairs.
    */
-  Set<Map.Entry<String, ConfigParser>> entrySet() {
+  public Set<Map.Entry<String, ConfigParser>> entrySet() {
     return parserMap.entrySet();
   }
 
   /**
    * Return the ConfigParser for the given extension.
    */
-  ConfigParser get(String extension) {
+  public ConfigParser get(String extension) {
     return parserMap.get(extension.toLowerCase());
   }
 
   /**
    * Return true if the extension has a matching parser.
    */
-  boolean supportsExtension(String extension) {
+  public boolean supportsExtension(String extension) {
     return parserMap.containsKey(extension.toLowerCase());
   }
 
   /**
    * Return the set of supported extensions.
    */
-  Set<String> supportedExtensions() {
+  public Set<String> supportedExtensions() {
     return parserMap.keySet();
   }
 }

avaje-config/src/main/java/io/avaje/config/ConfigServiceLoader.java

@@ -5,8 +5,8 @@
 import java.util.ServiceLoader;
 
 /**
- * Load all the avaje-config extensions via ServiceLoader using the single
- * common ConfigExtension interface.
+ * Load all the avaje-config extensions via ServiceLoader using the single common ConfigExtension
+ * interface.
  */
 final class ConfigServiceLoader {
 
@@ -21,13 +21,15 @@ static ConfigServiceLoader get() {
   private final ModificationEventRunner eventRunner;
   private final List<ConfigurationSource> sources = new ArrayList<>();
   private final List<ConfigurationPlugin> plugins = new ArrayList<>();
-  private final Parsers parsers;
+  private final URILoaders uriLoaders;
+  private final ConfigParsers parsers;
 
   ConfigServiceLoader() {
     ModificationEventRunner _eventRunner = null;
     ConfigurationLog _log = null;
     ResourceLoader _resourceLoader = null;
     List<ConfigParser> otherParsers = new ArrayList<>();
+    List<URIConfigLoader> loaders = new ArrayList<>();
 
     for (var spi : ServiceLoader.load(ConfigExtension.class)) {
       if (spi instanceof ConfigurationSource) {
@@ -36,6 +38,8 @@ static ConfigServiceLoader get() {
         plugins.add((ConfigurationPlugin) spi);
       } else if (spi instanceof ConfigParser) {
         otherParsers.add((ConfigParser) spi);
+      } else if (spi instanceof URIConfigLoader) {
+        loaders.add((URIConfigLoader) spi);
       } else if (spi instanceof ConfigurationLog) {
         _log = (ConfigurationLog) spi;
       } else if (spi instanceof ResourceLoader) {
@@ -47,14 +51,20 @@ static ConfigServiceLoader get() {
 
     this.log = _log == null ? new DefaultConfigurationLog() : _log;
     this.resourceLoader = _resourceLoader == null ? new DefaultResourceLoader() : _resourceLoader;
-    this.eventRunner = _eventRunner == null ? new CoreConfiguration.ForegroundEventRunner() : _eventRunner;
-    this.parsers = new Parsers(otherParsers);
+    this.eventRunner =
+        _eventRunner == null ? new CoreConfiguration.ForegroundEventRunner() : _eventRunner;
+    this.parsers = new ConfigParsers(otherParsers);
+    this.uriLoaders = new URILoaders(loaders);
   }
 
-  Parsers parsers() {
+  ConfigParsers parsers() {
     return parsers;
   }
 
+  public URILoaders uriLoaders() {
+    return uriLoaders;
+  }
+
   ConfigurationLog log() {
     return log;
   }

avaje-config/src/main/java/io/avaje/config/CoreComponents.java

@@ -1,20 +1,27 @@
 package io.avaje.config;
 
-import java.util.Collections;
 import java.util.List;
 
 final class CoreComponents {
 
   private final ModificationEventRunner runner;
   private final ConfigurationLog log;
-  private final Parsers parsers;
+  private final ConfigParsers parsers;
+  private final URILoaders uriLoaders;
   private final List<ConfigurationSource> sources;
   private final List<ConfigurationPlugin> plugins;
 
-  CoreComponents(ModificationEventRunner runner, ConfigurationLog log, Parsers parsers, List<ConfigurationSource> sources, List<ConfigurationPlugin> plugins) {
+  CoreComponents(
+      ModificationEventRunner runner,
+      ConfigurationLog log,
+      ConfigParsers parsers,
+      URILoaders uriLoaders,
+      List<ConfigurationSource> sources,
+      List<ConfigurationPlugin> plugins) {
     this.runner = runner;
     this.log = log;
     this.parsers = parsers;
+    this.uriLoaders = uriLoaders;
     this.sources = sources;
     this.plugins = plugins;
   }
@@ -23,15 +30,20 @@ final class CoreComponents {
   CoreComponents() {
     this.runner = new CoreConfiguration.ForegroundEventRunner();
     this.log = new DefaultConfigurationLog();
-    this.parsers = new Parsers(Collections.emptyList());
-    this.sources = Collections.emptyList();
-    this.plugins = Collections.emptyList();
+    this.parsers = new ConfigParsers(List.of());
+    this.uriLoaders = new URILoaders(List.of());
+    this.sources = List.of();
+    this.plugins = List.of();
   }
 
-  Parsers parsers() {
+  ConfigParsers parsers() {
     return parsers;
   }
 
+  public URILoaders uriLoaders() {
+    return uriLoaders;
+  }
+
   ConfigurationLog log() {
     return log;
   }

avaje-config/src/main/java/io/avaje/config/CoreConfiguration.java

@@ -27,7 +27,7 @@
 @NullMarked
 final class CoreConfiguration implements Configuration {
 
-  private final Parsers parsers;
+  private final ConfigParsers parsers;
   private final ConfigurationLog log;
   private final ModifyAwareProperties properties;
   private final ReentrantLock lock = new ReentrantLock();

avaje-config/src/main/java/io/avaje/config/CoreConfigurationBuilder.java

@@ -18,7 +18,8 @@ final class CoreConfigurationBuilder implements Configuration.Builder {
 
   private final CoreEntry.CoreMap sourceMap = CoreEntry.newMap();
   private final ConfigServiceLoader serviceLoader = ConfigServiceLoader.get();
-  private final Parsers parsers = serviceLoader.parsers();
+  private final ConfigParsers parsers = serviceLoader.parsers();
+  private final URILoaders uriLoaders = serviceLoader.uriLoaders();
   private ConfigurationLog log = serviceLoader.log();
   private ResourceLoader resourceLoader = serviceLoader.resourceLoader();
   private ModificationEventRunner eventRunner = serviceLoader.eventRunner();
@@ -130,7 +131,14 @@ public Configuration.Builder includeResourceLoading() {
 
   @Override
   public Configuration build() {
-    var components = new CoreComponents(eventRunner, log, parsers, serviceLoader.sources(), serviceLoader.plugins());
+    var components =
+        new CoreComponents(
+            eventRunner,
+            log,
+            parsers,
+            uriLoaders,
+            serviceLoader.sources(),
+            serviceLoader.plugins());
     if (includeResourceLoading) {
       log.preInitialisation();
       initialLoader = new InitialLoader(components, resourceLoader);

avaje-config/src/main/java/io/avaje/config/FileWatch.java

@@ -11,12 +11,12 @@ final class FileWatch {
 
   private final ConfigurationLog log;
   private final Configuration configuration;
-  private final Parsers parsers;
+  private final ConfigParsers parsers;
   private final List<Entry> files;
   private final long delay;
   private final long period;
 
-  FileWatch(CoreConfiguration configuration, List<File> loadedFiles, Parsers parsers) {
+  FileWatch(CoreConfiguration configuration, List<File> loadedFiles, ConfigParsers parsers) {
     this.log = configuration.log();
     this.configuration = configuration;
     this.delay = configuration.getLong("config.watch.delay", 60);

avaje-config/src/main/java/io/avaje/config/InitialLoader.java

@@ -3,11 +3,13 @@
 import static io.avaje.config.InitialLoader.Source.FILE;
 import static io.avaje.config.InitialLoader.Source.RESOURCE;
 import static java.lang.System.Logger.Level.WARNING;
+import static java.util.stream.Collectors.joining;
 
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.UncheckedIOException;
+import java.net.URI;
 import java.util.*;
 import java.util.regex.Pattern;
 
@@ -41,10 +43,12 @@ enum Source {
   private final ConfigurationLog log;
   private final InitialLoadContext loadContext;
   private final Set<String> profileResourceLoaded = new HashSet<>();
-  private final Parsers parsers;
+  private final ConfigParsers parsers;
+  private final URILoaders uriLoaders;
 
   InitialLoader(CoreComponents components, ResourceLoader resourceLoader) {
     this.parsers = components.parsers();
+    this.uriLoaders = components.uriLoaders();
     this.log = components.log();
     this.loadContext = new InitialLoadContext(log, resourceLoader);
   }
@@ -253,8 +257,17 @@ private void loadViaSystemProperty() {
   }
 
   boolean loadWithExtensionCheck(String fileName) {
+
+    // no need to custom URL load regular cp and file schemes
+    fileName = fileName.replace("classpath:/", "").replace("file:/", "");
+    if (fileName.contains(":/")) {
+
+      return loadURI(fileName);
+    }
+
     var extension = fileName.substring(fileName.lastIndexOf(".") + 1);
     if ("properties".equals(extension)) {
+
       return loadProperties(fileName, RESOURCE) | loadProperties(fileName, FILE);
     } else {
       var parser = parsers.get(extension);
@@ -272,6 +285,23 @@ boolean loadWithExtensionCheck(String fileName) {
     }
   }
 
+  private boolean loadURI(String uriPath) {
+    var uri = URI.create(uriPath);
+    final var scheme = uri.getScheme();
+    var loader = uriLoaders.get(scheme);
+    if (loader != null) {
+      loader.load(uri, parsers).forEach((k, v) -> loadContext.put(k, v, "uri scheme " + scheme));
+      return true;
+    }
+
+    throw new IllegalArgumentException(
+        "Expecting only properties or "
+            + uriLoaders.supportedSchemes().stream().map(s -> s + ":/").collect(joining(","))
+            + " uris but got ["
+            + uriPath
+            + "]");
+  }
+
   /**
    * Evaluate all the configuration entries and return as properties.
    */

avaje-config/src/main/java/io/avaje/config/URIConfigLoader.java

@@ -0,0 +1,24 @@
+package io.avaje.config;
+
+import java.net.URI;
+import java.util.Map;
+
+/** Additional source to load and update configuration. */
+public interface URIConfigLoader extends ConfigExtension {
+
+  /** URI Scheme Supported by this loader */
+  String supportedScheme();
+
+  /**
+   * Load additional configuration.
+   *
+   * <p>The {@link Configuration#setProperty(String, String)} method is used when loading the
+   * additional properties from the source.
+   *
+   * <p>Also note that the source can additionally use {@link Configuration#schedule(long, long,
+   * Runnable)} to schedule a period task to for example refresh data etc.
+   *
+   * @param configuration The configuration with initially properties.
+   */
+  Map<String, String> load(URI uri, ConfigParsers parsers);
+}

avaje-config/src/main/java/io/avaje/config/URILoaders.java

@@ -0,0 +1,40 @@
+package io.avaje.config;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.Set;
+
+/** Holds the non-properties ConfigParsers. */
+public final class URILoaders {
+
+  private final Map<String, URIConfigLoader> parserMap = new HashMap<>();
+
+  URILoaders(List<URIConfigLoader> loaders) {
+    for (var parser : loaders) {
+
+      parserMap.put(parser.supportedScheme(), parser);
+    }
+  }
+
+  /** Return the extension ConfigParser pairs. */
+  public Set<Entry<String, URIConfigLoader>> entrySet() {
+    return parserMap.entrySet();
+  }
+
+  /** Return the ConfigParser for the given extension. */
+  public URIConfigLoader get(String extension) {
+    return parserMap.get(extension.toLowerCase());
+  }
+
+  /** Return true if the extension has a matching parser. */
+  public boolean supportsScheme(String extension) {
+    return parserMap.containsKey(extension.toLowerCase());
+  }
+
+  /** Return the set of supported extensions. */
+  public Set<String> supportedSchemes() {
+    return parserMap.keySet();
+  }
+}

avaje-config/src/test/java/io/avaje/config/FileWatchTest.java

@@ -137,7 +137,7 @@ void test_check_whenFileWritten() throws Exception {
   }
 
   private static FileWatch fileWatch(CoreConfiguration config, List<File> files) {
-    return new FileWatch(config, files, new Parsers(Collections.emptyList()));
+    return new FileWatch(config, files, new ConfigParsers(Collections.emptyList()));
   }
 
   private void writeContent(String content) throws IOException {