fix: consolidate callbackAddress and hostname (#1447)

fix: consolidate callbackAddress and hostname (#1447)

Author: carlos-schmidt

charts/faaast-service/Chart.yaml

@@ -11,7 +11,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.0.0
+version: 1.0.1
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/faaast-service/values.full.yaml

@@ -66,7 +66,6 @@ core:
   assetConnectionReadMaxThreadPoolSize: 1000
   assetConnectionReadTimeout: 5000
   assetConnectionWriteMaxThreadPoolSize: 1000
-  callbackAddress: "https://invalid.local:443/mypath"
   requestHandlerThreadPoolSize: 2
   submodelRegistries:
     - "http://example.com/MySubmodelRegistry"
@@ -137,7 +136,7 @@ endpoints:
     corsEnabled: true
     corsExposedHeaders: "X-Custom-Header"
     corsMaxAge: 1000
-    hostname: "localhost"
+    hostname: "https://example.invalid"
     httpVersion: "HTTP_2"
     pathPrefix: "/api/v3.0"
     includeErrorDetails: true

charts/faaast-service/values.yaml

@@ -46,7 +46,6 @@ core: {}
 # core:
 #   operationTimeout: 60000           # ms, 0 = no timeout
 #   assetConnectionReadTimeout: 30000 # ms
-#   callbackAddress: "https://faaast.example.com"
 #   validationOnLoad:
 #     validateConstraints: true
 #     idShortUniqueness: true

core/src/main/java/de/fraunhofer/iosb/ilt/faaast/service/Service.java

@@ -200,6 +200,12 @@ public AssetConnectionManager getAssetConnectionManager() {
     }
 
 
+    @Override
+    public List<Endpoint> getEndpoints() {
+        return endpoints;
+    }
+
+
     public ServiceConfig getConfig() {
         return config;
     }

core/src/main/java/de/fraunhofer/iosb/ilt/faaast/service/ServiceContext.java

@@ -24,6 +24,7 @@
 import de.fraunhofer.iosb.ilt.faaast.service.model.exception.ResourceNotFoundException;
 import de.fraunhofer.iosb.ilt.faaast.service.persistence.Persistence;
 import de.fraunhofer.iosb.ilt.faaast.service.typing.TypeInfo;
+import java.util.List;
 import org.eclipse.digitaltwin.aas4j.v3.model.Reference;
 
 
@@ -98,4 +99,12 @@ public default <T extends Response> T execute(Request<T> request) {
      * @return the AssetConnectionManager of the service
      */
     public AssetConnectionManager getAssetConnectionManager();
+
+
+    /**
+     * Returns the endpoints of the service.
+     *
+     * @return the endpoints of the service
+     */
+    public List<Endpoint> getEndpoints();
 }

core/src/main/java/de/fraunhofer/iosb/ilt/faaast/service/config/CoreConfig.java

@@ -54,7 +54,6 @@ public class CoreConfig {
     private RegistrySynchronizationConfig registrySynchronization;
     private double minInflateRatio;
     private long operationTimeout;
-    private String callbackAddress;
 
     public CoreConfig() {
         this.assetConnectionRetryInterval = DEFAULT_ASSET_CONNECTION_RETRY_INTERVAL;
@@ -239,16 +238,6 @@ public void setOperationTimeout(long operationTimeout) {
     }
 
 
-    public String getCallbackAddress() {
-        return callbackAddress;
-    }
-
-
-    public void setCallbackAddress(String callbackAddress) {
-        this.callbackAddress = callbackAddress;
-    }
-
-
     @Override
     public int hashCode() {
         return Objects.hash(assetConnectionRetryInterval,
@@ -263,8 +252,7 @@ public int hashCode() {
                 submodelRegistries,
                 registrySynchronization,
                 minInflateRatio,
-                operationTimeout,
-                callbackAddress);
+                operationTimeout);
     }
 
 
@@ -292,8 +280,7 @@ public boolean equals(Object obj) {
                 && Objects.equals(this.submodelRegistries, other.submodelRegistries)
                 && Objects.equals(this.registrySynchronization, other.registrySynchronization)
                 && Objects.equals(this.minInflateRatio, other.minInflateRatio)
-                && Objects.equals(this.operationTimeout, other.operationTimeout)
-                && Objects.equals(callbackAddress, other.callbackAddress);
+                && Objects.equals(this.operationTimeout, other.operationTimeout);
     }
 
     public static class Builder extends ExtendableBuilder<CoreConfig, Builder> {
@@ -412,12 +399,6 @@ public Builder operationTimeout(long value) {
         }
 
 
-        public Builder callbackAddress(String value) {
-            getBuildingInstance().setCallbackAddress(value);
-            return getSelf();
-        }
-
-
         @Override
         protected Builder getSelf() {
             return this;

core/src/main/java/de/fraunhofer/iosb/ilt/faaast/service/util/EncodingHelper.java

@@ -80,7 +80,9 @@ public static String base64Encode(String value) {
      * @return encoded value
      */
     public static byte[] base64Encode(byte[] value) {
-        return Base64.getEncoder().encode(value);
+        return Objects.nonNull(value)
+                ? Base64.getEncoder().encode(value)
+                : new byte[0];
     }
 
 

docs/source/basics/configuration.md

@@ -44,7 +44,6 @@ The `core` configuration block contains properties not related to the implementa
 | assetConnectionReadTimeout<br>*(optional)*            | Long           | Timeout in ms for reading all asset connections for a single AAS command                                                                                                           | 5000                            |
 | assetConnectionRetryInterval<br>*(optional)*          | Long           | Interval in ms in which to retry establishing asset connections                                                                                                                    | 1000                            |
 | assetConnectionWriteMaxThreadPoolSize<br>*(optional)* | Integer        | Size of thread pool used to write to asset connections                                                                                                                             | 1000                            |
-| callbackAddress<br>*(optional)*                       | String         | The external URI the FA³ST Service is reachable from. Used in registry synchronization and cloud events message bus.                                                               |                                 |
 | minInflateRatio<br>*(optional)*                       | Double         | Ratio between de- and inflated bytes to detect zipbomb when loading AASX files                                                                                                     | 0.001                           |
 | operationTimeout<br>*(optional)*                      | Long           | Timeout in ms for executing AAS operations. Set to 0 for no timeout.                                                                                                               | 3600000                         |
 | requestHandlerThreadPoolSize<br>*(optional)*          | Integer        | Number of concurrent thread that can execute API requests                                                                                                                          | 2                               |