Allow custom configuration for the CustomConnectivityCommandIntercept…

…orProvider extension Signed-off-by: Yannic Klem <yannic.klem@bosch.io>
eclipse-ditto · Jul 12, 2022 · 21867b5 · 21867b5
1 parent 3cd249d
commit 21867b5
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 13 deletions.
diff --git a/.../eclipse/ditto/connectivity/service/messaging/persistence/ConnectionPersistenceActor.java b/.../eclipse/ditto/connectivity/service/messaging/persistence/ConnectionPersistenceActor.java
@@ -1196,8 +1196,10 @@ private ConnectivityCommandInterceptor getCommandValidator() {
                         connectionValidator,
                         actorSystem);
 
+        final Config dittoExtensionsConfig = ScopedConfig.dittoExtension(actorSystem.settings().config());
         final var customCommandValidator =
-                CustomConnectivityCommandInterceptorProvider.get(actorSystem).getCommandInterceptor();
+                CustomConnectivityCommandInterceptorProvider.get(actorSystem, dittoExtensionsConfig)
+                        .getCommandInterceptor();
         return new CompoundConnectivityCommandInterceptor(dittoCommandValidator, customCommandValidator);
     }
 

diff --git a/...nnectivity/service/messaging/validation/CustomConnectivityCommandInterceptorProvider.java b/...nnectivity/service/messaging/validation/CustomConnectivityCommandInterceptorProvider.java
@@ -14,9 +14,12 @@
 
 import static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull;
 
+import org.eclipse.ditto.base.service.DittoExtensionIds;
 import org.eclipse.ditto.base.service.DittoExtensionPoint;
 import org.eclipse.ditto.connectivity.model.signals.commands.ConnectivityCommandInterceptor;
 
+import com.typesafe.config.Config;
+
 import akka.actor.ActorSystem;
 
 public interface CustomConnectivityCommandInterceptorProvider extends DittoExtensionPoint {
@@ -28,21 +31,30 @@ public interface CustomConnectivityCommandInterceptorProvider extends DittoExten
      * {@code ActorSystem}.
      *
      * @param actorSystem the actorSystem in which the {@code CustomConnectivityCommandInterceptorProvider} should be loaded.
+     * @param config the configuration of this extension.
      * @return the {@code CustomConnectivityCommandInterceptorProvider} implementation.
      * @throws NullPointerException if {@code actorSystem} is {@code null}.
      */
-    static CustomConnectivityCommandInterceptorProvider get(final ActorSystem actorSystem) {
+    static CustomConnectivityCommandInterceptorProvider get(final ActorSystem actorSystem, final Config config) {
         checkNotNull(actorSystem, "actorSystem");
-        return ExtensionId.INSTANCE.get(actorSystem);
+        checkNotNull(config, "config");
+        final var extensionIdConfig = ExtensionId.computeConfig(config);
+        return DittoExtensionIds.get(actorSystem)
+                .computeIfAbsent(extensionIdConfig, ExtensionId::new)
+                .get(actorSystem);
     }
 
     final class ExtensionId extends DittoExtensionPoint.ExtensionId<CustomConnectivityCommandInterceptorProvider> {
 
-        private static final String CONFIG_PATH = "ditto.connectivity.connection.custom-command-interceptor-provider";
-        private static final ExtensionId INSTANCE = new ExtensionId(CustomConnectivityCommandInterceptorProvider.class);
+        private static final String CONFIG_KEY = "custom-connectivity-command-interceptor-provider";
+        private static final String CONFIG_PATH = "ditto.extensions." + CONFIG_KEY;
+
+        private ExtensionId(final ExtensionIdConfig<CustomConnectivityCommandInterceptorProvider> extensionIdConfig) {
+            super(extensionIdConfig);
+        }
 
-        private ExtensionId(final Class<CustomConnectivityCommandInterceptorProvider> parentClass) {
-            super(parentClass);
+        static ExtensionIdConfig<CustomConnectivityCommandInterceptorProvider> computeConfig(final Config config) {
+            return ExtensionIdConfig.of(CustomConnectivityCommandInterceptorProvider.class, config, CONFIG_KEY);
         }
 
         @Override

diff --git a/connectivity/service/src/main/resources/connectivity.conf b/connectivity/service/src/main/resources/connectivity.conf
@@ -40,6 +40,8 @@ ditto {
       }
     }
     connection-enforcer-actor-props-factory = org.eclipse.ditto.connectivity.service.enforcement.NoOpEnforcerActorPropsFactory
+    # Provider for a custom connectivity-command interceptor.
+    custom-connectivity-command-interceptor-provider = "org.eclipse.ditto.connectivity.service.messaging.validation.NoOpConnectivityCommandInterceptorProvider"
   }
 
   persistence.operations.delay-after-persistence-actor-shutdown = 5s
@@ -175,10 +177,6 @@ ditto {
       double-decoding-enabled = true
       double-decoding-enabled = ${?CONNECTIVITY_DOUBLE_DECODING_ENABLED}
 
-      # Provider for a custom connectivity-command interceptor.
-      custom-command-interceptor-provider = "org.eclipse.ditto.connectivity.service.messaging.validation.NoOpConnectivityCommandInterceptorProvider"
-      custom-command-interceptor-provider = ${?CONNECTIVITY_CUSTOM_COMMAND_INTERCEPTOR_PROVIDER}
-
       acknowledgement {
         # lifetime of ack forwarder. Must be bigger than the largest possible command timeout (60s)
         forwarder-fallback-timeout = 65s

diff --git a/...ipse/ditto/connectivity/service/messaging/persistence/ConnectionPersistenceActorTest.java b/...ipse/ditto/connectivity/service/messaging/persistence/ConnectionPersistenceActorTest.java
@@ -144,7 +144,7 @@ public final class ConnectionPersistenceActorTest extends WithMockServers {
             ConfigFactory.parseMap(Map.of(
                             "ditto.extensions.client-actor-props-factory",
                             "org.eclipse.ditto.connectivity.service.messaging.MockClientActorPropsFactory",
-                            "ditto.connectivity.connection.custom-command-interceptor-provider",
+                            "ditto.extensions.custom-connectivity-command-interceptor-provider",
                             "org.eclipse.ditto.connectivity.service.messaging.ExceptionalCommandValidator"
                     )).withFallback(TestConstants.CONFIG));
 

diff --git a/connectivity/service/src/test/resources/test.conf b/connectivity/service/src/test/resources/test.conf
@@ -30,6 +30,7 @@ ditto {
       }
     }
     connection-enforcer-actor-props-factory = org.eclipse.ditto.connectivity.service.enforcement.NoOpEnforcerActorPropsFactory
+    custom-connectivity-command-interceptor-provider = org.eclipse.ditto.connectivity.service.messaging.validation.NoOpConnectivityCommandInterceptorProvider
   }
   mapping-strategy.implementation = "org.eclipse.ditto.connectivity.api.ConnectivityMappingStrategies"
   pre-enforcers = [
@@ -58,7 +59,6 @@ ditto {
       {exceptionName: "org.apache.qpid.jms.provider.exceptions.ProviderSecurityException", messagePattern: ".*"}
     ]
     connection {
-      custom-command-interceptor-provider = org.eclipse.ditto.connectivity.service.messaging.validation.NoOpConnectivityCommandInterceptorProvider
       // allow localhost in unit tests
       blocked-hostnames = ""