feat(bpdm-gate): Extend error code

[kunyao-cofinity-x]

Description

Enhance the error handling mechanism for the orchestrator and gate components by extending the list of available error codes. This will improve the visibility and detail of error information, particularly beneficial for the customer dashboard to understand why a data set could not be processed.

Currently, the orchestrator and gate components have a limited set of error codes. Extending these error codes will provide more granular information on processing failures, aiding in quicker diagnosis and resolution. This feature will update both the orchestrator and gate components to support a more comprehensive list of error codes.

Benefits

• Improved Transparency: Customers can view detailed error reasons on the dashboard, enhancing trust and user experience.

• Enhanced Debugging: Developers and support teams can identify and resolve issues more efficiently with detailed error information.

• Better Monitoring: Allows for more precise monitoring and logging of errors, leading to improved system reliability.

New error types add to the following two classes

• org.eclipse.tractusx.bpdm.gate.api.exception.BusinessPartnerSharingError
• org.eclipse.tractusx.orchestrator.api.model.TaskErrorType

New error types

• NaturalPersonError - The provided record contains natural person information.
• BpnErrorNotFound - The provided record can not be matched to a legal entity or an address.
• BpnErrorTooManyOptions - The provided record can not link to a clear legal entity.
• MandatoryFieldValidationFailed - The provided record does not fulfill mandatory validation rules.
• BlacklistCountryPresent - The provided record is part of a country that is not allowed to be processed by the GR process (for example: Brazil).
• UnknownSpecialCharacters - The provided record contains unallowed special characters.

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

• DEPENDENCIES are up-to-date. Dash license tool. Committers can open IP issues for restricted libs.
• Copyright and license header are present on all affected files

[nicoprow]

Sadly, the Schema annotation does not work with the used OpenAPI library after all. I discovered this, while improving the Orchestrator documentation. Please have a look at this file:

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

Line 73 in fbeeb51

@get:Schema(description = "NamePartType:\n" +

I had to write the OpenAPI description on the field description of the referencing class.

This would be in your case here:

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

Line 27 in fbeeb51

@get:Schema(description = "The type of error that occurred", required = true)

And here:

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

Line 40 in fbeeb51

@get:Schema(description = "One of the sharing error codes in case the current sharing state type is \"error\".")

Also, the code mapping TaskErrorType to GateErrorType is currently missing.