Merge pull request #558 from catenax-ng/refactor/orchestrator_pool_dtos

feat(pool): #556 Upsert Business Partners from Cleaning Result - refactoring

bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/AlternativePostalAddressDto.kt

@@ -49,4 +49,12 @@ data class AlternativePostalAddressDto(
 
     override val deliveryServiceNumber: String
 
-) : IBaseAlternativePostalAddressDto
+) : IBaseAlternativePostalAddressDto {
+    override fun adminLevel1Key(): String? {
+        return administrativeAreaLevel1
+    }
+
+    override fun countryCode(): CountryCode {
+        return country
+    }
+}

bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/IBaseAlternativePostalAddressDto.kt

@@ -19,6 +19,7 @@
 
 package org.eclipse.tractusx.bpdm.common.dto
 
+import com.neovisionaries.i18n.CountryCode
 import io.swagger.v3.oas.annotations.media.Schema
 import org.eclipse.tractusx.bpdm.common.dto.openapidescription.PostalAddressDescription
 import org.eclipse.tractusx.bpdm.common.model.DeliveryServiceType
@@ -51,4 +52,8 @@ interface IBaseAlternativePostalAddressDto {
 
     @get:Schema(description = PostalAddressDescription.deliveryServiceNumber)
     val deliveryServiceNumber: String?
+
+    fun adminLevel1Key(): String?
+
+    fun countryCode(): CountryCode?
 }

bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/IBasePhysicalPostalAddressDto.kt

@@ -19,6 +19,7 @@
 
 package org.eclipse.tractusx.bpdm.common.dto
 
+import com.neovisionaries.i18n.CountryCode
 import io.swagger.v3.oas.annotations.media.Schema
 import org.eclipse.tractusx.bpdm.common.dto.openapidescription.PostalAddressDescription
 
@@ -68,4 +69,8 @@ interface IBasePhysicalPostalAddressDto {
 
     @get:Schema(description = PostalAddressDescription.door)
     val door: String?
+
+    fun adminLevel1Key(): String?
+
+    fun countryCode(): CountryCode?
 }

bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/IBaseSiteDto.kt

@@ -26,6 +26,9 @@ import org.eclipse.tractusx.bpdm.common.dto.openapidescription.SiteDescription
 @Schema(description = SiteDescription.header)
 interface IBaseSiteDto {
 
+    @get:Schema(description = SiteDescription.name)
+    val name: String?
+
     @get:ArraySchema(arraySchema = Schema(description = SiteDescription.states))
     val states: Collection<IBaseSiteStateDto>
 

bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/PhysicalPostalAddressDto.kt

@@ -57,4 +57,12 @@ data class PhysicalPostalAddressDto(
 
     override val door: String?
 
-) : IBasePhysicalPostalAddressDto
+) : IBasePhysicalPostalAddressDto {
+    override fun adminLevel1Key(): String? {
+        return administrativeAreaLevel1
+    }
+
+    override fun countryCode(): CountryCode {
+        return country
+    }
+}

bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/RequestWithKey.kt

@@ -0,0 +1,25 @@
+/*******************************************************************************
+ * Copyright (c) 2021,2023 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
+ ******************************************************************************/
+
+package org.eclipse.tractusx.bpdm.common.dto
+
+interface RequestWithKey {
+
+    fun getRequestKey(): String?
+}

bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/SiteDto.kt

@@ -26,13 +26,9 @@ import org.eclipse.tractusx.bpdm.common.dto.openapidescription.SiteDescription
 @Schema(description = SiteDescription.header)
 data class SiteDto(
 
-    @get:Schema(description = SiteDescription.name)
-    val name: String,
+    override val name: String,
 
-    @ArraySchema(arraySchema = Schema(description = SiteDescription.states))
-    val states: Collection<SiteStateDto> = emptyList(),
+    override val states: Collection<SiteStateDto> = emptyList(),
 
-    // TODO OpenAPI description for complex field does not work!!
-    @get:Schema(description = SiteDescription.mainAddress)
-    val mainAddress: LogisticAddressDto
-)
+    override val mainAddress: LogisticAddressDto
+) : IBaseSiteDto

bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/response/AlternativePostalAddressVerboseDto.kt

@@ -51,4 +51,11 @@ data class AlternativePostalAddressVerboseDto(
 
     override val deliveryServiceNumber: String
 
-) : IBaseAlternativePostalAddressDto
+) : IBaseAlternativePostalAddressDto {
+    override fun adminLevel1Key(): String? {
+        return administrativeAreaLevel1?.regionCode
+    }
+    override fun countryCode(): CountryCode {
+        return country.technicalKey
+    }
+}

bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/response/PhysicalPostalAddressVerboseDto.kt

@@ -63,4 +63,12 @@ data class PhysicalPostalAddressVerboseDto(
 
     override val door: String?
 
-) : IBasePhysicalPostalAddressDto
+) : IBasePhysicalPostalAddressDto {
+    override fun adminLevel1Key(): String? {
+        return administrativeAreaLevel1?.regionCode
+    }
+
+    override fun countryCode(): CountryCode {
+        return country.technicalKey
+    }
+}

bpdm-gate-api/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/api/model/AlternativePostalAddressGateDto.kt

@@ -48,4 +48,12 @@ data class AlternativePostalAddressGateDto(
 
     override val deliveryServiceNumber: String? = null
 
-) : IBaseAlternativePostalAddressDto
+) : IBaseAlternativePostalAddressDto {
+    override fun adminLevel1Key(): String? {
+        return administrativeAreaLevel1
+    }
+
+    override fun countryCode(): CountryCode? {
+        return country
+    }
+}

bpdm-gate-api/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/api/model/PhysicalPostalAddressGateDto.kt

@@ -59,4 +59,12 @@ data class PhysicalPostalAddressGateDto(
 
     override val door: String? = null
 
-) : IBasePhysicalPostalAddressDto
+) : IBasePhysicalPostalAddressDto {
+    override fun adminLevel1Key(): String? {
+        return administrativeAreaLevel1
+    }
+
+    override fun countryCode(): CountryCode? {
+        return country
+    }
+}

bpdm-orchestrator-api/src/main/kotlin/org/eclipse/tractusx/orchestrator/api/model/AlternativePostalAddressDto.kt

@@ -34,4 +34,11 @@ data class AlternativePostalAddressDto(
     override val deliveryServiceQualifier: String? = null,
     override val deliveryServiceNumber: String? = null
 
-) : IBaseAlternativePostalAddressDto
+) : IBaseAlternativePostalAddressDto {
+    override fun adminLevel1Key(): String? {
+        return administrativeAreaLevel1
+    }
+    override fun countryCode(): CountryCode? {
+        return country
+    }
+}

bpdm-orchestrator-api/src/main/kotlin/org/eclipse/tractusx/orchestrator/api/model/PhysicalPostalAddressDto.kt

@@ -39,4 +39,12 @@ data class PhysicalPostalAddressDto(
     override val floor: String? = null,
     override val door: String? = null
 
-) : IBasePhysicalPostalAddressDto
+) : IBasePhysicalPostalAddressDto {
+    override fun adminLevel1Key(): String? {
+        return administrativeAreaLevel1
+    }
+
+    override fun countryCode(): CountryCode? {
+        return country
+    }
+}

bpdm-orchestrator-api/src/main/kotlin/org/eclipse/tractusx/orchestrator/api/model/SiteDto.kt

@@ -31,8 +31,7 @@ data class SiteDto(
     @get:Schema(description = "Whether this site data is different from its golden record counterpart in the Pool")
     val hasChanged: Boolean? = null,
 
-    @get:Schema(description = SiteDescription.name)
-    val name: String? = null,
+    override val name: String? = null,
 
     override val states: Collection<SiteStateDto> = emptyList(),
 

bpdm-orchestrator-api/src/main/kotlin/org/eclipse/tractusx/orchestrator/api/model/TaskStepReservationEntryDto.kt

@@ -20,6 +20,7 @@
 package org.eclipse.tractusx.orchestrator.api.model
 
 import io.swagger.v3.oas.annotations.media.Schema
+import org.eclipse.tractusx.bpdm.common.dto.RequestWithKey
 
 @Schema(description = "Task reservation entry")
 data class TaskStepReservationEntryDto(
@@ -29,4 +30,8 @@ data class TaskStepReservationEntryDto(
 
     @get:Schema(description = "The business partner data to process")
     val businessPartner: BusinessPartnerFullDto
-)
+) : RequestWithKey {
+    override fun getRequestKey(): String? {
+        return taskId
+    }
+}

bpdm-pool-api/src/main/kotlin/org/eclipse/tractusx/bpdm/pool/api/model/request/AddressPartnerCreateRequest.kt

@@ -23,6 +23,7 @@ import com.fasterxml.jackson.annotation.JsonUnwrapped
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize
 import io.swagger.v3.oas.annotations.media.Schema
 import org.eclipse.tractusx.bpdm.common.dto.LogisticAddressDto
+import org.eclipse.tractusx.bpdm.common.dto.RequestWithKey
 import org.eclipse.tractusx.bpdm.common.dto.openapidescription.CommonDescription
 import org.eclipse.tractusx.bpdm.common.dto.openapidescription.LogisticAddressDescription
 import org.eclipse.tractusx.bpdm.common.service.DataClassUnwrappedJsonDeserializer
@@ -39,4 +40,9 @@ data class AddressPartnerCreateRequest(
 
     @Schema(description = CommonDescription.index)
     val index: String?
-)
+): RequestWithKey {
+    override fun getRequestKey(): String? {
+        return index
+    }
+}
+

bpdm-pool-api/src/main/kotlin/org/eclipse/tractusx/bpdm/pool/api/model/request/AddressPartnerUpdateRequest.kt

@@ -23,6 +23,7 @@ import com.fasterxml.jackson.annotation.JsonUnwrapped
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize
 import io.swagger.v3.oas.annotations.media.Schema
 import org.eclipse.tractusx.bpdm.common.dto.LogisticAddressDto
+import org.eclipse.tractusx.bpdm.common.dto.RequestWithKey
 import org.eclipse.tractusx.bpdm.common.dto.openapidescription.LogisticAddressDescription
 import org.eclipse.tractusx.bpdm.common.service.DataClassUnwrappedJsonDeserializer
 
@@ -35,4 +36,8 @@ data class AddressPartnerUpdateRequest(
 
     @field:JsonUnwrapped
     val address: LogisticAddressDto
-)
+): RequestWithKey {
+    override fun getRequestKey(): String? {
+        return bpna
+    }
+}

bpdm-pool-api/src/main/kotlin/org/eclipse/tractusx/bpdm/pool/api/model/request/LegalEntityPartnerCreateRequest.kt

@@ -24,6 +24,7 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize
 import io.swagger.v3.oas.annotations.media.Schema
 import org.eclipse.tractusx.bpdm.common.dto.LegalEntityDto
 import org.eclipse.tractusx.bpdm.common.dto.LogisticAddressDto
+import org.eclipse.tractusx.bpdm.common.dto.RequestWithKey
 import org.eclipse.tractusx.bpdm.common.dto.openapidescription.CommonDescription
 import org.eclipse.tractusx.bpdm.common.dto.openapidescription.LegalEntityDescription
 import org.eclipse.tractusx.bpdm.common.service.DataClassUnwrappedJsonDeserializer
@@ -44,4 +45,8 @@ data class LegalEntityPartnerCreateRequest(
 
     @get:Schema(description = CommonDescription.index)
     val index: String?
-)
+): RequestWithKey {
+    override fun getRequestKey(): String? {
+        return index
+    }
+}

bpdm-pool-api/src/main/kotlin/org/eclipse/tractusx/bpdm/pool/api/model/request/LegalEntityPartnerUpdateRequest.kt

@@ -24,6 +24,7 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize
 import io.swagger.v3.oas.annotations.media.Schema
 import org.eclipse.tractusx.bpdm.common.dto.LegalEntityDto
 import org.eclipse.tractusx.bpdm.common.dto.LogisticAddressDto
+import org.eclipse.tractusx.bpdm.common.dto.RequestWithKey
 import org.eclipse.tractusx.bpdm.common.dto.openapidescription.LegalEntityDescription
 import org.eclipse.tractusx.bpdm.common.service.DataClassUnwrappedJsonDeserializer
 
@@ -43,4 +44,8 @@ data class LegalEntityPartnerUpdateRequest(
     // TODO OpenAPI description for complex field does not work!!
     @get:Schema(description = LegalEntityDescription.legalAddress)
     val legalAddress: LogisticAddressDto,
-)
+): RequestWithKey {
+    override fun getRequestKey(): String? {
+        return bpnl
+    }
+}

bpdm-pool-api/src/main/kotlin/org/eclipse/tractusx/bpdm/pool/api/model/request/SitePartnerCreateRequest.kt

@@ -22,6 +22,7 @@ package org.eclipse.tractusx.bpdm.pool.api.model.request
 import com.fasterxml.jackson.annotation.JsonUnwrapped
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize
 import io.swagger.v3.oas.annotations.media.Schema
+import org.eclipse.tractusx.bpdm.common.dto.RequestWithKey
 import org.eclipse.tractusx.bpdm.common.dto.SiteDto
 import org.eclipse.tractusx.bpdm.common.dto.openapidescription.CommonDescription
 import org.eclipse.tractusx.bpdm.common.dto.openapidescription.SiteDescription
@@ -39,4 +40,8 @@ data class SitePartnerCreateRequest(
 
     @Schema(description = CommonDescription.index)
     val index: String?
-)
+) : RequestWithKey {
+    override fun getRequestKey(): String? {
+        return index
+    }
+}

bpdm-pool-api/src/main/kotlin/org/eclipse/tractusx/bpdm/pool/api/model/request/SitePartnerUpdateRequest.kt

@@ -22,6 +22,7 @@ package org.eclipse.tractusx.bpdm.pool.api.model.request
 import com.fasterxml.jackson.annotation.JsonUnwrapped
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize
 import io.swagger.v3.oas.annotations.media.Schema
+import org.eclipse.tractusx.bpdm.common.dto.RequestWithKey
 import org.eclipse.tractusx.bpdm.common.dto.SiteDto
 import org.eclipse.tractusx.bpdm.common.dto.openapidescription.SiteDescription
 import org.eclipse.tractusx.bpdm.common.service.DataClassUnwrappedJsonDeserializer
@@ -35,4 +36,8 @@ data class SitePartnerUpdateRequest(
 
     @field:JsonUnwrapped
     val site: SiteDto
-)
+): RequestWithKey {
+    override fun getRequestKey(): String? {
+        return bpns
+    }
+}