2 * Copyright © 2019 IBM.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 package org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution
19 import com.fasterxml.jackson.databind.JsonNode
20 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants
21 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintTypes
22 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonPrimitive
23 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonString
24 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonType
25 import org.onap.ccsdk.cds.controllerblueprints.core.data.NodeTemplate
26 import org.onap.ccsdk.cds.controllerblueprints.core.data.NodeType
27 import org.onap.ccsdk.cds.controllerblueprints.core.dsl.AbstractNodeTemplateOperationImplBuilder
28 import org.onap.ccsdk.cds.controllerblueprints.core.dsl.PropertiesAssignmentBuilder
29 import org.onap.ccsdk.cds.controllerblueprints.core.dsl.ServiceTemplateBuilder
30 import org.onap.ccsdk.cds.controllerblueprints.core.dsl.TopologyTemplateBuilder
31 import org.onap.ccsdk.cds.controllerblueprints.core.dsl.nodeType
32 import org.onap.ccsdk.cds.controllerblueprints.core.jsonAsJsonType
34 /** Component Extensions **/
35 fun ServiceTemplateBuilder.nodeTypeComponentResourceResolution() {
36 val nodeType = BluePrintTypes.nodeTypeComponentResourceResolution()
37 if (this.nodeTypes == null) this.nodeTypes = hashMapOf()
38 this.nodeTypes!![nodeType.id!!] = nodeType
41 fun BluePrintTypes.nodeTypeComponentResourceResolution(): NodeType {
43 id = "component-resource-resolution", version = BluePrintConstants.DEFAULT_VERSION_NUMBER,
44 derivedFrom = BluePrintConstants.MODEL_TYPE_NODE_COMPONENT,
45 description = "Resource Assignment Component"
49 ResourceResolutionComponent.ATTRIBUTE_ASSIGNMENT_PARAM, BluePrintConstants.DATA_TYPE_STRING,
53 ResourceResolutionComponent.ATTRIBUTE_STATUS, BluePrintConstants.DATA_TYPE_STRING,
57 operation("ResourceResolutionComponent", "ResourceResolutionComponent Operation") {
60 ResourceResolutionComponent.INPUT_REQUEST_ID, BluePrintConstants.DATA_TYPE_STRING,
61 true, "Request Id, Unique Id for the request."
65 ResourceResolutionComponent.INPUT_RESOURCE_ID, BluePrintConstants.DATA_TYPE_STRING,
70 ResourceResolutionComponent.INPUT_ACTION_NAME, BluePrintConstants.DATA_TYPE_STRING,
71 false, "Action Name of the process"
75 ResourceResolutionComponent.INPUT_DYNAMIC_PROPERTIES, BluePrintConstants.DATA_TYPE_JSON,
76 false, "Dynamic Json Content or DSL Json reference."
80 ResourceResolutionComponent.INPUT_RESOLUTION_KEY, BluePrintConstants.DATA_TYPE_STRING,
81 false, "Key for service instance related correlation."
85 ResourceResolutionComponent.INPUT_RESOLUTION_SUMMARY, BluePrintConstants.DATA_TYPE_BOOLEAN,
86 false, "Enables ResolutionSummary output"
90 ResourceResolutionComponent.INPUT_OCCURRENCE, BluePrintConstants.DATA_TYPE_INTEGER,
91 false, "Number of time to perform the resolution."
97 ResourceResolutionComponent.INPUT_STORE_RESULT, BluePrintConstants.DATA_TYPE_BOOLEAN,
98 false, "Whether or not to store the output."
102 ResourceResolutionComponent.INPUT_RESOURCE_TYPE, BluePrintConstants.DATA_TYPE_STRING,
103 false, "Request type."
107 ResourceResolutionComponent.INPUT_ARTIFACT_PREFIX_NAMES, BluePrintConstants.DATA_TYPE_LIST,
108 true, "Template , Resource Assignment Artifact Prefix names"
110 entrySchema(BluePrintConstants.DATA_TYPE_STRING)
115 ResourceResolutionComponent.OUTPUT_RESOURCE_ASSIGNMENT_PARAMS, BluePrintConstants.DATA_TYPE_STRING,
116 true, "Output Response"
119 ResourceResolutionComponent.OUTPUT_RESOURCE_ASSIGNMENT_MAP, BluePrintConstants.DATA_TYPE_MAP,
120 true, "Output Resolved Values"
123 ResourceResolutionComponent.OUTPUT_STATUS, BluePrintConstants.DATA_TYPE_STRING,
124 true, "Status of the Component Execution ( success or failure )"
131 /** Component Builder */
132 fun TopologyTemplateBuilder.nodeTemplateComponentResourceResolution(
135 block: ComponentResourceResolutionNodeTemplateBuilder.() -> Unit
137 val nodeTemplate = BluePrintTypes.nodeTemplateComponentResourceResolution(
141 if (nodeTemplates == null) nodeTemplates = hashMapOf()
142 nodeTemplates!![nodeTemplate.id!!] = nodeTemplate
145 fun BluePrintTypes.nodeTemplateComponentResourceResolution(
148 block: ComponentResourceResolutionNodeTemplateBuilder.() -> Unit
150 return ComponentResourceResolutionNodeTemplateBuilder(id, description).apply(block).build()
153 class ComponentResourceResolutionNodeTemplateBuilder(id: String, description: String) :
154 AbstractNodeTemplateOperationImplBuilder<PropertiesAssignmentBuilder,
155 ComponentResourceResolutionNodeTemplateBuilder.InputsBuilder,
156 ComponentResourceResolutionNodeTemplateBuilder.OutputsBuilder>(
157 id, "component-script-executor",
158 "ComponentResourceResolution",
162 class InputsBuilder : PropertiesAssignmentBuilder() {
164 fun requestId(requestId: String) = requestId(requestId.asJsonPrimitive())
166 fun requestId(requestId: JsonNode) {
167 property(ResourceResolutionComponent.INPUT_REQUEST_ID, requestId)
170 fun resourceId(resourceId: String) = resourceId(resourceId.asJsonPrimitive())
172 fun resourceId(resourceId: JsonNode) {
173 property(ResourceResolutionComponent.INPUT_RESOURCE_ID, resourceId)
176 fun actionName(actionName: String) = actionName(actionName.asJsonPrimitive())
178 fun actionName(actionName: JsonNode) {
179 property(ResourceResolutionComponent.INPUT_ACTION_NAME, actionName)
182 fun resolutionKey(resolutionKey: String) = resolutionKey(resolutionKey.asJsonPrimitive())
184 fun resolutionKey(resolutionKey: JsonNode) {
185 property(ResourceResolutionComponent.INPUT_RESOLUTION_KEY, resolutionKey)
188 fun resolutionSummary(resolutionSummary: Boolean) = resolutionSummary(resolutionSummary.asJsonPrimitive())
190 fun resolutionSummary(resolutionSummary: JsonNode) {
191 property(ResourceResolutionComponent.INPUT_RESOLUTION_SUMMARY, resolutionSummary)
194 fun dynamicProperties(dynamicProperties: String) = dynamicProperties(dynamicProperties.asJsonType())
196 fun dynamicProperties(dynamicProperties: JsonNode) {
197 property(ResourceResolutionComponent.INPUT_DYNAMIC_PROPERTIES, dynamicProperties)
200 fun occurrence(occurrence: Int) = occurrence(occurrence.asJsonPrimitive())
202 fun occurrence(resolutionKey: JsonNode) {
203 property(ResourceResolutionComponent.INPUT_OCCURRENCE, resolutionKey)
206 fun storeResult(storeResult: Boolean) = storeResult(storeResult.asJsonPrimitive())
208 fun storeResult(storeResult: JsonNode) {
209 property(ResourceResolutionComponent.INPUT_STORE_RESULT, storeResult)
212 fun resourceType(resourceType: String) = resourceType(resourceType.asJsonPrimitive())
214 fun resourceType(resourceType: JsonNode) {
215 property(ResourceResolutionComponent.INPUT_RESOURCE_TYPE, resourceType)
218 fun artifactPrefixNames(artifactPrefixNames: String) = artifactPrefixNames(artifactPrefixNames.jsonAsJsonType())
220 fun artifactPrefixNames(artifactPrefixNameList: List<String>) =
221 artifactPrefixNames(artifactPrefixNameList.asJsonString())
223 fun artifactPrefixNames(artifactPrefixNames: JsonNode) {
224 property(ResourceResolutionComponent.INPUT_ARTIFACT_PREFIX_NAMES, artifactPrefixNames)
228 class OutputsBuilder : PropertiesAssignmentBuilder() {
230 fun status(status: String) = status(status.asJsonPrimitive())
232 fun status(status: JsonNode) {
233 property(ResourceResolutionComponent.OUTPUT_STATUS, status)
236 fun resourceAssignmentMap(resourceAssignmentMap: String) =
237 resourceAssignmentMap(resourceAssignmentMap.asJsonType())
239 fun resourceAssignmentMap(resourceAssignmentMap: JsonNode) {
240 property(ResourceResolutionComponent.OUTPUT_RESOURCE_ASSIGNMENT_MAP, resourceAssignmentMap)
243 fun resourceAssignmentParams(resourceAssignmentParams: String) =
244 resourceAssignmentParams(resourceAssignmentParams.asJsonType())
246 fun resourceAssignmentParams(resourceAssignmentParams: JsonNode) {
247 property(ResourceResolutionComponent.OUTPUT_RESOURCE_ASSIGNMENT_PARAMS, resourceAssignmentParams)