2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2019 AT&T Intellectual Property. All rights
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END============================================
20 * ===================================================================
24 package org.onap.clamp.loop.components.external;
26 import com.google.gson.JsonObject;
28 import java.util.Iterator;
29 import java.util.LinkedList;
30 import java.util.List;
31 import java.util.UUID;
33 import org.apache.camel.Exchange;
34 import org.json.simple.JSONArray;
35 import org.json.simple.JSONObject;
36 import org.json.simple.parser.JSONParser;
37 import org.json.simple.parser.ParseException;
38 import org.onap.clamp.clds.model.dcae.DcaeInventoryResponse;
39 import org.onap.clamp.clds.model.dcae.DcaeOperationStatusResponse;
40 import org.onap.clamp.clds.util.JsonUtils;
41 import org.onap.clamp.loop.Loop;
42 import org.onap.clamp.policy.microservice.MicroServicePolicy;
44 public class DcaeComponent extends ExternalComponent {
46 private static final String DCAE_DEPLOYMENT_PREFIX = "CLAMP_";
47 private static final String DEPLOYMENT_PARAMETER = "dcaeDeployParameters";
48 private static final String DCAE_SERVICETYPE_ID = "serviceTypeId";
49 private static final String DCAE_INPUTS = "inputs";
53 public static final ExternalComponentState BLUEPRINT_DEPLOYED = new ExternalComponentState("BLUEPRINT_DEPLOYED",
54 "The DCAE blueprint has been found in the DCAE inventory but not yet instancianted for this loop");
55 public static final ExternalComponentState PROCESSING_MICROSERVICE_INSTALLATION = new ExternalComponentState(
56 "PROCESSING_MICROSERVICE_INSTALLATION", "Clamp has requested DCAE to install the microservices "
57 + "defined in the DCAE blueprint and it's currently processing the request");
58 public static final ExternalComponentState MICROSERVICE_INSTALLATION_FAILED = new ExternalComponentState(
59 "MICROSERVICE_INSTALLATION_FAILED",
60 "Clamp has requested DCAE to install the microservices defined in the DCAE blueprint and it failed");
61 public static final ExternalComponentState MICROSERVICE_INSTALLED_SUCCESSFULLY = new ExternalComponentState(
62 "MICROSERVICE_INSTALLED_SUCCESSFULLY",
63 "Clamp has requested DCAE to install the DCAE blueprint and it has been installed successfully");
64 public static final ExternalComponentState PROCESSING_MICROSERVICE_UNINSTALLATION = new ExternalComponentState(
65 "PROCESSING_MICROSERVICE_UNINSTALLATION", "Clamp has requested DCAE to uninstall the microservices "
66 + "defined in the DCAE blueprint and it's currently processing the request");
67 public static final ExternalComponentState MICROSERVICE_UNINSTALLATION_FAILED = new ExternalComponentState(
68 "MICROSERVICE_UNINSTALLATION_FAILED",
69 "Clamp has requested DCAE to uninstall the microservices defined in the DCAE blueprint and it failed");
70 public static final ExternalComponentState MICROSERVICE_UNINSTALLED_SUCCESSFULLY = new ExternalComponentState(
71 "MICROSERVICE_UNINSTALLED_SUCCESSFULLY",
72 "Clamp has requested DCAE to uninstall the DCAE blueprint and it has been uninstalled successfully");
73 public static final ExternalComponentState IN_ERROR = new ExternalComponentState("IN_ERROR",
74 "There was an error during the request done to DCAE, look at the logs or try again");
76 public DcaeComponent() {
77 super(BLUEPRINT_DEPLOYED);
81 public DcaeComponent(String name) {
82 super(BLUEPRINT_DEPLOYED);
83 this.name = "DCAE_" + name;
87 public String getComponentName() {
93 * Convert the json response to a DcaeOperationStatusResponse.
95 * @param responseBody The DCAE response Json paylaod
96 * @return The dcae object provisioned
98 public static DcaeOperationStatusResponse convertDcaeResponse(String responseBody) {
99 if (responseBody != null && !responseBody.isEmpty()) {
100 return JsonUtils.GSON_JPA_MODEL.fromJson(responseBody, DcaeOperationStatusResponse.class);
107 * Generate the deployment id, it's random.
109 * @return The deployment id
111 public static String generateDeploymentId() {
112 return DCAE_DEPLOYMENT_PREFIX + UUID.randomUUID();
116 * This method prepare the url returned by DCAE to check the status if fine. It
117 * extracts it from the dcaeResponse.
119 * @param dcaeResponse The dcae response object
120 * @return the Right Url modified if needed
122 public static String getStatusUrl(DcaeOperationStatusResponse dcaeResponse) {
123 return dcaeResponse.getLinks().getStatus().replaceAll("http:", "http4:").replaceAll("https:", "https4:");
127 * Return the deploy payload for DCAE.
129 * @param loop The loop object
130 * @return The payload used to send deploy closed loop request
132 public static String getDeployPayload(Loop loop) {
133 JsonObject globalProp = loop.getGlobalPropertiesJson();
134 JsonObject deploymentProp = globalProp.getAsJsonObject(DEPLOYMENT_PARAMETER);
136 String serviceTypeId = loop.getLoopTemplate().getDcaeBlueprintId();
138 JsonObject rootObject = new JsonObject();
139 rootObject.addProperty(DCAE_SERVICETYPE_ID, serviceTypeId);
140 if (deploymentProp != null) {
141 rootObject.add(DCAE_INPUTS, deploymentProp);
143 return rootObject.toString();
147 * Return the deploy payload for DCAE.
149 * @param loop The loop object
150 * @param microServicePolicy The micro service policy
151 * @return The payload used to send deploy closed loop request
153 public static String getDeployPayload(Loop loop, MicroServicePolicy microServicePolicy) {
154 JsonObject globalProp = loop.getGlobalPropertiesJson();
155 JsonObject deploymentProp = globalProp.getAsJsonObject(DEPLOYMENT_PARAMETER).getAsJsonObject(microServicePolicy.getName());
157 String serviceTypeId = microServicePolicy.getDcaeBlueprintId();
159 JsonObject rootObject = new JsonObject();
160 rootObject.addProperty(DCAE_SERVICETYPE_ID, serviceTypeId);
161 if (deploymentProp != null) {
162 rootObject.add(DCAE_INPUTS, deploymentProp);
164 return rootObject.toString();
168 * Return the uninstallation payload for DCAE.
170 * @param loop The loop object
171 * @return The payload in string (json)
173 public static String getUndeployPayload(Loop loop) {
174 JsonObject rootObject = new JsonObject();
175 rootObject.addProperty(DCAE_SERVICETYPE_ID, loop.getLoopTemplate().getDcaeBlueprintId());
176 return rootObject.toString();
180 * Return the uninstallation payload for DCAE.
182 * @param policy The microServicePolicy object
183 * @return The payload in string (json)
185 public static String getUndeployPayload(MicroServicePolicy policy) {
186 JsonObject rootObject = new JsonObject();
187 rootObject.addProperty(DCAE_SERVICETYPE_ID, policy.getDcaeBlueprintId());
188 return rootObject.toString();
192 public ExternalComponentState computeState(Exchange camelExchange) {
194 DcaeOperationStatusResponse dcaeResponse = (DcaeOperationStatusResponse) camelExchange.getIn().getExchange()
195 .getProperty("dcaeResponse");
197 if (dcaeResponse == null) {
198 setState(BLUEPRINT_DEPLOYED);
199 } else if (dcaeResponse.getOperationType().equals("install") && dcaeResponse.getStatus().equals("succeeded")) {
200 setState(MICROSERVICE_INSTALLED_SUCCESSFULLY);
201 } else if (dcaeResponse.getOperationType().equals("install") && dcaeResponse.getStatus().equals("processing")) {
202 setState(PROCESSING_MICROSERVICE_INSTALLATION);
203 } else if (dcaeResponse.getOperationType().equals("install") && dcaeResponse.getStatus().equals("failed")) {
204 setState(MICROSERVICE_INSTALLATION_FAILED);
205 } else if (dcaeResponse.getOperationType().equals("uninstall")
206 && dcaeResponse.getStatus().equals("succeeded")) {
207 setState(MICROSERVICE_UNINSTALLED_SUCCESSFULLY);
208 } else if (dcaeResponse.getOperationType().equals("uninstall")
209 && dcaeResponse.getStatus().equals("processing")) {
210 setState(PROCESSING_MICROSERVICE_UNINSTALLATION);
211 } else if (dcaeResponse.getOperationType().equals("uninstall") && dcaeResponse.getStatus().equals("failed")) {
212 setState(MICROSERVICE_UNINSTALLATION_FAILED);
216 return this.getState();
220 * Convert the json response to a DcaeInventoryResponse.
222 * @param responseBody The DCAE response Json paylaod
223 * @return list of DcaeInventoryResponse
224 * @throws ParseException In case of issues with the Json parsing
226 public static List<DcaeInventoryResponse> convertToDcaeInventoryResponse(String responseBody)
227 throws ParseException {
228 JSONParser parser = new JSONParser();
229 JSONObject jsonObj = (JSONObject) parser.parse(responseBody);
230 JSONArray itemsArray = (JSONArray) jsonObj.get("items");
231 Iterator it = itemsArray.iterator();
232 List<DcaeInventoryResponse> inventoryResponseList = new LinkedList<>();
233 while (it.hasNext()) {
234 JSONObject item = (JSONObject) it.next();
235 DcaeInventoryResponse response = JsonUtils.GSON.fromJson(item.toString(), DcaeInventoryResponse.class);
236 inventoryResponseList.add(response);
238 return inventoryResponseList;