feat(CxMembership): Set Catena-X Membership in BPDM (#1118)

Ref: #1111
* Add "BusinessPartnerPoolBaseAddress" in appsettings
* refactor use of HttpClient
* added migration files
* update framework version
---------
Co-authored-by: Norbert Truchsess <norbert.truchsess@t-online.de>

Author: tfjanjua

docs/api/administration-service.yaml

@@ -4257,6 +4257,38 @@ paths:
           description: Internal Server Error
         '401':
           description: The User is unauthorized
+  '/api/administration/registration/application/{applicationId}/retrigger-set-cx-membership':
+    post:
+      tags:
+        - Registration
+      summary: 'Retriggers the last failed step (Authorization required - Roles: approve_new_partner)'
+      parameters:
+        - name: applicationId
+          in: path
+          description: Id of the application that should be triggered
+          required: true
+          schema:
+            type: string
+            format: uuid
+      responses:
+        '204':
+          description: Empty response on success.
+        '400':
+          description: Either the CompanyApplication is not in status SUBMITTED or the next step can't automatically retriggered.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: No application found for the applicationId.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+        '401':
+          description: The User is unauthorized
   /api/administration/RegistrationStatus/callback:
     get:
       tags:
@@ -7529,6 +7561,8 @@ components:
         - RETRIGGER_REMOVE_REGISTRATION_ROLES
         - RETRIGGER_SET_THEME
         - RETRIGGER_SET_MEMBERSHIP
+        - SET_CX_MEMBERSHIP_IN_BPDM
+        - RETRIGGER_SET_CX_MEMBERSHIP_IN_BPDM
         - TRIGGER_PROVIDER
         - AWAIT_START_AUTOSETUP
         - OFFERSUBSCRIPTION_CLIENT_CREATION

docs/api/apps-service.yaml

@@ -3631,6 +3631,8 @@ components:
         - RETRIGGER_REMOVE_REGISTRATION_ROLES
         - RETRIGGER_SET_THEME
         - RETRIGGER_SET_MEMBERSHIP
+        - SET_CX_MEMBERSHIP_IN_BPDM
+        - RETRIGGER_SET_CX_MEMBERSHIP_IN_BPDM
         - TRIGGER_PROVIDER
         - AWAIT_START_AUTOSETUP
         - OFFERSUBSCRIPTION_CLIENT_CREATION

docs/api/services-service.yaml

@@ -2202,6 +2202,8 @@ components:
         - RETRIGGER_REMOVE_REGISTRATION_ROLES
         - RETRIGGER_SET_THEME
         - RETRIGGER_SET_MEMBERSHIP
+        - SET_CX_MEMBERSHIP_IN_BPDM
+        - RETRIGGER_SET_CX_MEMBERSHIP_IN_BPDM
         - TRIGGER_PROVIDER
         - AWAIT_START_AUTOSETUP
         - OFFERSUBSCRIPTION_CLIENT_CREATION

src/administration/Administration.Service/Controllers/RegistrationController.cs

@@ -726,5 +726,27 @@ public async Task<NoContentResult> RetriggerSetMembership([FromRoute] Guid appli
         await logic.TriggerChecklistAsync(applicationId, ApplicationChecklistEntryTypeId.APPLICATION_ACTIVATION, ProcessStepTypeId.RETRIGGER_SET_MEMBERSHIP).ConfigureAwait(ConfigureAwaitOptions.None);
         return NoContent();
     }
+
+    /// <summary>
+    /// Retriggers the last failed step 
+    /// </summary>
+    /// <param name="applicationId" example="">Id of the application that should be triggered</param>
+    /// <returns>NoContent</returns>
+    /// Example: POST: api/administration/registration/application/{applicationId}/retrigger-set-cx-membership
+    /// <response code="204">Empty response on success.</response>
+    /// <response code="400">Either the CompanyApplication is not in status SUBMITTED or the next step can't automatically retriggered.</response>
+    /// <response code="404">No application found for the applicationId.</response>
+    [HttpPost]
+    [Authorize(Roles = "approve_new_partner")]
+    [Authorize(Policy = PolicyTypes.CompanyUser)]
+    [Route("application/{applicationId}/retrigger-set-cx-membership")]
+    [ProducesResponseType(StatusCodes.Status204NoContent)]
+    [ProducesResponseType(typeof(ErrorResponse), StatusCodes.Status400BadRequest)]
+    [ProducesResponseType(typeof(ErrorResponse), StatusCodes.Status404NotFound)]
+    public async Task<NoContentResult> RetriggerSetCxMembership([FromRoute] Guid applicationId)
+    {
+        await logic.TriggerChecklistAsync(applicationId, ApplicationChecklistEntryTypeId.APPLICATION_ACTIVATION, ProcessStepTypeId.RETRIGGER_SET_CX_MEMBERSHIP_IN_BPDM).ConfigureAwait(ConfigureAwaitOptions.None);
+        return NoContent();
+    }
 }
 

src/administration/Administration.Service/appsettings.json

@@ -298,7 +298,8 @@
       "TokenAddress": "",
       "BaseAddress": "",
       "UseDimWallet": false,
-      "StartSharingStateAsReady": false
+      "StartSharingStateAsReady": false,
+      "BusinessPartnerPoolBaseAddress": ""
     },
     "Clearinghouse": {
       "Username": "",

src/externalsystems/Bpdm.Library/BpdmService.cs

@@ -176,4 +176,23 @@ public async Task<BpdmSharingState> GetSharingState(Guid applicationId, Cancella
             throw new ServiceException($"Access to sharing state did not return a valid json response: {je.Message}");
         }
     }
+
+    /// <inheritdoc />
+    public async Task<bool> SetCxMembership(string businessPartnerNumber, CancellationToken cancellationToken)
+    {
+        using var httpClient = await _tokenService.GetAuthorizedClient($"{typeof(BpdmService).Name}Pool", _settings, cancellationToken).ConfigureAwait(ConfigureAwaitOptions.None);
+
+        var requestData = new BpdmCxMembership(
+            new BpdmCxMembershipDto[]{
+                new(businessPartnerNumber, true)
+            }.AsEnumerable()
+        );
+
+        async ValueTask<(bool, string?)> CreateErrorMessage(HttpResponseMessage errorResponse) =>
+            (false, await errorResponse.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(ConfigureAwaitOptions.None));
+
+        await httpClient.PutAsJsonAsync("v6/cx-memberships", requestData, Options, cancellationToken)
+            .CatchingIntoServiceExceptionFor("bpdm-put-cx-membership", HttpAsyncResponseMessageExtension.RecoverOptions.INFRASTRUCTURE, CreateErrorMessage).ConfigureAwait(false);
+        return true;
+    }
 }

src/externalsystems/Bpdm.Library/BpdmServiceSettings.cs

@@ -34,4 +34,7 @@ public class BpdmServiceSettings : KeyVaultAuthSettings
     public bool UseDimWallet { get; set; }
 
     public bool StartSharingStateAsReady { get; set; }
+
+    [Required(AllowEmptyStrings = false)]
+    public string BusinessPartnerPoolBaseAddress { get; set; } = null!;
 }

src/externalsystems/Bpdm.Library/DependencyInjection/BpdmServiceCollectionExtension.cs

@@ -38,8 +38,10 @@ public static IServiceCollection AddBpdmService(this IServiceCollection services
         var sp = services.BuildServiceProvider();
         var settings = sp.GetRequiredService<IOptions<BpdmServiceSettings>>();
         var baseAddress = settings.Value.BaseAddress;
+        var poolBaseAddress = settings.Value.BusinessPartnerPoolBaseAddress;
         services
             .AddCustomHttpClientWithAuthentication<BpdmService>(baseAddress.EndsWith('/') ? baseAddress : $"{baseAddress}/")
+            .AddCustomHttpClientWithAuthentication<BpdmService>($"{typeof(BpdmService).Name}Pool", poolBaseAddress.EndsWith('/') ? poolBaseAddress : $"{poolBaseAddress}/")
             .AddTransient<IBpdmService, BpdmService>()
             .AddTransient<IBpdmBusinessLogic, BpdmBusinessLogic>();
 

src/externalsystems/Bpdm.Library/IBpdmService.cs

@@ -44,4 +44,12 @@ public interface IBpdmService
     Task<bool> SetSharingStateToReady(string externalId, CancellationToken cancellationToken);
     Task<BpdmLegalEntityOutputData> FetchInputLegalEntity(string externalId, CancellationToken cancellationToken);
     Task<BpdmSharingState> GetSharingState(Guid applicationId, CancellationToken cancellationToken);
+
+    /// <summary>
+    /// Send membership information to the BPDM Pool
+    /// </summary>
+    /// <param name="businessPartnerNumber">The BPN to set Cx Membership</param>
+    /// <param name="cancellationToken">Cancellation Token</param>
+    /// <returns>Returns <c>true</c> if the service call was successful, otherwise <c>false</c></returns>
+    Task<bool> SetCxMembership(string businessPartnerNumber, CancellationToken cancellationToken);
 }

src/externalsystems/Bpdm.Library/Models/BpdmCxMembershipDto.cs

@@ -0,0 +1,39 @@
+/********************************************************************************
+ * Copyright (c) 2024 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Apache License, Version 2.0 which is available at
+ * https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ********************************************************************************/
+
+using System.Text.Json.Serialization;
+namespace Org.Eclipse.TractusX.Portal.Backend.Bpdm.Library.Models;
+
+/// <summary>
+/// Modal to send multiple data to BPDM.
+/// </summary>
+/// <param name="Memberships">List of memberships</param>
+public record BpdmCxMembership(
+    [property: JsonPropertyName("memberships")] IEnumerable<BpdmCxMembershipDto> Memberships
+);
+
+/// <summary>
+/// Modal to send single data to BPDM.
+/// </summary>
+/// <param name="Bpn">Business Partner Number</param>
+/// <param name="IsCatenaXMember">True, if BPN has added for Catena-X mambership</param>
+public record BpdmCxMembershipDto(
+    [property: JsonPropertyName("bpnL")] string Bpn,
+    [property: JsonPropertyName("isCatenaXMember")] bool IsCatenaXMember
+);