Merge pull request #72 from bci-oss/feature/add-ttl-field

new field timeToLive for registration process

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.2.8
+### Added
+- new field "timeToLive" to DiscoveryEndpoint added, so that a time to live can be provided for the self registration at the DiscoveryFinder
+
+## fixed
+
 ## 0.2.7
 ### Added
 
@@ -15,6 +21,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 - Spring Boot version updated to 3.1.6 to fix CVE-2023-46589 and CVE-2023-34053
 - update logback version to fix CVE-2023-6378
 
+
 ## 0.2.6
 ### Added
 - Introduced versioning of the APIs of the Discovery Services.First version of this API is 1.0

backend/src/main/java/org/eclipse/tractusx/bpndiscovery/BpnDiscoveryProperties.java

@@ -24,6 +24,8 @@
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.validation.annotation.Validated;
 
+import jakarta.validation.constraints.Max;
+import jakarta.validation.constraints.Min;
 import jakarta.validation.constraints.NotEmpty;
 import jakarta.validation.constraints.NotNull;
 import lombok.Data;
@@ -43,6 +45,10 @@ public class BpnDiscoveryProperties {
 
    private final Idm idm = new Idm();
 
+   @Min( value = 1, message = "value must be greater or equal to 1" )
+   @Max( value = 31536000, message = "value must be lesser or equal to 31536000")
+   private Integer timeToLive;
+
    /**
     * Properties for Identity Management system
     */

backend/src/main/java/org/eclipse/tractusx/bpndiscovery/dto/discoveryfinder/DiscoveryEndpoint.java

@@ -47,4 +47,6 @@ public class DiscoveryEndpoint {
    @JsonProperty( "resourceId" )
    private String resourceId;
 
+   @JsonProperty( "timeToLive" )
+   private Integer timeToLive;
 }

backend/src/main/java/org/eclipse/tractusx/bpndiscovery/service/RegisterService.java

@@ -84,6 +84,8 @@ private DiscoveryEndpoint createDiscoveryEndpointRequest( String type ) {
             .type( type )
             .description( bpnDiscoveryProperties.getDescription() )
             .endpointAddress( bpnDiscoveryProperties.getEndpointAddress() )
-            .documentation( bpnDiscoveryProperties.getDocumentation() ).build();
+            .documentation( bpnDiscoveryProperties.getDocumentation() )
+            .timeToLive( bpnDiscoveryProperties.getTimeToLive() )
+            .build();
    }
 }

backend/src/main/resources/application.yml

@@ -22,6 +22,7 @@ bpndiscovery:
   description:
   endpointAddress:
   documentation:
+  timeToLive:
   idm:
     public-client-id:
     bpn-id-claim-name:

backend/src/test/java/org/eclipse/tractusx/bpndiscovery/service/AbstractDiscoveryFinderClientTest.java

@@ -107,13 +107,16 @@ public DiscoveryEndpoint dummyDiscoveryEndpoint() {
             .endpointAddress( "http://localhost:8585" )
             .documentation( "http://localhost:8585/swagger/index.html" )
             .resourceId( "123-wxy" )
+            .timeToLive( 31536000 )
             .build();
    }
 
    public DiscoveryEndpoint applicationDiscoveryEndpoint() {
       return DiscoveryEndpoint.builder()
             .type( bpnDiscoveryProperties.getAllowedTypes().get( 0 ) )
+            .description( bpnDiscoveryProperties.getDescription() )
             .endpointAddress( bpnDiscoveryProperties.getEndpointAddress() )
+            .timeToLive( bpnDiscoveryProperties.getTimeToLive() )
             .resourceId( "resourceId-app-1" )
             .build();
    }

backend/src/test/resources/application-test.yml

@@ -24,6 +24,7 @@ bpndiscovery:
   description: "Service to discover BPN to a particular OEN"
   endpointAddress: "http://localhost:86866"
   documentation: "http://.../swagger/index.html"
+  timeToLive: 31536000
   idm:
     public-client-id: bpndiscovery
     bpn-id-claim-name: bpn

charts/bpndiscovery/Chart.yaml

@@ -24,7 +24,7 @@ sources:
   - https://github.com/eclipse-tractusx/sldt-bpn-discovery
 
 type: application
-version: 0.1.14
+version: 0.1.15
 appVersion: 0.2.7
 
 dependencies:

charts/bpndiscovery/templates/secret.yaml

@@ -45,6 +45,7 @@ data:
   BPNDISCOVERY_ALLOWED_TYPES: {{ .Values.bpndiscovery.bpndiscoveryEndpoint.allowedTypes | b64enc }}
   BPNDISCOVERY_DESCRIPTION: {{ .Values.bpndiscovery.bpndiscoveryEndpoint.description | b64enc }}
   BPNDISCOVERY_ENDPOINT_ADDRESS: {{ .Values.bpndiscovery.bpndiscoveryEndpoint.endpointAddress | b64enc }}
+  BPNDISCOVERY_TIME_TO_LIVE: {{ .Values.bpndiscovery.bpndiscoveryEndpoint.timeToLive | toString | b64enc }}
   BPNDISCOVERY_DOCUMENTATION: {{ .Values.bpndiscovery.bpndiscoveryEndpoint.documentation | b64enc }}
   BPNDISCOVERY_IDM_PUBLIC_CLIENT_ID: {{ .Values.bpndiscovery.idp.publicClientId | b64enc }}
   BPNDISCOVERY_IDM_BPN_ID_CLAIM_NAME: {{ .Values.bpndiscovery.idp.bpnIdClaimName | b64enc }}

charts/bpndiscovery/values.yaml

@@ -40,6 +40,7 @@ bpndiscovery:
     description: "bpndiscovery"
     endpointAddress: "/bpndiscovery"
     documentation: "/bpndiscovery/swagger/index.html"
+    timeToLive: 31536000
   ## Configure discoveryFinderClient to register the bpn-discovery on discovery-finder.Properties needed for spring-security config.
   discoveryfinderClient:
     baseUrl: "/discoveryfinder"

docs/3-system-scope-and-context.md

@@ -20,7 +20,7 @@
 |------------------|--------------------------------------------------------------------------|
 | Consumer App     | Requests for BPN with an type and type number                            |
 | Data Provider    | Requests for register or delete entries from BPN Discovery               |
-| Discovery Finder | Receives request from BPN Discovey of self-registration purpose          |
+| Discovery Finder | Receives request from BPN Discovery of self-registration purpose         |
 | Keycloak         | Generates token for users and provides id management of user and service |