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