Controller Blueprints Component Core 55/72455/1
authorMuthuramalingam, Brinda Santh(bs2796) <bs2796@att.com>
Mon, 12 Nov 2018 18:49:04 +0000 (13:49 -0500)
committerMuthuramalingam, Brinda Santh(bs2796) <bs2796@att.com>
Mon, 12 Nov 2018 18:49:04 +0000 (13:49 -0500)
Define blueprint component or function Interface and Execution data..

Change-Id: I818096a65b750a0723dc14064a18d1b8b47fbaa1
Issue-ID: CCSDK-671
Signed-off-by: Muthuramalingam, Brinda Santh(bs2796) <bs2796@att.com>
components/core/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/core/BluePrintConstants.kt
components/core/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/core/interfaces/BlueprintFunctionNode.kt [new file with mode: 0644]
ms/blueprintsprocessor/modules/commons/core/src/main/kotlin/org/onap/ccsdk/apps/blueprintsprocessor/core/api/data/BlueprintProcessorData.kt

index 2590d6d..84d2bef 100644 (file)
@@ -143,15 +143,15 @@ object BluePrintConstants {
     const val METADATA_TEMPLATE_VERSION = "template_version"\r
     const val METADATA_TEMPLATE_AUTHOR = "template_author"\r
     const val METADATA_TEMPLATE_TAGS = "template_tags"\r
+    const val METADATA_WORKFLOW_NAME = "workflow_name"\r
 \r
-    const val PAYLOAD_CONTENT = "payload-content"\r
     const val PAYLOAD_DATA = "payload-data"\r
-    const val SELECTOR = "selector"\r
+    const val PROPERTY_CURRENT_STEP = "current-step"\r
+    const val PROPERTY_CURRENT_NODE_TEMPLATE = "current-node-template"\r
     const val PROPERTY_CURRENT_INTERFACE = "current-interface"\r
     const val PROPERTY_CURRENT_OPERATION = "current-operation"\r
     const val PROPERTY_CURRENT_IMPLEMENTATION = "current-implementation"\r
-\r
-    const val PROPERTY_ACTION_NAME = "action"\r
+    const val PROPERTY_EXECUTION_REQUEST = "execution-request"\r
 \r
     const val OPERATION_PROCESS = "process"\r
     const val OPERATION_PREPARE = "prepare"\r
diff --git a/components/core/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/core/interfaces/BlueprintFunctionNode.kt b/components/core/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/core/interfaces/BlueprintFunctionNode.kt
new file mode 100644 (file)
index 0000000..6add70e
--- /dev/null
@@ -0,0 +1,37 @@
+/*
+ * Copyright © 2017-2018 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.apps.controllerblueprints.core.interfaces
+
+import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintProcessorException
+import java.util.function.Function
+
+
+interface BlueprintFunctionNode<T, R> : Function<T, R> {
+
+    @Throws(BluePrintProcessorException::class)
+    fun prepareRequest(executionRequest: T): T
+
+    @Throws(BluePrintProcessorException::class)
+    fun process(executionRequest: T)
+
+    @Throws(BluePrintProcessorException::class)
+    fun recover(runtimeException: RuntimeException, executionRequest: T)
+
+    @Throws(BluePrintProcessorException::class)
+    fun prepareResponse(): R
+
+}
\ No newline at end of file
index 6fed53e..dc93825 100644 (file)
@@ -18,6 +18,7 @@
 package org.onap.ccsdk.apps.blueprintsprocessor.core.api.data\r
 \r
 import com.fasterxml.jackson.annotation.JsonFormat\r
+import com.fasterxml.jackson.databind.JsonNode\r
 import com.fasterxml.jackson.databind.node.ObjectNode\r
 import io.swagger.annotations.ApiModelProperty\r
 import org.onap.ccsdk.apps.controllerblueprints.resource.dict.ResourceAssignment\r
@@ -29,69 +30,71 @@ import org.onap.ccsdk.apps.controllerblueprints.resource.dict.ResourceAssignment
  */\r
 \r
 open class ResourceResolutionInput {\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var commonHeader: CommonHeader\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var actionIdentifiers: ActionIdentifiers\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var resourceAssignments: MutableList<ResourceAssignment>\r
-    @get:ApiModelProperty(required=true )\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var payload: ObjectNode\r
 }\r
 \r
 open class ResourceResolutionOutput {\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var commonHeader: CommonHeader\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var actionIdentifiers: ActionIdentifiers\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var status: Status\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var resourceAssignments: MutableList<ResourceAssignment>\r
 }\r
 \r
 open class ExecutionServiceInput {\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var commonHeader: CommonHeader\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var actionIdentifiers: ActionIdentifiers\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var payload: ObjectNode\r
+    var metadata: MutableMap<String, JsonNode> = hashMapOf()\r
 }\r
 \r
 open class ExecutionServiceOutput {\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var commonHeader: CommonHeader\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var actionIdentifiers: ActionIdentifiers\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var status: Status\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var payload: ObjectNode\r
+    var metadata: MutableMap<String, JsonNode> = hashMapOf()\r
 }\r
 \r
 open class ActionIdentifiers {\r
-    @get:ApiModelProperty(required=false)\r
+    @get:ApiModelProperty(required = false)\r
     lateinit var blueprintName: String\r
-    @get:ApiModelProperty(required=false)\r
+    @get:ApiModelProperty(required = false)\r
     lateinit var blueprintVersion: String\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var actionName: String\r
-    @get:ApiModelProperty(required=true, allowableValues = "sync, async")\r
+    @get:ApiModelProperty(required = true, allowableValues = "sync, async")\r
     lateinit var mode: String\r
 }\r
 \r
 open class CommonHeader {\r
-    @get:ApiModelProperty(required=true, example = "2012-04-23T18:25:43.511Z")\r
-    @get:JsonFormat(shape = JsonFormat.Shape.STRING,  pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")\r
+    @get:ApiModelProperty(required = true, example = "2012-04-23T18:25:43.511Z")\r
+    @get:JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")\r
     lateinit var timestamp: String\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var originatorId: String\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var requestId: String\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var subRequestId: String\r
-    @get:ApiModelProperty(required=false)\r
+    @get:ApiModelProperty(required = false)\r
     var flags: Flags? = null\r
 }\r
 \r
@@ -102,11 +105,11 @@ open class Flags {
 }\r
 \r
 open class Status {\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     var code: Int = 200\r
-    @get:ApiModelProperty(required=false)\r
+    @get:ApiModelProperty(required = false)\r
     var errorMessage: String? = null\r
-    @get:ApiModelProperty(required=true)\r
+    @get:ApiModelProperty(required = true)\r
     lateinit var message: String\r
 }\r
 \r