bpmn/so-bpmn-infrastructure-common/src/main/java/org/onap/so/bpmn/infrastructure/workflow/serviceTask/AbstractSdncOperationTask.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Modifications Copyright (c) 2019 Samsung
   8  * ================================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.so.bpmn.infrastructure.workflow.serviceTask;
  24
  25 import java.io.IOException;
  26 import java.util.Arrays;
  27 import java.util.HashMap;
  28 import java.util.Iterator;
  29 import java.util.Map;
  30
  31 import org.apache.commons.lang3.StringUtils;
  32 import org.apache.http.client.methods.CloseableHttpResponse;
  33 import org.apache.http.client.methods.HttpPost;
  34 import org.apache.http.entity.ContentType;
  35 import org.apache.http.entity.StringEntity;
  36 import org.apache.http.impl.client.CloseableHttpClient;
  37 import org.apache.http.impl.client.HttpClients;
  38 import org.apache.http.util.EntityUtils;
  39 import org.camunda.bpm.engine.delegate.DelegateExecution;
  40 import org.json.JSONObject;
  41 import org.onap.msb.sdk.discovery.common.RouteException;
  42 import org.onap.msb.sdk.httpclient.RestServiceCreater;
  43 import org.onap.msb.sdk.httpclient.msb.MSBServiceClient;
  44 import org.onap.so.bpmn.core.BaseTask;
  45 import org.onap.so.bpmn.core.UrnPropertiesReader;
  46 import org.onap.so.bpmn.infrastructure.workflow.serviceTask.client.GenericResourceApi;
  47 import org.onap.so.db.request.beans.ResourceOperationStatus;
  48 import org.onap.so.logger.ErrorCode;
  49 import org.onap.so.logger.MessageEnum;
  50 import org.onap.so.requestsdb.RequestsDbConstant;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53 import org.springframework.beans.factory.annotation.Autowired;
  54 import org.springframework.core.env.Environment;
  55
  56 import com.fasterxml.jackson.annotation.JsonInclude;
  57 import com.fasterxml.jackson.core.JsonProcessingException;
  58 import com.fasterxml.jackson.databind.ObjectMapper;
  59
  60 public abstract class AbstractSdncOperationTask extends BaseTask {
  61
  62     private static final Logger logger = LoggerFactory.getLogger(AbstractSdncOperationTask.class);
  63
  64     @Autowired
  65     private Environment env;
  66     private static final String DEFAULT_MSB_IP = "127.0.0.1";
  67     private static final int DEFAULT_MSB_PORT = 80;
  68     private static final String SDCADAPTOR_INPUTS = "resourceParameters";
  69     private static final String TOPOLOGY_PROPERTIES = "topology.properties";
  70     public static final String ONAP_IP = "ONAP_IP";
  71
  72     private static final String POST_BODY_TEMPLATE = "<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:ns=\"http://org.onap.so/requestsdb\"><soapenv:Header/><soapenv:Body>\n"+
  73             "     <ns:updateResourceOperationStatus>\n"+
  74             "                <errorCode>$errorCode</errorCode>\n"+
  75             "                <jobId>$jobId</jobId>\n"+
  76             "                <operType>$operType</operType>\n"+
  77             "                <operationId>$operationId</operationId>\n"+
  78             "                <progress>$progress</progress>\n"+
  79             "                <resourceTemplateUUID>$resourceTemplateUUID</resourceTemplateUUID>\n"+
  80             "                <serviceId>$serviceId</serviceId>\n"+
  81             "                <status>$status</status>\n"+
  82             "                <statusDescription>$statusDescription</statusDescription>\n"+
  83             "     </ns:updateResourceOperationStatus></soapenv:Body></soapenv:Envelope>";
  84
  85     private static final String GET_BODY_TEMPLATE = " <soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:ns=\"http://org.onap.so/requestsdb\"><soapenv:Header/><soapenv:Body>\n" +
  86             "     <ns:getResourceOperationStatus>\n" +
  87             "                <operationId>$operationId</operationId>\n" +
  88             "                <resourceTemplateUUID>$resourceTemplateUUID</resourceTemplateUUID>\n" +
  89             "                <serviceId>$serviceId</serviceId>\n" +
  90             "     </ns:getResourceOperationStatus></soapenv:Body></soapenv:Envelope>";
  91
  92
  93     private void updateResOperStatus(ResourceOperationStatus resourceOperationStatus) throws RouteException {
  94         logger.info("AbstractSdncOperationTask.updateResOperStatus begin!");
  95                 String requestsdbEndPoint = env.getProperty("mso.adapters.openecomp.db.endpoint");
  96         HttpPost httpPost = new HttpPost(requestsdbEndPoint);
  97         httpPost.addHeader("Authorization", "Basic YnBlbDpwYXNzd29yZDEk");
  98         httpPost.addHeader("Content-type", "application/soap+xml");
  99         String postBody = getPostStringBody(resourceOperationStatus);
 100         httpPost.setEntity(new StringEntity(postBody, ContentType.APPLICATION_XML));
 101         httpPost(requestsdbEndPoint, httpPost);
 102         logger.info("AbstractSdncOperationTask.updateResOperStatus end!");
 103     }
 104
 105     protected String getPostbody(Object inputEntity) {
 106         ObjectMapper objectMapper = new ObjectMapper();
 107         String postBody = null;
 108         try {
 109             objectMapper.setSerializationInclusion(JsonInclude.Include.NON_EMPTY);
 110             postBody = objectMapper.writeValueAsString(inputEntity);
 111         } catch (JsonProcessingException e) {
 112             logger.error(Arrays.toString(e.getStackTrace()));
 113         }
 114         return postBody;
 115     }
 116
 117     protected String httpPost(String url, HttpPost httpPost) throws RouteException {
 118         logger.info("AbstractSdncOperationTask.httpPost begin!");
 119         String result = null;
 120
 121         String errorMsg;
 122         try(CloseableHttpClient httpClient = HttpClients.createDefault()) {
 123             CloseableHttpResponse closeableHttpResponse = httpClient.execute(httpPost);
 124             result = EntityUtils.toString(closeableHttpResponse.getEntity());
 125             logger.info("result = {}", result);
 126             if(closeableHttpResponse.getStatusLine().getStatusCode() != 200) {
 127                 logger.info("exception: fail for status code = {}", closeableHttpResponse.getStatusLine().getStatusCode());
 128                 throw new RouteException(result, "SERVICE_GET_ERR");
 129             }
 130
 131             closeableHttpResponse.close();
 132         } catch (IOException e) {
 133             errorMsg = url + ":httpPostWithJSON connect faild";
 134             logger.info("exception: POST_CONNECT_FAILD : {}", errorMsg);
 135             throwsRouteException(errorMsg, e, "POST_CONNECT_FAILD");
 136         }
 137
 138         logger.info("AbstractSdncOperationTask.httpPost end!");
 139         return result;
 140     }
 141
 142     private static void throwsRouteException(String errorMsg, Exception e, String errorCode) throws RouteException {
 143         String msg = errorMsg + ".errorMsg:" + e.getMessage();
 144         logger.info("exception: {}", msg);
 145         throw new RouteException(errorMsg, errorCode);
 146     }
 147
 148     private String getPostStringBody(ResourceOperationStatus resourceOperationStatus) {
 149         logger.info("AbstractSdncOperationTask.getPostStringBody begin!");
 150         String postBody = POST_BODY_TEMPLATE;
 151         postBody = postBody.replace("$errorCode", resourceOperationStatus.getErrorCode());
 152         postBody = postBody.replace("$jobId", resourceOperationStatus.getJobId());
 153         postBody = postBody.replace("$operType", resourceOperationStatus.getOperType());
 154         postBody = postBody.replace("$operationId", resourceOperationStatus.getOperationId());
 155         postBody = postBody.replace("$progress", resourceOperationStatus.getProgress());
 156         postBody = postBody.replace("$resourceTemplateUUID", resourceOperationStatus.getResourceTemplateUUID());
 157         postBody = postBody.replace("$serviceId", resourceOperationStatus.getServiceId());
 158         postBody = postBody.replace("$status", resourceOperationStatus.getStatus());
 159         postBody = postBody.replace("$statusDescription", resourceOperationStatus.getStatusDescription());
 160         logger.info("AbstractSdncOperationTask.getPostStringBody end!");
 161         return postBody;
 162     }
 163
 164     private String getGetStringBody(String serviceId, String operationId, String resourceTemplateUUID) {
 165         logger.info("AbstractSdncOperationTask.getGetStringBody begin!");
 166         String getBody = GET_BODY_TEMPLATE;
 167         getBody = getBody.replace("$operationId", operationId);
 168         getBody = getBody.replace("$resourceTemplateUUID", resourceTemplateUUID);
 169         getBody = getBody.replace("$serviceId", serviceId);
 170         logger.info("AbstractSdncOperationTask.getGetStringBody end!");
 171         return getBody;
 172     }
 173
 174     private ResourceOperationStatus getResourceOperationStatus(String serviceId, String operationId, String resourceTemplateUUID) throws RouteException {
 175         logger.info("AbstractSdncOperationTask.getResourceOperationStatus begin!");
 176                 String requestsdbEndPoint = env.getProperty("mso.adapters.openecomp.db.endpoint");
 177         HttpPost httpPost = new HttpPost(requestsdbEndPoint);
 178         httpPost.addHeader("Authorization", "Basic YnBlbDpwYXNzd29yZDEk");
 179         httpPost.addHeader("Content-type", "application/soap+xml");
 180         String getBody = getGetStringBody(serviceId, operationId, resourceTemplateUUID);
 181         httpPost.setEntity(new StringEntity(getBody, ContentType.APPLICATION_XML));
 182         String result = httpPost(requestsdbEndPoint, httpPost);
 183         ResourceOperationStatus resourceOperationStatus = getResourceOperationStatusFromXmlString(result);
 184         logger.info("AbstractSdncOperationTask.getResourceOperationStatus end!");
 185         return resourceOperationStatus;
 186     }
 187
 188     private ResourceOperationStatus getResourceOperationStatusFromXmlString(String result) {
 189         logger.info("AbstractSdncOperationTask.getResourceOperationStatusFromXmlString begin!");
 190         ResourceOperationStatus resourceOperationStatus = new ResourceOperationStatus();
 191         resourceOperationStatus.setErrorCode(getValueByName("errorCode", result));
 192         resourceOperationStatus.setJobId(getValueByName("jobId", result));
 193         resourceOperationStatus.setOperType(getValueByName("operType", result));
 194         resourceOperationStatus.setOperationId(getValueByName("operationId", result));
 195         resourceOperationStatus.setProgress(getValueByName("progress", result));
 196         resourceOperationStatus.setResourceTemplateUUID(getValueByName("resourceTemplateUUID", result));
 197         resourceOperationStatus.setServiceId(getValueByName("serviceId", result));
 198         resourceOperationStatus.setStatus(getValueByName("status", result));
 199         resourceOperationStatus.setStatusDescription(getValueByName("statusDescription", result));
 200         logger.info("AbstractSdncOperationTask.getResourceOperationStatusFromXmlString end!");
 201         return resourceOperationStatus;
 202     }
 203
 204     private String getValueByName(String name, String xml) {
 205         if (!StringUtils.isBlank(xml) && xml.contains(name)) {
 206             String start = "<" + name + ">";
 207             String end = "</" + name + ">";
 208             return xml.substring(xml.indexOf(start), xml.indexOf(end)).replace(start, "");
 209         }
 210         return "";
 211     }
 212
 213     @Override
 214     public void execute(DelegateExecution execution) {
 215         logger.info("AbstractSdncOperationTask.execute begin!");
 216         GenericResourceApi genericResourceApiClient = getGenericResourceApiClient();
 217         try {
 218             Map<String, String> inputs = getInputs(execution);
 219
 220             sendRestrequestAndHandleResponse(execution, inputs, genericResourceApiClient);
 221             execution.setVariable("SDNCA_SuccessIndicator", true);
 222         } catch (Exception e) {
 223             logger.info("exception: AbstractSdncOperationTask.fail!");
 224             logger.error("exception: AbstractSdncOperationTask.fail!:", e);
 225             logger.error(Arrays.toString(e.getStackTrace()));
 226             execution.setVariable("SDNCA_SuccessIndicator", false);
 227             updateProgress(execution, RequestsDbConstant.Status.ERROR, null, "100", "sendRestrequestAndHandleResponse finished!");
 228
 229         }
 230         logger.info("AbstractSdncOperationTask.execute end!");
 231     }
 232
 233     protected Map<String, String> getInputs(DelegateExecution execution) {
 234         logger.info("AbstractSdncOperationTask.getInputs begin!");
 235         Map<String, String> inputs = new HashMap<>();
 236         String json = (String) execution.getVariable(SDCADAPTOR_INPUTS);
 237         if (!StringUtils.isBlank(json)) {
 238             JSONObject jsonObject = new JSONObject(json);
 239             JSONObject paras = jsonObject.getJSONObject("additionalParamForNs");
 240             Iterator<String> iterator = paras.keys();
 241             while (iterator.hasNext()) {
 242                 String key = iterator.next();
 243                 inputs.put(key, paras.getString(key));
 244             }
 245         }
 246         logger.info("AbstractSdncOperationTask.getInputs end!");
 247         return inputs;
 248     }
 249
 250     public abstract void sendRestrequestAndHandleResponse(DelegateExecution execution,
 251                                                           Map<String, String> inputs,
 252                                                           GenericResourceApi genericResourceApiClient) throws Exception;
 253
 254     public void updateProgress(DelegateExecution execution,
 255                                String status,
 256                                String errorCode,
 257                                String progress,
 258                                String statusDescription) {
 259         logger.info("AbstractSdncOperationTask.updateProgress begin!");
 260         String serviceId = (String) execution.getVariable("serviceId");
 261         serviceId = StringUtils.isBlank(serviceId) ? (String) execution.getVariable("serviceInstanceId") : serviceId;
 262         String operationId = (String) execution.getVariable("operationId");
 263         String resourceTemplateUUID = (String) execution.getVariable("resourceUUID");
 264         String resourceTemplateId = (String) execution.getVariable("resourceTemplateId");
 265         resourceTemplateId = StringUtils.isBlank(resourceTemplateId) ? "" : resourceTemplateUUID;
 266         resourceTemplateUUID = StringUtils.isBlank(resourceTemplateUUID) ? resourceTemplateId : resourceTemplateUUID;
 267         try {
 268             ResourceOperationStatus resourceOperationStatus = getResourceOperationStatus(serviceId, operationId, resourceTemplateUUID);
 269             if (!StringUtils.isBlank(status)) {
 270                 resourceOperationStatus.setStatus(status);
 271             }
 272             if (!StringUtils.isBlank(errorCode)) {
 273                 resourceOperationStatus.setErrorCode(errorCode);
 274             }
 275             if (!StringUtils.isBlank(progress)) {
 276                 resourceOperationStatus.setProgress(progress);
 277             }
 278             if (!StringUtils.isBlank(statusDescription)) {
 279                 resourceOperationStatus.setStatusDescription(statusDescription);
 280             }
 281             updateResOperStatus(resourceOperationStatus);
 282             logger.info("AbstractSdncOperationTask.updateProgress end!");
 283         } catch (Exception exception) {
 284             logger.info("exception: AbstractSdncOperationTask.updateProgress fail!");
 285             logger.error("exception: AbstractSdncOperationTask.updateProgress fail:", exception);
 286             logger.error("{} {} {} {} {}", MessageEnum.GENERAL_EXCEPTION.toString(),
 287                 " updateProgress catch exception: ", this.getTaskName(),
 288                 ErrorCode.UnknownError.getValue(), exception.getClass().toString());
 289         }
 290     }
 291
 292
 293     protected boolean isSend2SdncDirectly() {
 294         logger.info("AbstractSdncOperationTask.isSend2SdncDirectly begin!");
 295         String sdncHost = UrnPropertiesReader.getVariable("sdnc.host");
 296             if (!StringUtils.isBlank(sdncHost)) {
 297                 logger.info("AbstractSdncOperationTask.isSend2SdncDirectly = true.");
 298                 return true;
 299             }
 300
 301         logger.info("AbstractSdncOperationTask.isSend2SdncDirectly = false.");
 302         return false;
 303     }
 304
 305     protected String getSdncIp() {
 306         logger.info("AbstractSdncOperationTask.getSdncIp begin.");
 307         String sdncIp = null;
 308          sdncIp = UrnPropertiesReader.getVariable("sdnc-ip");
 309         String returnIp = StringUtils.isBlank(sdncIp) || !isIp(sdncIp) ? null : sdncIp;
 310         logger.info("AbstractSdncOperationTask.getSdncIp: sdncIp = {}", returnIp);
 311         return returnIp;
 312     }
 313
 314     protected String getSdncPort() {
 315         logger.info("AbstractSdncOperationTask.getSdncPort begin.");
 316         String sdncPort = UrnPropertiesReader.getVariable("sdnc-port");
 317         String returnPort = StringUtils.isBlank(sdncPort) ? null : sdncPort;
 318         logger.info("AbstractSdncOperationTask.getSdncPort: returnPort = {}", sdncPort);
 319         return returnPort;
 320     }
 321
 322     protected String getSdncHost() {
 323         String sdncHost = UrnPropertiesReader.getVariable("sdnc.host");
 324         logger.info("AbstractSdncOperationTask.getSdncPort: returnPort = {}", sdncHost);
 325         return sdncHost;
 326     }
 327
 328     private GenericResourceApi getGenericResourceApiClient() {
 329         logger.info("AbstractSdncOperationTask.getGenericResourceApiClient begin!");
 330         String msbIp = System.getenv().get(ONAP_IP);
 331         int msbPort = DEFAULT_MSB_PORT;
 332         if (StringUtils.isBlank(msbIp) || !isIp(msbIp)) {
 333             msbIp = env.getProperty("msb-ip");
 334             if (StringUtils.isBlank(msbIp)) {
 335                 msbIp = env.getProperty("msb.address", DEFAULT_MSB_IP);
 336             }
 337         }
 338         String strMsbPort = env.getProperty("msb-port");
 339         if (StringUtils.isBlank(strMsbPort)) {
 340             strMsbPort = env.getProperty("msb.port", String.valueOf(DEFAULT_MSB_PORT));
 341         }
 342         msbPort = Integer.valueOf(strMsbPort);
 343
 344         logger.info("AbstractSdncOperationTask.getGenericResourceApiClient msbIp = " + msbIp + " msbPort = " + msbPort);
 345         MSBServiceClient msbClient = new MSBServiceClient(msbIp, msbPort);
 346         RestServiceCreater restServiceCreater = new RestServiceCreater(msbClient);
 347         logger.info("AbstractSdncOperationTask.getGenericResourceApiClient end!");
 348         return restServiceCreater.createService(GenericResourceApi.class);
 349     }
 350
 351     protected boolean isIp(String msbIp) {
 352         return !StringUtils.isBlank(msbIp) && msbIp.split("\\.").length == 4;
 353     }
 354
 355     public String getProcessKey(DelegateExecution execution) {
 356         return execution.getProcessEngineServices().getRepositoryService().getProcessDefinition(execution.getProcessDefinitionId()).getKey();
 357     }
 358 }