Refactor network API

nbbrd · Jul 6, 2023 · 1ae986f · 1ae986f
1 parent 7545650
commit 1ae986f
Show file tree

Hide file tree

Showing 25 changed files with 350 additions and 205 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 ### Changed
 
 - ![API] Refactor cache API [#500](https://github.com/nbbrd/sdmx-dl/issues/500)
+- ![API] Refactor network API [#503](https://github.com/nbbrd/sdmx-dl/issues/503)
 - ![SOURCE] Update ECB endpoint [#495](https://github.com/nbbrd/sdmx-dl/issues/495)
 - ![FORMAT] Refactor file format API [#502](https://github.com/nbbrd/sdmx-dl/issues/502)
 - ![PROVIDER] Move curl backend to an external project

diff --git a/sdmx-dl-api/src/main/java/internal/sdmxdl/web/DefaultNetwork.java b/sdmx-dl-api/src/main/java/internal/sdmxdl/web/DefaultNetwork.java
@@ -2,11 +2,9 @@
 
 import lombok.NonNull;
 import sdmxdl.web.Network;
+import sdmxdl.web.SSLFactory;
 import sdmxdl.web.URLConnectionFactory;
 
-import javax.net.ssl.HostnameVerifier;
-import javax.net.ssl.HttpsURLConnection;
-import javax.net.ssl.SSLSocketFactory;
 import java.net.ProxySelector;
 
 public enum DefaultNetwork implements Network {
@@ -19,13 +17,8 @@ public enum DefaultNetwork implements Network {
     }
 
     @Override
-    public @NonNull SSLSocketFactory getSSLSocketFactory() {
-        return HttpsURLConnection.getDefaultSSLSocketFactory();
-    }
-
-    @Override
-    public @NonNull HostnameVerifier getHostnameVerifier() {
-        return HttpsURLConnection.getDefaultHostnameVerifier();
+    public @NonNull SSLFactory getSSLFactory() {
+        return SSLFactory.getDefault();
     }
 
     @Override

diff --git a/sdmx-dl-api/src/main/java/internal/sdmxdl/web/DefaultSSLFactory.java b/sdmx-dl-api/src/main/java/internal/sdmxdl/web/DefaultSSLFactory.java
@@ -0,0 +1,23 @@
+package internal.sdmxdl.web;
+
+import lombok.NonNull;
+import sdmxdl.web.SSLFactory;
+
+import javax.net.ssl.HostnameVerifier;
+import javax.net.ssl.HttpsURLConnection;
+import javax.net.ssl.SSLSocketFactory;
+
+public enum DefaultSSLFactory implements SSLFactory {
+
+    INSTANCE;
+
+    @Override
+    public @NonNull SSLSocketFactory getSSLSocketFactory() {
+        return HttpsURLConnection.getDefaultSSLSocketFactory();
+    }
+
+    @Override
+    public @NonNull HostnameVerifier getHostnameVerifier() {
+        return HttpsURLConnection.getDefaultHostnameVerifier();
+    }
+}
diff --git a/sdmx-dl-api/src/main/java/internal/sdmxdl/web/spi/DefaultNetworking.java b/sdmx-dl-api/src/main/java/internal/sdmxdl/web/spi/DefaultNetworking.java
@@ -0,0 +1,39 @@
+package internal.sdmxdl.web.spi;
+
+import lombok.NonNull;
+import sdmxdl.web.Network;
+import sdmxdl.web.SdmxWebSource;
+import sdmxdl.web.spi.Networking;
+
+import java.util.Collection;
+import java.util.Collections;
+
+public enum DefaultNetworking implements Networking {
+
+    INSTANCE;
+
+    @Override
+    public @NonNull String getNetworkingId() {
+        return "DEFAULT";
+    }
+
+    @Override
+    public int getNetworkingRank() {
+        return UNKNOWN_NETWORKING_RANK;
+    }
+
+    @Override
+    public boolean isNetworkingAvailable() {
+        return true;
+    }
+
+    @Override
+    public @NonNull Collection<String> getNetworkingProperties() {
+        return Collections.emptyList();
+    }
+
+    @Override
+    public @NonNull Network getNetwork(@NonNull SdmxWebSource source) {
+        return Network.getDefault();
+    }
+}
diff --git a/sdmx-dl-api/src/main/java/module-info.java b/sdmx-dl-api/src/main/java/module-info.java
@@ -18,6 +18,7 @@
     uses sdmxdl.ext.spi.CacheProvider;
     uses sdmxdl.ext.spi.Dialect;
     uses sdmxdl.file.spi.FileReader;
+    uses sdmxdl.web.spi.Networking;
     uses sdmxdl.web.spi.WebAuthenticator;
     uses sdmxdl.web.spi.WebDriver;
     uses sdmxdl.web.spi.WebMonitoring;

diff --git a/sdmx-dl-api/src/main/java/sdmxdl/ext/spi/CacheProvider.java b/sdmx-dl-api/src/main/java/sdmxdl/ext/spi/CacheProvider.java
@@ -2,6 +2,7 @@
 
 import internal.sdmxdl.NoOpCacheProvider;
 import lombok.NonNull;
+import nbbrd.design.StaticFactoryMethod;
 import nbbrd.service.Quantifier;
 import nbbrd.service.ServiceDefinition;
 import nbbrd.service.ServiceId;
@@ -36,6 +37,7 @@ public interface CacheProvider {
 
     int UNKNOWN_RANK = -1;
 
+    @StaticFactoryMethod
     static @NonNull CacheProvider noOp() {
         return NoOpCacheProvider.INSTANCE;
     }

diff --git a/sdmx-dl-api/src/main/java/sdmxdl/web/Network.java b/sdmx-dl-api/src/main/java/sdmxdl/web/Network.java
@@ -2,21 +2,21 @@
 
 import internal.sdmxdl.web.DefaultNetwork;
 import lombok.NonNull;
+import nbbrd.design.NotThreadSafe;
+import nbbrd.design.StaticFactoryMethod;
 
-import javax.net.ssl.HostnameVerifier;
-import javax.net.ssl.SSLSocketFactory;
 import java.net.ProxySelector;
 
+@NotThreadSafe
 public interface Network {
 
     @NonNull ProxySelector getProxySelector();
 
-    @NonNull SSLSocketFactory getSSLSocketFactory();
-
-    @NonNull HostnameVerifier getHostnameVerifier();
+    @NonNull SSLFactory getSSLFactory();
 
     @NonNull URLConnectionFactory getURLConnectionFactory();
 
+    @StaticFactoryMethod
     static @NonNull Network getDefault() {
         return DefaultNetwork.INSTANCE;
     }

diff --git a/sdmx-dl-api/src/main/java/sdmxdl/web/SSLFactory.java b/sdmx-dl-api/src/main/java/sdmxdl/web/SSLFactory.java
@@ -0,0 +1,22 @@
+package sdmxdl.web;
+
+import internal.sdmxdl.web.DefaultSSLFactory;
+import lombok.NonNull;
+import nbbrd.design.NotThreadSafe;
+import nbbrd.design.StaticFactoryMethod;
+
+import javax.net.ssl.HostnameVerifier;
+import javax.net.ssl.SSLSocketFactory;
+
+@NotThreadSafe
+public interface SSLFactory {
+
+    @NonNull SSLSocketFactory getSSLSocketFactory();
+
+    @NonNull HostnameVerifier getHostnameVerifier();
+
+    @StaticFactoryMethod
+    static @NonNull SSLFactory getDefault() {
+        return DefaultSSLFactory.INSTANCE;
+    }
+}
diff --git a/sdmx-dl-api/src/main/java/sdmxdl/web/SdmxWebManager.java b/sdmx-dl-api/src/main/java/sdmxdl/web/SdmxWebManager.java
@@ -16,10 +16,7 @@
  */
 package sdmxdl.web;
 
-import internal.util.CacheProviderLoader;
-import internal.util.WebAuthenticatorLoader;
-import internal.util.WebDriverLoader;
-import internal.util.WebMonitoringLoader;
+import internal.util.*;
 import lombok.AccessLevel;
 import lombok.NonNull;
 import nbbrd.design.StaticFactoryMethod;
@@ -28,10 +25,7 @@
 import sdmxdl.SdmxManager;
 import sdmxdl.ext.SdmxSourceConsumer;
 import sdmxdl.ext.spi.CacheProvider;
-import sdmxdl.web.spi.WebAuthenticator;
-import sdmxdl.web.spi.WebContext;
-import sdmxdl.web.spi.WebDriver;
-import sdmxdl.web.spi.WebMonitoring;
+import sdmxdl.web.spi.*;
 
 import java.io.IOException;
 import java.net.URI;
@@ -57,6 +51,7 @@ public class SdmxWebManager extends SdmxManager<SdmxWebSource> {
                 .builder()
                 .drivers(WebDriverLoader.load())
                 .monitorings(WebMonitoringLoader.load())
+                .networking(NetworkingLoader.load())
                 .cacheProvider(CacheProviderLoader.load())
                 .authenticators(WebAuthenticatorLoader.load())
                 .build();
@@ -81,7 +76,7 @@ public class SdmxWebManager extends SdmxManager<SdmxWebSource> {
 
     @lombok.NonNull
     @lombok.Builder.Default
-    Network network = Network.getDefault();
+    Networking networking = Networking.getDefault();
 
     @lombok.NonNull
     @lombok.Builder.Default
@@ -191,7 +186,7 @@ private WebContext initContext() {
                 .builder()
                 .cacheProvider(cacheProvider)
                 .languages(languages)
-                .network(network)
+                .networking(networking)
                 .eventListener(eventListener)
                 .authenticators(authenticators)
                 .build();

diff --git a/sdmx-dl-api/src/main/java/sdmxdl/web/spi/Networking.java b/sdmx-dl-api/src/main/java/sdmxdl/web/spi/Networking.java
@@ -0,0 +1,40 @@
+package sdmxdl.web.spi;
+
+import internal.sdmxdl.web.spi.DefaultNetworking;
+import lombok.NonNull;
+import nbbrd.design.StaticFactoryMethod;
+import nbbrd.design.ThreadSafe;
+import nbbrd.service.*;
+import sdmxdl.web.Network;
+import sdmxdl.web.SdmxWebSource;
+
+import java.util.Collection;
+
+@ServiceDefinition(
+        quantifier = Quantifier.SINGLE,
+        loaderName = "internal.util.NetworkingLoader",
+        fallback = DefaultNetworking.class
+)
+@ThreadSafe
+public interface Networking {
+
+    @ServiceId
+    @NonNull String getNetworkingId();
+
+    @ServiceSorter(reverse = true)
+    int getNetworkingRank();
+
+    @ServiceFilter
+    boolean isNetworkingAvailable();
+
+    @NonNull Collection<String> getNetworkingProperties();
+
+    @NonNull Network getNetwork(@NonNull SdmxWebSource source);
+
+    int UNKNOWN_NETWORKING_RANK = -1;
+
+    @StaticFactoryMethod
+    static @NonNull Networking getDefault() {
+        return DefaultNetworking.INSTANCE;
+    }
+}
diff --git a/sdmx-dl-api/src/main/java/sdmxdl/web/spi/WebContext.java b/sdmx-dl-api/src/main/java/sdmxdl/web/spi/WebContext.java
@@ -52,9 +52,13 @@ public class WebContext {
 
     @lombok.NonNull
     @lombok.Builder.Default
-    Network network = Network.getDefault();
+    Networking networking = Networking.getDefault();
 
     public @NonNull Cache getCache(@NonNull SdmxWebSource source) {
         return getCacheProvider().getWebCache(source, getEventListener());
     }
+
+    public @NonNull Network getNetwork(@NonNull SdmxWebSource source) {
+        return getNetworking().getNetwork(source);
+    }
 }
diff --git a/sdmx-dl-api/src/test/java/sdmxdl/web/SdmxWebManagerTest.java b/sdmx-dl-api/src/test/java/sdmxdl/web/SdmxWebManagerTest.java
@@ -20,6 +20,7 @@
 import sdmxdl.*;
 import sdmxdl.ext.spi.CacheProvider;
 import sdmxdl.ext.spi.Dialect;
+import sdmxdl.web.spi.Networking;
 import sdmxdl.web.spi.WebDriver;
 import tests.sdmxdl.api.SdmxManagerAssert;
 import tests.sdmxdl.ext.MockedDialect;
@@ -60,7 +61,7 @@ public void testFactories() {
             assertThat(o.getDrivers()).isEmpty();
             assertThat(o.getMonitorings()).isEmpty();
             assertThat(o.getLanguages()).isEqualTo(LanguagePriorityList.ANY);
-            assertThat(o.getNetwork()).isEqualTo(Network.getDefault());
+            assertThat(o.getNetworking()).isEqualTo(Networking.getDefault());
             assertThat(o.getCacheProvider()).isEqualTo(CacheProvider.noOp());
             assertThat(o.getEventListener()).isEqualTo(SdmxManager.NO_OP_EVENT_LISTENER);
             assertThat(o.getAuthenticators()).isEmpty();
@@ -73,7 +74,7 @@ public void testFactories() {
             assertThat(o.getDrivers()).isEmpty();
             assertThat(o.getMonitorings()).isEmpty();
             assertThat(o.getLanguages()).isEqualTo(LanguagePriorityList.ANY);
-            assertThat(o.getNetwork()).isEqualTo(Network.getDefault());
+            assertThat(o.getNetworking()).isEqualTo(Networking.getDefault());
             assertThat(o.getCacheProvider()).isEqualTo(CacheProvider.noOp());
             assertThat(o.getEventListener()).isEqualTo(SdmxManager.NO_OP_EVENT_LISTENER);
             assertThat(o.getAuthenticators()).isEmpty();
@@ -85,7 +86,7 @@ public void testFactories() {
             assertThat(o.getDrivers()).containsExactly(sampleDriver);
             assertThat(o.getMonitorings()).isEmpty();
             assertThat(o.getLanguages()).isEqualTo(LanguagePriorityList.ANY);
-            assertThat(o.getNetwork()).isEqualTo(Network.getDefault());
+            assertThat(o.getNetworking()).isEqualTo(Networking.getDefault());
             assertThat(o.getCacheProvider()).isEqualTo(CacheProvider.noOp());
             assertThat(o.getEventListener()).isEqualTo(SdmxManager.NO_OP_EVENT_LISTENER);
             assertThat(o.getAuthenticators()).isEmpty();

diff --git a/sdmx-dl-api/src/test/java/tests/sdmxdl/ext/NetworkAssert.java b/sdmx-dl-api/src/test/java/tests/sdmxdl/ext/NetworkAssert.java
@@ -12,8 +12,8 @@ public void assertCompliance(Network network) {
     }
 
     public void assertCompliance(SoftAssertions s, Network network) {
-        s.assertThat(network.getHostnameVerifier()).isNotNull();
-        s.assertThat(network.getSSLSocketFactory()).isNotNull();
         s.assertThat(network.getProxySelector()).isNotNull();
+        s.assertThat(network.getSSLFactory()).isNotNull();
+        s.assertThat(network.getURLConnectionFactory()).isNotNull();
     }
 }