feat(irs-api):[#199] register policy definition for certain bpnls

CHANGELOG.md

@@ -16,6 +16,8 @@ _**For better traceability add the corresponding GitHub issue number in each cha
 - Added AssetAdministrationShellDescriptor specificAssetIds support for externalSubjectId required for data provisioning
 - Registering a job - aspects array is now accepting full urn of aspect model instead of name only, eg. 'urn:bamm:io.catenax.single_level_bom_as_built:2.0.0#SingleLevelBomAsBuilt' instead 'SingleLevelBomAsBuilt'. #439
 - Changed the version of irs-registry-client from 1.6.0-SNAPSHOT to 1.6.0
+- Policies can now be registered for certain bpnls. #199
+
 
 ## Fixed
 - Fixed missing timeouts including configuration. #448

charts/irs-helm/templates/configmap-spring-app-config.yaml

@@ -159,8 +159,6 @@ data:
     {{- end }}
     {{- end }}
 
-    apiAllowedBpn: {{ tpl (.Values.bpn | default "") . | quote }}
-
     {{- if .Values.config.content }}
     {{- tpl (toYaml .Values.config.content) . | nindent 4 }}
     {{- end }}

docs/src/api/irs-api.yaml

@@ -794,7 +794,15 @@ paths:
   /irs/policies:
     get:
       description: Lists the registered policies that should be accepted in EDC negotiation.
-      operationId: getAllowedPolicies
+      operationId: getAllowedPoliciesByBpn
+      parameters:
+        - name: bpnls
+          in: query
+          required: false
+          schema:
+            type: array
+            items:
+              type: string
       responses:
         "200":
           content:
@@ -823,7 +831,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - api_key: []
+        - api_key: [ ]
       summary: Lists the registered policies that should be accepted in EDC negotiation.
       tags:
         - Item Relationship Service
@@ -871,16 +879,15 @@ paths:
       summary: Register a policy that should be accepted in EDC negotiation.
       tags:
         - Item Relationship Service
-  /irs/policies/{policyId}:
-    delete:
-      description: Removes a policy that should no longer be accepted in EDC negotiation.
-      operationId: deleteAllowedPolicy
-      parameters:
-        - in: path
-          name: policyId
-          required: true
-          schema:
-            type: string
+    put:
+      description: Updates an existing policy.
+      operationId: updateAllowedPolicy
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpdatePolicyRequest'
+        required: true
       responses:
         "200":
           description: OK
@@ -892,7 +899,7 @@ paths:
                   $ref: '#/components/examples/error-response-400'
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
-          description: Policy deletion failed.
+          description: Policy update failed.
         "401":
           content:
             application/json:
@@ -912,25 +919,20 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - api_key: []
-      summary: Removes a policy that should no longer be accepted in EDC negotiation.
+        - api_key: [ ]
+      summary: Updates an existing policy.
       tags:
         - Item Relationship Service
-    put:
-      description: Updates an existing policy with new validUntil value.
-      operationId: updateAllowedPolicy
+  /irs/policies/{policyId}:
+    delete:
+      description: Removes a policy that should no longer be accepted in EDC negotiation.
+      operationId: deleteAllowedPolicy
       parameters:
         - in: path
           name: policyId
           required: true
           schema:
             type: string
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/UpdatePolicyRequest'
-        required: true
       responses:
         "200":
           description: OK
@@ -942,7 +944,7 @@ paths:
                   $ref: '#/components/examples/error-response-400'
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
-          description: Policy update failed.
+          description: Policy deletion failed.
         "401":
           content:
             application/json:
@@ -963,7 +965,7 @@ paths:
           description: Authorization refused by server.
       security:
         - api_key: []
-      summary: Updates an existing policy with new validUntil value.
+      summary: Removes a policy that should no longer be accepted in EDC negotiation.
       tags:
         - Item Relationship Service
 components:
@@ -1736,9 +1738,9 @@ components:
       description: Request to add a policy
       properties:
         payload:
-          type: object
-          additionalProperties:
-            $ref: '#/components/schemas/JsonValue'
+          type: array
+          items:
+            $ref: '#/components/schemas/JsonObject'
           example:
             payload:
               '@context':
@@ -1758,23 +1760,14 @@ components:
                             '@id': 'odrl:eq'
                           'odrl:rightOperand': ID 3.1 Trace
             validUntil: '2025-12-12T23:59:59.999Z'
-          properties:
-            empty:
-              type: boolean
-            valueType:
-              type: string
-              enum:
-                - 'ARRAY'
-                - 'OBJECT'
-                - 'STRING'
-                - 'NUMBER'
-                - 'TRUE'
-                - 'FALSE'
-                - 'NULL'
         validUntil:
           type: string
           format: date-time
           description: Timestamp after which the policy will no longer be accepted in negotiations
+        businessPartnerNumbers:
+          type: array
+          items:
+            type: string
       required:
         - payload
         - validUntil
@@ -2237,6 +2230,41 @@ components:
           items:
             $ref: '#/components/schemas/Tombstone'
           maxItems: 2147483647
+    JsonObject:
+      type: object
+      additionalProperties: false
+      properties:
+        valueType:
+          type: string
+          enum:
+            - 'ARRAY'
+            - 'OBJECT'
+            - 'STRING'
+            - 'NUMBER'
+            - 'TRUE'
+            - 'FALSE'
+            - 'NULL'
+        empty:
+          type: boolean
+      example:
+        payload:
+          '@context':
+            odrl: http://www.w3.org/ns/odrl/2/
+          '@id': policy-id
+          policy:
+            'odrl:permission':
+              - 'odrl:action': USE
+                'odrl:constraint':
+                  'odrl:and':
+                    - 'odrl:leftOperand': Membership
+                      'odrl:operator':
+                        '@id': 'odrl:eq'
+                      'odrl:rightOperand': active
+                    - 'odrl:leftOperand': PURPOSE
+                      'odrl:operator':
+                        '@id': 'odrl:eq'
+                      'odrl:rightOperand': ID 3.1 Trace
+        validUntil: '2025-12-12T23:59:59.999Z'
     JsonValue:
       type: object
       additionalProperties: false
@@ -2938,6 +2966,14 @@ components:
       additionalProperties: false
       description: Request to add a policy
       properties:
+        businessPartnerNumbers:
+          type: array
+          items:
+            type: string
+        policiesIds:
+          type: array
+          items:
+            type: string
         validUntil:
           type: string
           format: date-time

irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegate.java

@@ -98,22 +98,22 @@ protected SubmodelDescriptor requestSubmodel(final EdcSubmodelFacade submodelFac
             log.debug("Using dspEndpoint of subprotocolBody '{}' to get submodel payload", subprotocolBody);
             return submodelFacade.getSubmodelPayload(dspEndpoint.get(),
                     digitalTwinRegistryEndpoint.getProtocolInformation().getHref(),
-                    extractAssetId(subprotocolBody));
+                    extractAssetId(subprotocolBody), bpn);
         } else {
             log.info("SubprotocolBody does not contain '{}'. Using Discovery Service as fallback.", DSP_ENDPOINT);
             final List<String> connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn);
 
-            return getSubmodel(submodelFacade, digitalTwinRegistryEndpoint, connectorEndpoints);
+            return getSubmodel(submodelFacade, digitalTwinRegistryEndpoint, connectorEndpoints, bpn);
         }
     }
 
     private SubmodelDescriptor getSubmodel(final EdcSubmodelFacade submodelFacade, final Endpoint digitalTwinRegistryEndpoint,
-            final List<String> connectorEndpoints) throws EdcClientException {
+            final List<String> connectorEndpoints, final String bpn) throws EdcClientException {
         for (final String connectorEndpoint : connectorEndpoints) {
             try {
                 return submodelFacade.getSubmodelPayload(connectorEndpoint,
                         digitalTwinRegistryEndpoint.getProtocolInformation().getHref(),
-                        extractAssetId(digitalTwinRegistryEndpoint.getProtocolInformation().getSubprotocolBody()));
+                        extractAssetId(digitalTwinRegistryEndpoint.getProtocolInformation().getSubprotocolBody()), bpn);
             } catch (EdcClientException e) {
                 log.info("EdcClientException while accessing digitalTwinRegistryEndpoint '{}'", connectorEndpoint, e);
             }

irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RegistryConfiguration.java

@@ -51,6 +51,8 @@
 @Configuration
 public class RegistryConfiguration {
 
+    private static final String DEFAULT = "default";
+
     @Bean
     @ConditionalOnProperty(prefix = "digitalTwinRegistry", name = "type", havingValue = "central")
     public CentralDigitalTwinRegistryService centralDigitalTwinRegistryService(final DigitalTwinRegistryClient client) {
@@ -78,7 +80,7 @@ public DecentralDigitalTwinRegistryService decentralDigitalTwinRegistryService(
 
         final EdcEndpointReferenceRetriever endpointReferenceRetriever = (edcConnectorEndpoint, assetType, assetValue) -> {
             try {
-                return facade.getEndpointReferencesForAsset(edcConnectorEndpoint, assetType, assetValue);
+                return facade.getEndpointReferencesForAsset(edcConnectorEndpoint, assetType, assetValue, DEFAULT);
             } catch (EdcClientException e) {
                 throw new EdcRetrieverException(e);
             }

irs-api/src/main/java/org/eclipse/tractusx/irs/ess/controller/mock/MockedNotificationReceiverController.java

@@ -107,7 +107,7 @@ public void receiveNotification(
             final EdcNotification<NotificationContent> edcRequest = edcRequest(notificationId, originalNotificationId,
                     senderEdc, senderBpn, recipientBpn, notificationContent);
 
-            final var response = edcSubmodelFacade.sendNotification(recipientUrl, "ess-response-asset", edcRequest);
+            final var response = edcSubmodelFacade.sendNotification(recipientUrl, "ess-response-asset", edcRequest, recipientBpn);
             if (!response.deliveredSuccessfully()) {
                 throw new EdcClientException(
                         "EDC Provider did not accept message with notificationId " + notificationId);

irs-api/src/main/java/org/eclipse/tractusx/irs/ess/service/EdcNotificationSender.java

@@ -76,7 +76,7 @@ public void sendEdcNotification(final EdcNotification<InvestigationNotificationC
                         originalNotificationId, essLocalEdcEndpoint, localBpn, recipientBpn, notificationContent);
 
                 final var response = edcSubmodelFacade.sendNotification(connectorEndpoint, "ess-response-asset",
-                        responseNotification);
+                        responseNotification, bpn);
                 if (!response.deliveredSuccessfully()) {
                     throw new EdcClientException(
                             "EDC Provider did not accept message with notificationId " + notificationId);

irs-api/src/main/java/org/eclipse/tractusx/irs/ess/service/InvestigationJobProcessingEventListener.java

@@ -221,10 +221,10 @@ private String sendEdcNotification(final String bpn, final String url, final Lis
         final EdcNotificationResponse response;
         if (isRecursiveMockAsset || isNotMockAsset) {
             log.debug("Sending recursive notification");
-            response = edcSubmodelFacade.sendNotification(url, "notify-request-asset-recursive", notification);
+            response = edcSubmodelFacade.sendNotification(url, "notify-request-asset-recursive", notification, bpn);
         } else {
             log.debug("Sending mock recursive notification");
-            response = edcSubmodelFacade.sendNotification(url, "notify-request-asset", notification);
+            response = edcSubmodelFacade.sendNotification(url, "notify-request-asset", notification, bpn);
         }
         if (response.deliveredSuccessfully()) {
             log.info("Successfully sent notification with id '{}' to EDC endpoint '{}'.", notificationId, url);

irs-api/src/main/resources/application.yml

@@ -240,6 +240,4 @@ ess:
     url: "${IRS_URL:}" # IRS Url to connect with
   discovery:
     mockEdcResult: { } # Mocked BPN Investigation results
-    mockRecursiveEdcAsset: # Mocked BPN Recursive Investigation results
-
-apiAllowedBpn: ${API_ALLOWED_BPN:BPNL00000001CRHK} # BPN value that is allowed to access IRS API
+    mockRecursiveEdcAsset: # Mocked BPN Recursive Investigation results

irs-api/src/test/java/org/eclipse/tractusx/irs/InMemoryBlobStore.java

@@ -48,6 +48,11 @@ public Optional<byte[]> getBlob(final String sourceBlobName) {
         return Optional.ofNullable(store.get(sourceBlobName));
     }
 
+    @Override
+    public Map<String, byte[]> getAllBlobs() {
+        return store;
+    }
+
     @Override
     public Collection<byte[]> findBlobByPrefix(final String prefix) {
         return store.entrySet()

irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegateTest.java

@@ -62,7 +62,7 @@ void setUp() {
     @Test
     void shouldUseDspEndpointIfPresent() throws EdcClientException {
         // Arrange
-        when(submodelFacade.getSubmodelPayload(any(), any(), any())).thenReturn(new SubmodelDescriptor("cid", "test"));
+        when(submodelFacade.getSubmodelPayload(any(), any(), any(), any())).thenReturn(new SubmodelDescriptor("cid", "test"));
         final Endpoint endpoint = Endpoint.builder()
                                           .protocolInformation(ProtocolInformation.builder()
                                                                                   .href("http://dataplane.test/123")
@@ -77,17 +77,17 @@ void shouldUseDspEndpointIfPresent() throws EdcClientException {
 
         // Assert
         assertThat(submodel).isEqualTo("test");
-        verify(submodelFacade, times(1)).getSubmodelPayload("http://edc.test", "http://dataplane.test/123", "123");
+        verify(submodelFacade, times(1)).getSubmodelPayload("http://edc.test", "http://dataplane.test/123", "123", "BPN123");
     }
 
     @Test
     void shouldUseDiscoveryFinderIfDspEndpointNotPresent() throws EdcClientException {
         // Arrange
         final String connector1 = "http://edc.test1";
         final String connector2 = "http://edc.test2";
-        when(submodelFacade.getSubmodelPayload(eq(connector1), any(), any())).thenThrow(
+        when(submodelFacade.getSubmodelPayload(eq(connector1), any(), any(), any())).thenThrow(
                 new EdcClientException("test"));
-        when(submodelFacade.getSubmodelPayload(eq(connector2), any(), any())).thenReturn(new SubmodelDescriptor("cid", "test"));
+        when(submodelFacade.getSubmodelPayload(eq(connector2), any(), any(), any())).thenReturn(new SubmodelDescriptor("cid", "test"));
         when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of(connector1, connector2));
         final String dataplaneUrl = "http://dataplane.test/123";
         final Endpoint endpoint = Endpoint.builder()
@@ -104,8 +104,8 @@ void shouldUseDiscoveryFinderIfDspEndpointNotPresent() throws EdcClientException
 
         // Assert
         assertThat(submodel).isEqualTo("test");
-        verify(submodelFacade, times(1)).getSubmodelPayload(connector1, dataplaneUrl, "123");
-        verify(submodelFacade, times(1)).getSubmodelPayload(connector2, dataplaneUrl, "123");
+        verify(submodelFacade, times(1)).getSubmodelPayload(connector1, dataplaneUrl, "123", "BPN123");
+        verify(submodelFacade, times(1)).getSubmodelPayload(connector2, dataplaneUrl, "123", "BPN123");
         verify(connectorEndpointsService, times(1)).fetchConnectorEndpoints(bpn);
     }
 
@@ -114,7 +114,7 @@ void shouldThrowGenericEdcClientExceptionIfAllEndpointsThrowExceptions() throws
         // Arrange
         final String connector1 = "http://edc.test1";
         final String connector2 = "http://edc.test2";
-        when(submodelFacade.getSubmodelPayload(any(), any(), any())).thenThrow(new EdcClientException("test"));
+        when(submodelFacade.getSubmodelPayload(any(), any(), any(), any())).thenThrow(new EdcClientException("test"));
         when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of(connector1, connector2));
         final String dataplaneUrl = "http://dataplane.test/123";
         final Endpoint endpoint = Endpoint.builder()
@@ -131,8 +131,8 @@ void shouldThrowGenericEdcClientExceptionIfAllEndpointsThrowExceptions() throws
                         bpn));
 
         // Assert
-        verify(submodelFacade, times(1)).getSubmodelPayload(connector1, dataplaneUrl, "123");
-        verify(submodelFacade, times(1)).getSubmodelPayload(connector2, dataplaneUrl, "123");
+        verify(submodelFacade, times(1)).getSubmodelPayload(connector1, dataplaneUrl, "123", "BPN123");
+        verify(submodelFacade, times(1)).getSubmodelPayload(connector2, dataplaneUrl, "123", "BPN123");
         verify(connectorEndpointsService, times(1)).fetchConnectorEndpoints(bpn);
     }
 }