2 * Copyright © 2017-2018 AT&T Intellectual Property.
3 * Modifications Copyright © 2019 IBM.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 package org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution
20 import com.fasterxml.jackson.databind.JsonNode
21 import com.fasterxml.jackson.databind.node.JsonNodeFactory
22 import com.fasterxml.jackson.databind.node.ObjectNode
23 import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.ExecutionServiceInput
24 import org.onap.ccsdk.cds.blueprintsprocessor.services.execution.AbstractComponentFunction
25 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
26 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonNode
27 import org.onap.ccsdk.cds.controllerblueprints.core.asObjectNode
28 import org.onap.ccsdk.cds.controllerblueprints.core.returnNullIfMissing
29 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
30 import org.springframework.beans.factory.config.ConfigurableBeanFactory
31 import org.springframework.context.annotation.Scope
32 import org.springframework.stereotype.Component
34 @Component("component-resource-resolution")
35 @Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
36 open class ResourceResolutionComponent(private val resourceResolutionService: ResourceResolutionService) :
37 AbstractComponentFunction() {
40 const val INPUT_REQUEST_ID = "request-id"
41 const val INPUT_RESOURCE_ID = "resource-id"
42 const val INPUT_ACTION_NAME = "action-name"
43 const val INPUT_DYNAMIC_PROPERTIES = "dynamic-properties"
44 const val INPUT_RESOURCE_TYPE = "resource-type"
45 const val INPUT_ARTIFACT_PREFIX_NAMES = "artifact-prefix-names"
46 const val INPUT_RESOLUTION_KEY = "resolution-key"
47 const val INPUT_RESOLUTION_SUMMARY = "resolution-summary"
48 const val INPUT_STORE_RESULT = "store-result"
49 const val INPUT_OCCURRENCE = "occurrence"
51 const val ATTRIBUTE_ASSIGNMENT_PARAM = "assignment-params"
52 const val ATTRIBUTE_STATUS = "status"
54 const val OUTPUT_RESOURCE_ASSIGNMENT_PARAMS = "resource-assignment-params"
55 const val OUTPUT_RESOURCE_ASSIGNMENT_MAP = "resource-assignment-map"
56 const val OUTPUT_STATUS = "status"
59 override suspend fun processNB(executionRequest: ExecutionServiceInput) {
61 val occurrence = getOptionalOperationInput(ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_OCCURRENCE)?.asInt() ?: 1
63 getOptionalOperationInput(ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOLUTION_KEY)?.returnNullIfMissing()?.textValue() ?: ""
64 val storeResult = getOptionalOperationInput(ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_STORE_RESULT)?.asBoolean() ?: false
66 getOptionalOperationInput(ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOURCE_ID)?.returnNullIfMissing()?.textValue() ?: ""
69 getOptionalOperationInput(ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOURCE_TYPE)?.returnNullIfMissing()?.textValue() ?: ""
70 val resolutionSummary =
71 getOptionalOperationInput(ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOLUTION_SUMMARY)?.asBoolean() ?: false
73 val properties: MutableMap<String, Any> = mutableMapOf()
74 properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_STORE_RESULT] = storeResult
75 properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOLUTION_KEY] = resolutionKey
76 properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOURCE_ID] = resourceId
77 properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOURCE_TYPE] = resourceType
78 properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_OCCURRENCE] = occurrence
79 properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOLUTION_SUMMARY] = resolutionSummary
81 val jsonResponse = JsonNodeFactory.instance.objectNode()
82 val assignmentMap = JsonNodeFactory.instance.objectNode()
83 // Initialize Output Attributes to empty JSON
84 bluePrintRuntimeService.setNodeTemplateAttributeValue(
86 ResourceResolutionConstants.OUTPUT_ASSIGNMENT_PARAMS, jsonResponse
88 bluePrintRuntimeService.setNodeTemplateAttributeValue(
90 ResourceResolutionConstants.OUTPUT_ASSIGNMENT_MAP, assignmentMap
93 // validate inputs if we need to store the resource and template resolution.
95 if (resolutionKey.isNotEmpty() && (resourceId.isNotEmpty() || resourceType.isNotEmpty())) {
96 throw BluePrintProcessorException("Can't proceed with the resolution: either provide resolution-key OR combination of resource-id and resource-type.")
97 } else if ((resourceType.isNotEmpty() && resourceId.isEmpty()) || (resourceType.isEmpty() && resourceId.isNotEmpty())) {
98 throw BluePrintProcessorException("Can't proceed with the resolution: both resource-id and resource-type should be provided, one of them is missing.")
99 } else if (resourceType.isEmpty() && resourceId.isEmpty() && resolutionKey.isEmpty()) {
100 throw BluePrintProcessorException(
101 "Can't proceed with the resolution: can't persist resolution without a correlation key. " +
102 "Either provide a resolution-key OR combination of resource-id and resource-type OR set `storeResult` to false."
107 val artifactPrefixNamesNode = getOperationInput(ResourceResolutionConstants.INPUT_ARTIFACT_PREFIX_NAMES)
108 val artifactPrefixNames = JacksonUtils.getListFromJsonNode(artifactPrefixNamesNode, String::class.java)
110 for (j in 1..occurrence) {
111 properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_OCCURRENCE] = j
113 val result = resourceResolutionService.resolveResources(
114 bluePrintRuntimeService,
120 // provide indexed result in output if we have multiple resolution
121 if (occurrence != 1) {
122 jsonResponse.set<JsonNode>(j.toString(), result.templateMap.asJsonNode())
123 assignmentMap.set<JsonNode>(j.toString(), result.assignmentMap.asJsonNode())
125 jsonResponse.setAll<ObjectNode>(result.templateMap.asObjectNode())
126 assignmentMap.setAll<ObjectNode>(result.assignmentMap.asObjectNode())
130 // Set Output Attributes with resolved value
131 bluePrintRuntimeService.setNodeTemplateAttributeValue(
133 ResourceResolutionConstants.OUTPUT_ASSIGNMENT_PARAMS, jsonResponse
135 bluePrintRuntimeService.setNodeTemplateAttributeValue(
137 ResourceResolutionConstants.OUTPUT_ASSIGNMENT_MAP, assignmentMap
141 override suspend fun recoverNB(runtimeException: RuntimeException, executionRequest: ExecutionServiceInput) {
142 bluePrintRuntimeService.getBluePrintError().addError(runtimeException.message!!)