Merge pull request #1127 from OSGP/feature/configurable_thottling_service

Configurable throttling service

Author: kroesctrl

osgp/platform/osgp-secret-management/src/main/resources/logback-spring.xml

@@ -35,7 +35,6 @@ SPDX-License-Identifier: Apache-2.0
   <!-- TRACE, DEBUG, INFO, WARN, ERROR -->
   <logger name="org.opensmartgridplatform.secretmanagement.application" level="DEBUG"/>
   <logger name="org.opensmartgridplatform.adapter.protocol.dlms.application.services.SecretManagementService" level="TRACE"/>
-  <logger name="org.opensmartgridplatform.adapter.protocol.dlms.application.services.ThrottlingService" level="WARN"/>
   <logger name="org.opensmartgridplatform.shared.security.providers" level="DEBUG"/>
 
   <logger name="org.opensmartgridplatform.adapter.ws.endpointinterceptors" level="TRACE"/>

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/application/config/DlmsConfig.java

@@ -21,9 +21,9 @@
 import org.opensmartgridplatform.adapter.protocol.dlms.application.services.DeviceKeyProcessingService;
 import org.opensmartgridplatform.adapter.protocol.dlms.application.services.DomainHelperService;
 import org.opensmartgridplatform.adapter.protocol.dlms.application.services.SecretManagementService;
-import org.opensmartgridplatform.adapter.protocol.dlms.application.services.ThrottlingService;
 import org.opensmartgridplatform.adapter.protocol.dlms.application.threads.RecoverKeyProcess;
 import org.opensmartgridplatform.adapter.protocol.dlms.application.threads.RecoverKeyProcessInitiator;
+import org.opensmartgridplatform.adapter.protocol.dlms.application.throttling.ThrottlingService;
 import org.opensmartgridplatform.adapter.protocol.dlms.domain.factories.DlmsDeviceAssociation;
 import org.opensmartgridplatform.adapter.protocol.dlms.domain.factories.Hls5Connector;
 import org.opensmartgridplatform.adapter.protocol.dlms.domain.factories.Lls0Connector;
@@ -37,7 +37,6 @@
 import org.opensmartgridplatform.shared.infra.networking.DisposableNioEventLoopGroup;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
@@ -167,16 +166,16 @@ public RecoverKeyProcess recoverKeyProcess(
       final DomainHelperService domainHelperService,
       final Hls5Connector hls5Connector,
       final SecretManagementService secretManagementService,
-      @Autowired(required = false) final ThrottlingService throttlingService,
-      final ThrottlingClientConfig throttlingClientConfig,
+      final ThrottlingService throttlingService,
+      final ThrottlingConfig throttlingConfig,
       final DlmsDeviceRepository deviceRepository,
       final DeviceKeyProcessingService deviceKeyProcessingService) {
     return new RecoverKeyProcess(
         domainHelperService,
         hls5Connector,
         secretManagementService,
         throttlingService,
-        throttlingClientConfig,
+        throttlingConfig,
         deviceRepository,
         deviceKeyProcessingService);
   }

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/application/config/ThrottlingClientConfig.java

@@ -4,9 +4,8 @@
 
 package org.opensmartgridplatform.adapter.protocol.dlms.application.config;
 
-import java.security.SecureRandom;
 import java.time.Duration;
-import org.opensmartgridplatform.shared.wsheaderattribute.priority.MessagePriorityEnum;
+import org.opensmartgridplatform.adapter.protocol.dlms.application.config.annotation.SharedThrottlingServiceCondition;
 import org.opensmartgridplatform.throttling.ThrottlingClient;
 import org.opensmartgridplatform.throttling.api.ThrottlingConfig;
 import org.springframework.beans.factory.annotation.Value;
@@ -16,7 +15,6 @@
 
 @Configuration
 public class ThrottlingClientConfig {
-  private static final SecureRandom random = new SecureRandom();
 
   @Value("${throttling.client.enabled:false}")
   private boolean clientEnabled;
@@ -39,15 +37,6 @@ public class ThrottlingClientConfig {
   @Value("#{T(java.time.Duration).parse('${throttling.service.timeout:PT30S}')}")
   private Duration timeout;
 
-  @Value("#{T(java.time.Duration).parse('${throttling.rejected.min.delay:PT50S}')}")
-  private Duration permitRejectedMinDelay;
-
-  @Value("#{T(java.time.Duration).parse('${throttling.rejected.max.delay:PT70S}')}")
-  private Duration permitRejectedMaxDelay;
-
-  @Value("#{T(java.time.Duration).parse('${throttling.rejected.high.prio.delay:PT2S}')}")
-  private Duration permitRejectedHighPrioDelay;
-
   public boolean clientEnabled() {
     return this.clientEnabled;
   }
@@ -57,7 +46,7 @@ public String configurationName() {
   }
 
   @Bean(destroyMethod = "unregister")
-  @Conditional(ThrottlingClientEnabledCondition.class)
+  @Conditional(SharedThrottlingServiceCondition.class)
   public ThrottlingClient throttlingClient() {
     return new ThrottlingClient(
         new ThrottlingConfig(this.configurationName, this.configurationMaxConcurrency),
@@ -66,20 +55,4 @@ public ThrottlingClient throttlingClient() {
         this.maxConnPerRoute,
         this.maxConnTotal);
   }
-
-  /**
-   * Delay to be applied before retrying some action when a requested permit was not granted.
-   *
-   * @return delay
-   */
-  public Duration permitRejectedDelay(final int messagePriority) {
-    if (messagePriority > MessagePriorityEnum.DEFAULT.getPriority()) {
-      return this.permitRejectedHighPrioDelay;
-    }
-    final long minMillis =
-        Math.min(this.permitRejectedMinDelay.toMillis(), this.permitRejectedMaxDelay.toMillis());
-    final long maxMillis =
-        Math.max(this.permitRejectedMinDelay.toMillis(), this.permitRejectedMaxDelay.toMillis());
-    return Duration.ofMillis(this.random.nextLong(minMillis, maxMillis));
-  }
 }

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/application/config/ThrottlingClientEnabledCondition.java

@@ -0,0 +1,41 @@
+// SPDX-FileCopyrightText: Copyright Contributors to the GXF project
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package org.opensmartgridplatform.adapter.protocol.dlms.application.config;
+
+import java.security.SecureRandom;
+import java.time.Duration;
+import org.opensmartgridplatform.shared.wsheaderattribute.priority.MessagePriorityEnum;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class ThrottlingConfig {
+  private static final SecureRandom RANDOM = new SecureRandom();
+
+  @Value("#{T(java.time.Duration).parse('${throttling.rejected.min.delay:PT50S}')}")
+  private Duration permitRejectedMinDelay;
+
+  @Value("#{T(java.time.Duration).parse('${throttling.rejected.max.delay:PT70S}')}")
+  private Duration permitRejectedMaxDelay;
+
+  @Value("#{T(java.time.Duration).parse('${throttling.rejected.high.prio.delay:PT2S}')}")
+  private Duration permitRejectedHighPrioDelay;
+
+  /**
+   * Delay to be applied before retrying some action when a requested permit was not granted.
+   *
+   * @return delay
+   */
+  public Duration permitRejectedDelay(final int messagePriority) {
+    if (messagePriority > MessagePriorityEnum.DEFAULT.getPriority()) {
+      return this.permitRejectedHighPrioDelay;
+    }
+    final long minMillis =
+        Math.min(this.permitRejectedMinDelay.toMillis(), this.permitRejectedMaxDelay.toMillis());
+    final long maxMillis =
+        Math.max(this.permitRejectedMinDelay.toMillis(), this.permitRejectedMaxDelay.toMillis());
+    return Duration.ofMillis(RANDOM.nextLong(minMillis, maxMillis));
+  }
+}

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/application/config/ThrottlingConfig.java

@@ -0,0 +1,11 @@
+// SPDX-FileCopyrightText: Copyright Contributors to the GXF project
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package org.opensmartgridplatform.adapter.protocol.dlms.application.config.annotation;
+
+public class DisabledThrottlingServiceCondition extends ThrottlingTypeCondition {
+  public DisabledThrottlingServiceCondition() {
+    super("disabled");
+  }
+}

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/application/config/ThrottlingServiceEnabledCondition.java

@@ -0,0 +1,11 @@
+// SPDX-FileCopyrightText: Copyright Contributors to the GXF project
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package org.opensmartgridplatform.adapter.protocol.dlms.application.config.annotation;
+
+public class LocalThrottlingServiceCondition extends ThrottlingTypeCondition {
+  public LocalThrottlingServiceCondition() {
+    super("local");
+  }
+}

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/application/config/annotation/DisabledThrottlingServiceCondition.java

@@ -0,0 +1,11 @@
+// SPDX-FileCopyrightText: Copyright Contributors to the GXF project
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package org.opensmartgridplatform.adapter.protocol.dlms.application.config.annotation;
+
+public class SharedThrottlingServiceCondition extends ThrottlingTypeCondition {
+  public SharedThrottlingServiceCondition() {
+    super("shared");
+  }
+}

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/application/config/annotation/LocalThrottlingServiceCondition.java

@@ -0,0 +1,26 @@
+/*
+ * SPDX-FileCopyrightText: Copyright Contributors to the GXF project
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.opensmartgridplatform.adapter.protocol.dlms.application.config.annotation;
+
+import org.springframework.context.annotation.Condition;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.core.type.AnnotatedTypeMetadata;
+
+public abstract class ThrottlingTypeCondition implements Condition {
+
+  private final String throttlingType;
+
+  protected ThrottlingTypeCondition(final String throttlingType) {
+    this.throttlingType = throttlingType;
+  }
+
+  @Override
+  public boolean matches(final ConditionContext context, final AnnotatedTypeMetadata metadata) {
+    return this.throttlingType.equalsIgnoreCase(
+        context.getEnvironment().getProperty("throttling.type"));
+  }
+}