Error Catalog Management Core Library.

Issue-ID: CCSDK-2076
Signed-off-by: Brinda Santh <bs2796@att.com>
Change-Id: I9e8e67bdee77fb359a791f4ef4c2963aa78ab93a
Signed-off-by: Steve Siani <alphonse.steve.siani.djissitchi@ibm.com>

7 files changed, 239 insertions, 45 deletions

diff --git a/ms/blueprintsprocessor/modules/blueprints/blueprint-core/src/main/kotlin/org/onap/ccsdk/cds/controllerblueprints/core/BluePrintException.kt b/ms/blueprintsprocessor/modules/blueprints/blueprint-core/src/main/kotlin/org/onap/ccsdk/cds/controllerblueprints/core/BluePrintException.kt
index a2435da13..74e6bb6bd 100644
--- a/ms/blueprintsprocessor/modules/blueprints/blueprint-core/src/main/kotlin/org/onap/ccsdk/cds/controllerblueprints/core/BluePrintException.kt
+++ b/ms/blueprintsprocessor/modules/blueprints/blueprint-core/src/main/kotlin/org/onap/ccsdk/cds/controllerblueprints/core/BluePrintException.kt
@@ -1,5 +1,6 @@
 /*
  * Copyright © 2017-2018 AT&T Intellectual Property.
+ * Modifications Copyright © 2018 - 2020 IBM, Bell Canada.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,29 +22,13 @@ package org.onap.ccsdk.cds.controllerblueprints.core
  *
  * @author Brinda Santh
  */
-class BluePrintException : Exception {
-
-    var code: Int = 100
+class BluePrintException : BluePrintProcessorException {
 
     constructor(cause: Throwable) : super(cause)
     constructor(message: String) : super(message)
     constructor(message: String, cause: Throwable) : super(message, cause)
-    constructor(cause: Throwable, message: String, vararg args: Any?) : super(String.format(message, *args), cause)
-
-    constructor(code: Int, cause: Throwable) : super(cause) {
-        this.code = code
-    }
-
-    constructor(code: Int, message: String) : super(message) {
-        this.code = code
-    }
-
-    constructor(code: Int, message: String, cause: Throwable) : super(message, cause) {
-        this.code = code
-    }
-
-    constructor(code: Int, cause: Throwable, message: String, vararg args: Any?) :
-            super(String.format(message, *args), cause) {
-        this.code = code
-    }
+    constructor(cause: Throwable, message: String, vararg args: Any?) : super(cause, message, args)
+    constructor(code: Int, cause: Throwable) : super(code, cause)
+    constructor(code: Int, message: String) : super(code, message)
+    constructor(code: Int, message: String, cause: Throwable) : super(code, message, cause)
 }
diff --git a/ms/blueprintsprocessor/modules/blueprints/blueprint-core/src/main/kotlin/org/onap/ccsdk/cds/controllerblueprints/core/BluePrintProcessorException.kt b/ms/blueprintsprocessor/modules/blueprints/blueprint-core/src/main/kotlin/org/onap/ccsdk/cds/controllerblueprints/core/BluePrintProcessorException.kt
index b0b217051..50b6614ad 100644
--- a/ms/blueprintsprocessor/modules/blueprints/blueprint-core/src/main/kotlin/org/onap/ccsdk/cds/controllerblueprints/core/BluePrintProcessorException.kt
+++ b/ms/blueprintsprocessor/modules/blueprints/blueprint-core/src/main/kotlin/org/onap/ccsdk/cds/controllerblueprints/core/BluePrintProcessorException.kt
@@ -1,6 +1,6 @@
 /*
  * Copyright © 2017-2018 AT&T Intellectual Property.
- * Modifications Copyright © 2018 IBM.
+ * Modifications Copyright © 2018 - 2020 IBM, Bell Canada.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,35 +17,55 @@
 
 package org.onap.ccsdk.cds.controllerblueprints.core
 
+import org.onap.ccsdk.error.catalog.core.ErrorCatalogException
+import org.onap.ccsdk.error.catalog.core.ErrorCatalogExceptionFluent
+import org.onap.ccsdk.error.catalog.core.ErrorMessage
+
 /**
  *
  *
  * @author Brinda Santh
  */
-class BluePrintProcessorException : RuntimeException {
-
-    var code: Int = 100
+open class BluePrintProcessorException : ErrorCatalogException, ErrorCatalogExceptionFluent<BluePrintProcessorException> {
 
     constructor(message: String, cause: Throwable) : super(message, cause)
     constructor(message: String) : super(message)
     constructor(cause: Throwable) : super(cause)
-    constructor(cause: Throwable, message: String, vararg args: Any?) : super(format(message, *args), cause)
+    constructor(cause: Throwable, message: String, vararg args: Any?) : super(cause, message, args)
+    constructor(code: Int, cause: Throwable) : super(code, cause)
+    constructor(code: Int, message: String) : super(code, message)
+    constructor(code: Int, message: String, cause: Throwable) : super(code, message, cause)
+
+    override fun code(code: Int): BluePrintProcessorException {
+        return this.updateCode(code)
+    }
+
+    override fun domain(domain: String): BluePrintProcessorException {
+        return this.updateDomain(domain)
+    }
+
+    override fun action(action: String): BluePrintProcessorException {
+        return this.updateAction(action)
+    }
 
-    constructor(code: Int, cause: Throwable) : super(cause) {
-        this.code = code
+    override fun http(type: String): BluePrintProcessorException {
+        return this.updateHttp(type)
     }
 
-    constructor(code: Int, message: String) : super(message) {
-        this.code = code
+    override fun grpc(type: String): BluePrintProcessorException {
+        return this.updateGrpc(type)
     }
 
-    constructor(code: Int, message: String, cause: Throwable) : super(message, cause) {
-        this.code = code
+    override fun payloadMessage(message: String): BluePrintProcessorException {
+        return this.updatePayloadMessage(message)
     }
 
-    constructor(code: Int, cause: Throwable, message: String, vararg args: Any?) :
-            super(String.format(message, *args), cause) {
-        this.code = code
+    override fun addErrorPayloadMessage(message: String): BluePrintProcessorException {
+        return this.updateErrorPayloadMessage(message)
+    }
+
+    override fun addSubError(errorMessage: ErrorMessage): BluePrintProcessorException {
+        return this.updateSubError(errorMessage)
     }
 }
 
@@ -55,3 +75,64 @@ class BluePrintRetryException : RuntimeException {
     constructor(cause: Throwable) : super(cause)
     constructor(cause: Throwable, message: String, vararg args: Any?) : super(format(message, *args), cause)
 }
+
+/** Extension Functions */
+
+fun processorException(message: String): BluePrintProcessorException {
+    return BluePrintProcessorException(message)
+}
+
+fun processorException(code: Int, message: String): BluePrintProcessorException {
+    return processorException(message).code(code)
+}
+
+fun httpProcessorException(type: String, message: String): BluePrintProcessorException {
+    return processorException(message).http(type)
+}
+
+fun grpcProcessorException(type: String, message: String): BluePrintProcessorException {
+    return processorException(message).grpc(type)
+}
+
+fun httpProcessorException(type: String, domain: String, message: String): BluePrintProcessorException {
+    val bluePrintProcessorException = processorException(message).http(type)
+    return bluePrintProcessorException.addDomainAndErrorMessage(domain, message)
+}
+
+fun grpcProcessorException(type: String, domain: String, message: String): BluePrintProcessorException {
+    val bluePrintProcessorException = processorException(message).grpc(type)
+    return bluePrintProcessorException.addDomainAndErrorMessage(domain, message)
+}
+
+fun httpProcessorException(type: String, domain: String, message: String, cause: Throwable):
+        BluePrintProcessorException {
+    val bluePrintProcessorException = processorException(message).http(type)
+    return bluePrintProcessorException.addDomainAndErrorMessage(domain, message, cause)
+}
+
+fun grpcProcessorException(type: String, domain: String, message: String, cause: Throwable):
+        BluePrintProcessorException {
+    val bluePrintProcessorException = processorException(message).grpc(type)
+    return bluePrintProcessorException.addDomainAndErrorMessage(domain, message, cause)
+}
+
+fun BluePrintProcessorException.updateErrorMessage(domain: String, message: String, cause: Throwable):
+        BluePrintProcessorException {
+    return this.addDomainAndErrorMessage(domain, message, cause).domain(domain)
+            .addErrorPayloadMessage(message)
+            .payloadMessage(message)
+}
+
+fun BluePrintProcessorException.updateErrorMessage(domain: String, message: String): BluePrintProcessorException {
+    return this.addDomainAndErrorMessage(domain, message).domain(domain)
+            .addErrorPayloadMessage(message)
+            .payloadMessage(message)
+}
+
+private fun BluePrintProcessorException.addDomainAndErrorMessage(
+    domain: String,
+    message: String,
+    cause: Throwable = Throwable()
+): BluePrintProcessorException {
+    return this.addSubError(ErrorMessage(domain, message, cause.message ?: "")).domain(domain)
+}
diff --git a/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/BlueprintModelController.kt b/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/BlueprintModelController.kt
index ff9aed664..1f01d1ce3 100644
--- a/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/BlueprintModelController.kt
+++ b/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/BlueprintModelController.kt
@@ -211,24 +211,28 @@ open class BlueprintModelController(private val bluePrintModelHandler: BluePrint
     }
 
     @PostMapping(
-            path = arrayOf("/workflow-spec"), produces = arrayOf(MediaType
-            .APPLICATION_JSON_VALUE),
-            consumes = arrayOf(MediaType.APPLICATION_JSON_VALUE)
+        path = arrayOf("/workflow-spec"), produces = arrayOf(
+            MediaType
+                .APPLICATION_JSON_VALUE
+        ),
+        consumes = arrayOf(MediaType.APPLICATION_JSON_VALUE)
     )
     @ResponseBody
     @Throws(BluePrintException::class)
     @PreAuthorize("hasRole('USER')")
     suspend fun workflowSpec(@RequestBody workFlowSpecReq: WorkFlowSpecRequest):
-            ResponseEntity<String> = mdcWebCoroutineScope {
+        ResponseEntity<String> = mdcWebCoroutineScope {
         var json = bluePrintModelHandler.prepareWorkFlowSpec(workFlowSpecReq)
-                .asJsonString()
+            .asJsonString()
         ResponseEntity(json, HttpStatus.OK)
     }
 
     @GetMapping(
-            path = arrayOf("/workflows/blueprint-name/{name}/version/{version" +
-                    "}"),
-            produces = arrayOf(MediaType.APPLICATION_JSON_VALUE)
+        path = arrayOf(
+            "/workflows/blueprint-name/{name}/version/{version" +
+                "}"
+        ),
+        produces = arrayOf(MediaType.APPLICATION_JSON_VALUE)
     )
     @ResponseBody
     @Throws(BluePrintException::class)
@@ -240,7 +244,7 @@ open class BlueprintModelController(private val bluePrintModelHandler: BluePrint
         @PathVariable(value = "version") version: String
     ): ResponseEntity<String> = mdcWebCoroutineScope {
         var json = bluePrintModelHandler.getWorkflowNames(name, version)
-                .asJsonString()
+            .asJsonString()
         ResponseEntity(json, HttpStatus.OK)
     }
 }
diff --git a/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/ErrorHandling.kt b/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/ErrorHandling.kt
new file mode 100644
index 000000000..ae91246fe
--- /dev/null
+++ b/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/ErrorHandling.kt
@@ -0,0 +1,40 @@
+/*
+ * Copyright © 2018-2019 AT&T Intellectual Property.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://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.
+ */
+
+package org.onap.ccsdk.cds.blueprintsprocessor.designer.api
+
+object DesignerApiDomains {
+    // Designer Api Domains Constants
+    const val DESIGNER_API = "org.onap.ccsdk.cds.blueprintsprocessor.designer.api"
+    const val DESIGNER_API_ENHANCER = "org.onap.ccsdk.cds.blueprintsprocessor.designer.api.enhancer"
+    const val DESIGNER_API_HANDLER = "org.onap.ccsdk.cds.blueprintsprocessor.designer.api.handler"
+    const val DESIGNER_API_LOAD = "org.onap.ccsdk.cds.blueprintsprocessor.designer.api.load"
+    const val DESIGNER_API_SERVICE = "org.onap.ccsdk.cds.blueprintsprocessor.designer.api.service"
+}
+
+object DesignerApiHttpErrorCodes {
+    init {
+        // Register HttpErrorCodes
+        // HttpErrorCodes.register("", 200)
+    }
+}
+
+object DesignerGrpcErrorCodes {
+    init {
+        // Register GrpcErrorCodes
+        // GrpcErrorCodes.register("", 3)
+    }
+}
diff --git a/ms/blueprintsprocessor/modules/inbounds/resource-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/resource/api/ErrorHandling.kt b/ms/blueprintsprocessor/modules/inbounds/resource-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/resource/api/ErrorHandling.kt
new file mode 100644
index 000000000..b37cd0eda
--- /dev/null
+++ b/ms/blueprintsprocessor/modules/inbounds/resource-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/resource/api/ErrorHandling.kt
@@ -0,0 +1,36 @@
+/*
+ * Copyright © 2018-2019 AT&T Intellectual Property.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://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.
+ */
+
+package org.onap.ccsdk.cds.blueprintsprocessor.resource.api
+
+object ResourceApiDomains {
+    // Resource Api Domains Constants
+    const val RESOURCE_API = "org.onap.ccsdk.cds.blueprintsprocessor.resource.api"
+}
+
+object ResourceApiHttpErrorCodes {
+    init {
+        // Register HttpErrorCodes
+        // HttpErrorCodes.register("", 200)
+    }
+}
+
+object ResourceGrpcErrorCodes {
+    init {
+        // Register GrpcErrorCodes
+        // GrpcErrorCodes.register("", 3)
+    }
+}
diff --git a/ms/blueprintsprocessor/modules/inbounds/selfservice-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/selfservice/api/ErrorHandling.kt b/ms/blueprintsprocessor/modules/inbounds/selfservice-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/selfservice/api/ErrorHandling.kt
new file mode 100644
index 000000000..b76bc263a
--- /dev/null
+++ b/ms/blueprintsprocessor/modules/inbounds/selfservice-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/selfservice/api/ErrorHandling.kt
@@ -0,0 +1,44 @@
+/*
+ * Copyright © 2018-2019 AT&T Intellectual Property.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://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.
+ */
+
+package org.onap.ccsdk.cds.blueprintsprocessor.selfservice.api
+
+object SelfServiceApiDomains {
+    // SelfServiceApi Domains Constants
+    const val BLUEPRINT_PROCESSOR = "org.onap.ccsdk.cds.blueprintsprocessor"
+    const val SELF_SERVICE_API = "org.onap.ccsdk.cds.blueprintsprocessor.resource.api"
+    const val SELF_SERVICE_API_VALIDATOR = "org.onap.ccsdk.cds.blueprintsprocessor.resource.api.validator"
+    const val NETCONF_EXECUTOR = "org.onap.ccsdk.cds.blueprintsprocessor.functions.netconf.executor"
+    const val RESOURCE_RESOLUTION = "org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution"
+    const val RESTCONF_EXECUTOR = "org.onap.ccsdk.cds.blueprintsprocessor.functions.restconf.executor"
+    const val CLI_EXECUTOR = "org.onap.ccsdk.cds.blueprintsprocessor.functions.cli.executor"
+    const val PYTHON_EXECUTOR = "org.onap.ccsdk.cds.blueprintsprocessor.functions.python.executor"
+    const val SDC_LISTENER = "org.onap.ccsdk.cds.sdclistener"
+}
+
+object SelfServiceApiHttpErrorCodes {
+    init {
+        // Register HttpErrorCodes
+        // HttpErrorCodes.register("", 200)
+    }
+}
+
+object SelfServiceGrpcErrorCodes {
+    init {
+        // Register GrpcErrorCodes
+        // GrpcErrorCodes.register("", 3)
+    }
+}
diff --git a/ms/blueprintsprocessor/modules/inbounds/selfservice-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/selfservice/api/ExecutionServiceController.kt b/ms/blueprintsprocessor/modules/inbounds/selfservice-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/selfservice/api/ExecutionServiceController.kt
index 8b268d6f8..908c04607 100644
--- a/ms/blueprintsprocessor/modules/inbounds/selfservice-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/selfservice/api/ExecutionServiceController.kt
+++ b/ms/blueprintsprocessor/modules/inbounds/selfservice-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/selfservice/api/ExecutionServiceController.kt
@@ -27,7 +27,9 @@ import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.ExecutionServiceOutp
 import org.onap.ccsdk.cds.blueprintsprocessor.rest.service.mdcWebCoroutineScope
 import org.onap.ccsdk.cds.blueprintsprocessor.selfservice.api.utils.determineHttpStatusCode
 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonPrimitive
+import org.onap.ccsdk.cds.controllerblueprints.core.httpProcessorException
 import org.onap.ccsdk.cds.controllerblueprints.core.logger
+import org.onap.ccsdk.error.catalog.core.ErrorCatalogCodes
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.http.MediaType
 import org.springframework.http.ResponseEntity
@@ -81,7 +83,9 @@ open class ExecutionServiceController {
     ): ResponseEntity<ExecutionServiceOutput> = mdcWebCoroutineScope {
 
         if (executionServiceInput.actionIdentifiers.mode == ACTION_MODE_ASYNC) {
-            throw IllegalStateException("Can't process async request through the REST endpoint. Use gRPC for async processing.")
+            throw httpProcessorException(ErrorCatalogCodes.GENERIC_FAILURE,
+                    SelfServiceApiDomains.BLUEPRINT_PROCESSOR,
+                    "Can't process async request through the REST endpoint. Use gRPC for async processing.")
         }
         ph.register()
         val processResult = executionServiceHandler.doProcess(executionServiceInput)