artin/OBP-API
1
0
Fork 0
mirror of https://github.com/OpenBankProject/OBP-API.git synced 2026-02-06 16:36:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor/update error messages for entitlement handling in ConsentUtil

Browse Source
This commit is contained in:
hongwei 2025-06-03 09:44:00 +02:00
parent 68956fb292
commit 8b1ca1ae94
2 changed files with 22 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
obp-api/src/main/scala/code/api/util/ConsentUtil.scala
View File

@ -2,14 +2,11 @@ package code.api.util
import code.accountholders.AccountHolders
import code.api.berlin.group.ConstantsBG
import java.text.SimpleDateFormat
import java.util.{Date, UUID}
import code.api.berlin.group.v1_3.JSONFactory_BERLIN_GROUP_1_3.{ConsentAccessJson, PostConsentJson}
import code.api.util.APIUtil.fullBoxOrException
import code.api.util.ApiRole.{canCreateEntitlementAtAnyBank, canCreateEntitlementAtOneBank}
import code.api.util.BerlinGroupSigning.getHeaderValue
import code.api.util.ErrorMessages.{CouldNotAssignAccountAccess, InvalidConnectorResponse, NoViewReadAccountsBerlinGroup}
import code.api.util.ErrorMessages._
import code.api.v3_1_0.{PostConsentBodyCommonJson, PostConsentEntitlementJsonV310, PostConsentViewJsonV310}
import code.api.v5_0_0.HelperInfoJson
import code.api.{APIFailure, APIFailureNewStyle, Constant, RequestHeader}
@ -22,7 +19,6 @@ import code.context.{ConsentAuthContextProvider, UserAuthContextProvider}
import code.entitlement.Entitlement
import code.model.Consumer
import code.model.dataAccess.BankAccountRouting
import code.scheduler.ConsentScheduler.logger
import code.users.Users
import code.util.Helper.MdcLoggable
import code.util.HydraUtil
@ -30,16 +26,16 @@ import code.views.Views
import com.nimbusds.jwt.JWTClaimsSet
import com.openbankproject.commons.ExecutionContext.Implicits.global
import com.openbankproject.commons.model._
import com.openbankproject.commons.util.ApiVersion
import net.liftweb.common.{Box, Empty, Failure, Full, ParamFailure}
import net.liftweb.common._
import net.liftweb.http.provider.HTTPParam
import net.liftweb.json.JsonParser.ParseException
import net.liftweb.json.{Extraction, MappingException, compactRender, parse}
import net.liftweb.mapper.By
import net.liftweb.util.{ControlHelpers, Props}
import org.apache.commons.lang3.StringUtils
import net.liftweb.util.Props
import sh.ory.hydra.model.OAuth2TokenIntrospection
import java.text.SimpleDateFormat
import java.util.Date
import scala.collection.immutable.{List, Nil}
import scala.concurrent.Future
@ -309,13 +305,13 @@ object Consent extends MdcLoggable {
Entitlement.entitlement.vend.addEntitlement(bankId, user.userId, entitlement.role_name) match {
case Full(_) => (entitlement, "AddedOrExisted")
case _ =>
(entitlement, "Cannot add the entitlement: " + entitlement)
(entitlement, addConsentEntitlements + entitlement)
}
case true =>
(entitlement, "AddedOrExisted")
}
case false =>
(entitlement, "There is no entitlement's name: " + entitlement)
(entitlement, InvalidEntitlement + entitlement)
}
}
@ -332,10 +328,10 @@ object Consent extends MdcLoggable {
failedToAdd match {
case Nil => Full(user)
case _ =>
Failure("The entitlements cannot be added. " + failedToAdd.map(i => (i._1, i._2)).mkString(", "))
Failure(CannotAddEntitlement + failedToAdd.map(i => (i._1, i._2)).mkString(", "))
}
case _ =>
Failure("Cannot get entitlements for user id: " + user.userId)
Failure(CannotGetEntitlements + user.userId)
}
}
@ -438,10 +434,10 @@ object Consent extends MdcLoggable {
case failure@Failure(msg, exp, chain) => // Handled errors
(Failure(msg), Some(cc))
case _ =>
(Failure("Cannot add entitlements based on: " + consentAsJwt), Some(cc))
(Failure(CannotAddEntitlement + consentAsJwt), Some(cc))
}
case _ =>
(Failure("Cannot create or get the user based on: " + consentAsJwt), Some(cc))
(Failure(CannotGetOrCreateUser + consentAsJwt), Some(cc))
}
}
@ -524,10 +520,10 @@ object Consent extends MdcLoggable {
case failure@Failure(msg, exp, chain) => // Handled errors
(Failure(msg), Some(cc))
case _ =>
(Failure("Cannot add entitlements based on: " + consentId), Some(cc))
(Failure(CannotAddEntitlement + consentId), Some(cc))
}
case _ =>
(Failure("Cannot create or get the user based on: " + consentId), Some(cc))
(Failure(CannotGetOrCreateUser + consentId), Some(cc))
}
}

17
obp-api/src/main/scala/code/api/util/ErrorMessages.scala
View File

@ -1,16 +1,13 @@
package code.api.util
import code.api.APIFailureNewStyle
import code.api.util.ApiRole.{CanCreateAnyTransactionRequest, canCreateEntitlementAtAnyBank, canCreateEntitlementAtOneBank}
import com.openbankproject.commons.model.enums.TransactionRequestStatus._
import net.liftweb.json.{Extraction, JsonAST}
import java.util.Objects
import java.util.regex.Pattern
import code.api.APIFailureNewStyle
import com.openbankproject.commons.model.enums.TransactionRequestStatus._
import code.api.Constant._
import code.api.util.ApiRole.{CanCreateAnyTransactionRequest, canCreateEntitlementAtAnyBank, canCreateEntitlementAtOneBank}
import code.views.system.ViewDefinition
import net.liftweb.json.{Extraction, JsonAST}
import net.liftweb.util.StringHelpers
object ErrorMessages {
import code.api.util.APIUtil._
// Notes to developers. Please:
@ -550,6 +547,10 @@ object ErrorMessages {
val AgentNumberAlreadyExists = "OBP-30328: Agent Number already exists. Please specify a different value for BANK_ID or AGENT_NUMBER."
val GetAgentAccountLinksError = "OBP-30329: Could not get the agent account links."
val AgentBeneficiaryPermit = "OBP-30330: The account can not send money to the Agent. Please set the Agent 'is_confirmed_agent' true and `is_pending_agent` false."
val InvalidEntitlement = "OBP-30331: Invalid Entitlement Name. Please specify a proper name."
val CannotAddEntitlement = "OBP-30332: Failed to add entitlement. Please check the provided details and try again."
val CannotGetEntitlements = "OBP-30333: Cannot get entitlements for user id."
// Branch related messages
val BranchesNotFoundLicense = "OBP-32001: No branches available. License may not be set."