refactor: gate service and entity structure

- introduced a foreign key relationship between sharing state and business partner
- renamed associatedOwnerBpnl to tenantBpnl
- simplified the business partner service to be more concise and clear
- simplified and split and the golden record task services
- introduced an internal output upsert model to make service communication more clear
- introduced migration scripts for the above changes

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/config/GoldenRecordTaskConfiguration.kt

@@ -20,8 +20,9 @@
 package org.eclipse.tractusx.bpdm.gate.config
 
 import jakarta.annotation.PostConstruct
-import org.eclipse.tractusx.bpdm.gate.service.GoldenRecordTaskService
 import org.eclipse.tractusx.bpdm.gate.service.GoldenRecordUpdateService
+import org.eclipse.tractusx.bpdm.gate.service.TaskCreationService
+import org.eclipse.tractusx.bpdm.gate.service.TaskResolutionService
 import org.springframework.context.annotation.Configuration
 import org.springframework.scheduling.TaskScheduler
 import org.springframework.scheduling.support.CronTrigger
@@ -30,14 +31,15 @@ import org.springframework.scheduling.support.CronTrigger
 class GoldenRecordTaskConfiguration(
     private val configProperties: GoldenRecordTaskConfigProperties,
     private val taskScheduler: TaskScheduler,
-    private val taskService: GoldenRecordTaskService,
+    private val taskCreationService: TaskCreationService,
+    private val taskResolutionService: TaskResolutionService,
     private val updateService: GoldenRecordUpdateService
 ) {
 
     @PostConstruct
     fun scheduleGoldenRecordTasks() {
         taskScheduler.scheduleIfEnabled(
-            { taskService.createTasksForReadyBusinessPartners() },
+            { taskCreationService.createTasksForReadyBusinessPartners() },
             configProperties.creation.fromSharingMember.cron
         )
 
@@ -47,7 +49,7 @@ class GoldenRecordTaskConfiguration(
         )
 
         taskScheduler.scheduleIfEnabled(
-            { taskService.resolvePendingTasks() },
+            { taskResolutionService.resolveTasks() },
             configProperties.check.cron
         )
     }

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/entity/ChangelogEntryDb.kt

@@ -31,8 +31,8 @@ class ChangelogEntryDb(
     @Column(name = "external_id", nullable = false, updatable = false)
     val externalId: String,
 
-    @Column(name = "associated_owner_bpnl", nullable = true)
-    var associatedOwnerBpnl: String? = null,
+    @Column(name = "tenant_bpnl", nullable = true)
+    var tenantBpnl: String? = null,
 
     @Enumerated(EnumType.STRING)
     @Column(name = "changelog_type", nullable = false, updatable = false)

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/entity/SharingStateDb.kt

@@ -33,8 +33,8 @@ class SharingStateDb(
     @Column(name = "external_id", nullable = false)
     var externalId: String,
 
-    @Column(name = "associated_owner_bpnl", nullable = true)
-    var associatedOwnerBpnl: String? = null,
+    @Column(name = "tenant_bpnl", nullable = true)
+    var tenantBpnl: String? = null,
 
     @Enumerated(EnumType.STRING)
     @Column(name = "sharing_state_type", nullable = false)

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/entity/generic/BusinessPartnerDb.kt

@@ -21,17 +21,18 @@ package org.eclipse.tractusx.bpdm.gate.entity.generic
 
 import jakarta.persistence.*
 import org.eclipse.tractusx.bpdm.common.dto.BusinessPartnerRole
-import org.eclipse.tractusx.bpdm.common.dto.BusinessPartnerType
 import org.eclipse.tractusx.bpdm.common.model.BaseEntity
 import org.eclipse.tractusx.bpdm.common.model.StageType
+import org.eclipse.tractusx.bpdm.gate.entity.SharingStateDb
 import java.util.*
 
 @Entity
 @Table(name = "business_partners")
 class BusinessPartnerDb(
 
-    @Column(name = "external_id")
-    var externalId: String,
+    @ManyToOne
+    @JoinColumn(name = "sharing_state_id", nullable = false)
+    var sharingState: SharingStateDb,
 
     @ElementCollection(fetch = FetchType.EAGER)
     @CollectionTable(name = "business_partners_name_parts", joinColumns = [JoinColumn(name = "business_partner_id")])
@@ -74,9 +75,6 @@ class BusinessPartnerDb(
     @Column(name = "is_own_company_data", nullable = false)
     var isOwnCompanyData: Boolean = false,
 
-    @Column(name = "associated_owner_bpnl", nullable = true)
-    var associatedOwnerBpnl: String? = null,
-
     @Column(name = "bpnl")
     var bpnL: String? = null,
 
@@ -94,13 +92,6 @@ class BusinessPartnerDb(
     @Enumerated(EnumType.STRING)
     var stage: StageType,
 
-    @Column(name = "parent_id")
-    var parentId: String? = null,
-
-    @Column(name = "parent_type")
-    @Enumerated(EnumType.STRING)
-    var parentType: BusinessPartnerType? = null,
-
     @OneToOne(cascade = [CascadeType.ALL], orphanRemoval = true)
     @JoinColumn(name = "legal_entity_confidence_id", unique = true)
     var legalEntityConfidence: ConfidenceCriteriaDb?,
@@ -113,5 +104,18 @@ class BusinessPartnerDb(
     @JoinColumn(name = "address_confidence_id", unique = true)
     var addressConfidence: ConfidenceCriteriaDb?,
 
-    ) : BaseEntity()
+    ) : BaseEntity() {
+
+    companion object {
+        fun createEmpty(sharingState: SharingStateDb, stage: StageType) =
+            BusinessPartnerDb(
+                sharingState = sharingState,
+                stage = stage,
+                postalAddress = PostalAddressDb(),
+                legalEntityConfidence = null,
+                siteConfidence = null,
+                addressConfidence = null
+            )
+    }
+}
 

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/exception/BpdmMissingSharingStateException.kt

@@ -0,0 +1,25 @@
+/*******************************************************************************
+ * Copyright (c) 2021,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
+ ******************************************************************************/
+
+package org.eclipse.tractusx.bpdm.gate.exception
+
+class BpdmMissingSharingStateException(
+    externalId: String,
+    tenantBpnl: String?
+) : RuntimeException("Sharing state with external-id '$externalId' in tenant '$tenantBpnl' is missing.")

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/model/upsert/output/AlternativeAddress.kt

@@ -0,0 +1,34 @@
+/*******************************************************************************
+ * Copyright (c) 2021,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
+ ******************************************************************************/
+
+package org.eclipse.tractusx.bpdm.gate.model.upsert.output
+
+import com.neovisionaries.i18n.CountryCode
+import org.eclipse.tractusx.bpdm.common.model.DeliveryServiceType
+
+data class AlternativeAddress(
+    val geographicCoordinates: GeoCoordinate?,
+    val country: CountryCode,
+    val administrativeAreaLevel1: String?,
+    val postalCode: String?,
+    val city: String,
+    val deliveryServiceType: DeliveryServiceType,
+    val deliveryServiceQualifier: String?,
+    val deliveryServiceNumber: String
+)

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/model/SharingStatusEvaluationResult.kt → bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/model/upsert/output/ConfidenceCriteria.kt

@@ -17,13 +17,15 @@
  * SPDX-License-Identifier: Apache-2.0
  ******************************************************************************/
 
-package org.eclipse.tractusx.bpdm.gate.model
+package org.eclipse.tractusx.bpdm.gate.model.upsert.output
 
-import org.eclipse.tractusx.bpdm.gate.api.exception.BusinessPartnerSharingError
-import org.eclipse.tractusx.bpdm.gate.api.model.response.ErrorInfo
+import java.time.LocalDateTime
 
-data class SharingStatusEvaluationResult(
-    val validExternalIds: Collection<String>,
-    val pendingExternalIds: Collection<String>,
-    val errors: Collection<ErrorInfo<BusinessPartnerSharingError>>
-)
+data class ConfidenceCriteria(
+    val sharedByOwner: Boolean,
+    val checkedByExternalDataSource: Boolean,
+    val numberOfSharingMembers: Int,
+    val lastConfidenceCheckAt: LocalDateTime,
+    val nextConfidenceCheckAt: LocalDateTime,
+    val confidenceLevel: Int
+)

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/model/upsert/output/GeoCoordinate.kt

@@ -0,0 +1,26 @@
+/*******************************************************************************
+ * Copyright (c) 2021,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
+ ******************************************************************************/
+
+package org.eclipse.tractusx.bpdm.gate.model.upsert.output
+
+data class GeoCoordinate(
+    val longitude: Float,
+    val latitude: Float,
+    val altitude: Float?
+)

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/model/upsert/output/Identifier.kt

@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright (c) 2021,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
+ ******************************************************************************/
+
+package org.eclipse.tractusx.bpdm.gate.model.upsert.output
+
+import org.eclipse.tractusx.bpdm.common.dto.BusinessPartnerType
+
+data class Identifier(
+    val type: String,
+    val value: String,
+    val issuingBody: String?,
+    val businessPartnerType: BusinessPartnerType
+)

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/model/upsert/output/OutputUpsertData.kt

@@ -0,0 +1,45 @@
+/*******************************************************************************
+ * Copyright (c) 2021,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
+ ******************************************************************************/
+
+package org.eclipse.tractusx.bpdm.gate.model.upsert.output
+
+import org.eclipse.tractusx.bpdm.common.dto.AddressType
+import org.eclipse.tractusx.bpdm.common.dto.BusinessPartnerRole
+
+data class OutputUpsertData(
+    val nameParts: List<String>,
+    val identifiers: Collection<Identifier>,
+    val states: Collection<State>,
+    val roles: Collection<BusinessPartnerRole>,
+    val isOwnCompanyData: Boolean,
+    val legalEntityBpn: String,
+    val legalName: String,
+    val shortName: String?,
+    val legalForm: String?,
+    val siteBpn: String?,
+    val siteName: String?,
+    val addressBpn: String,
+    val addressName: String?,
+    val addressType: AddressType,
+    val physicalPostalAddress: PhysicalPostalAddress,
+    val alternativePostalAddress: AlternativeAddress?,
+    val legalEntityConfidence: ConfidenceCriteria,
+    val siteConfidence: ConfidenceCriteria?,
+    val addressConfidence: ConfidenceCriteria,
+)

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/model/upsert/output/PhysicalPostalAddress.kt

@@ -0,0 +1,39 @@
+/*******************************************************************************
+ * Copyright (c) 2021,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
+ ******************************************************************************/
+
+package org.eclipse.tractusx.bpdm.gate.model.upsert.output
+
+import com.neovisionaries.i18n.CountryCode
+
+data class PhysicalPostalAddress(
+    val geographicCoordinates: GeoCoordinate?,
+    val country: CountryCode,
+    val administrativeAreaLevel1: String?,
+    val administrativeAreaLevel2: String?,
+    val administrativeAreaLevel3: String?,
+    val postalCode: String?,
+    val city: String,
+    val district: String?,
+    val street: Street?,
+    val companyPostalCode: String?,
+    val industrialZone: String?,
+    val building: String?,
+    val floor: String?,
+    val door: String?
+)

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/model/upsert/output/State.kt

@@ -0,0 +1,31 @@
+/*******************************************************************************
+ * Copyright (c) 2021,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
+ ******************************************************************************/
+
+package org.eclipse.tractusx.bpdm.gate.model.upsert.output
+
+import org.eclipse.tractusx.bpdm.common.dto.BusinessPartnerType
+import org.eclipse.tractusx.bpdm.common.model.BusinessStateType
+import java.time.LocalDateTime
+
+data class State(
+    val validFrom: LocalDateTime?,
+    val validTo: LocalDateTime?,
+    val type: BusinessStateType,
+    val businessPartnerType: BusinessPartnerType
+)