Merge "Support Resource Recipe Common Model"

3 files changed, 416 insertions, 0 deletions

diff --git a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/recipe/BpmnParam.java b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/recipe/BpmnParam.java
new file mode 100644
index 0000000000..f4ebd0615a
--- /dev/null
+++ b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/recipe/BpmnParam.java
@@ -0,0 +1,54 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - SO
+ * ================================================================================
+ * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.openecomp.mso.bpmn.common.recipe;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ *  The bpmn workflow input param object
+ */
+public class BpmnParam {
+	
+	@JsonProperty("value")
+	private String value;
+	@JsonProperty("type")
+	private String type = "String";
+
+
+	public BpmnParam() {
+		/* Empty constructor */
+	}
+	
+	@JsonProperty("value")
+	public String getValue() {
+		return value;
+	}
+	
+	@JsonProperty("type")
+	public void setValue(String value) {
+		this.value = value;
+	}
+
+	@Override
+	public String toString() {
+		return "CamundaInput [value=" + value + ", type=" + type + "]";
+	}	
+	
+}
diff --git a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/recipe/BpmnRestClient.java b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/recipe/BpmnRestClient.java
new file mode 100644
index 0000000000..446de10ee2
--- /dev/null
+++ b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/recipe/BpmnRestClient.java
@@ -0,0 +1,219 @@
+/*-

+ * ============LICENSE_START=======================================================

+ * ONAP - SO

+ * ================================================================================

+ * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.

+ * ================================================================================

+ * Licensed under the Apache License, Version 2.0 (the "License");

+ * you may not use this file except in compliance with the License.

+ * You may obtain a copy of the License at

+ *

+ *      http://www.apache.org/licenses/LICENSE-2.0

+ *

+ * Unless required by applicable law or agreed to in writing, software

+ * distributed under the License is distributed on an "AS IS" BASIS,

+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

+ * See the License for the specific language governing permissions and

+ * limitations under the License.

+ * ============LICENSE_END=========================================================

+ */

+

+package org.openecomp.mso.bpmn.common.recipe;

+

+import java.io.IOException;

+import java.security.GeneralSecurityException;

+

+import javax.xml.bind.DatatypeConverter;

+

+import org.apache.http.HttpResponse;

+import org.apache.http.client.ClientProtocolException;

+import org.apache.http.client.HttpClient;

+import org.apache.http.client.config.RequestConfig;

+import org.apache.http.client.methods.HttpPost;

+import org.apache.http.entity.StringEntity;

+import org.apache.http.impl.client.HttpClientBuilder;

+import org.openecomp.mso.logger.MessageEnum;

+import org.openecomp.mso.logger.MsoLogger;

+import org.openecomp.mso.properties.MsoJavaProperties;

+import org.openecomp.mso.properties.MsoPropertiesFactory;

+import org.openecomp.mso.utils.CryptoUtils;

+

+/**

+ * Support to call resource recipes from the BPMN workflow.

+ * Such as call resource recipe in service workflow.

+ * <br>

+ * <p>

+ * </p>

+ * 

+ * @author

+ * @version ONAP Beijing Release 2018-02-27

+ */

+public class BpmnRestClient {

+

+    public static final String DEFAULT_BPEL_AUTH = "admin:admin";

+

+    public static final String ENCRYPTION_KEY = "aa3871669d893c7fb8abbcda31b88b4f";

+

+    public static final String CONTENT_TYPE_JSON = "application/json";

+

+    public static final String CAMUNDA_AUTH = "camundaAuth";

+

+    private final static String MSO_PROP_APIHANDLER_INFRA = "MSO_PROP_APIHANDLER_INFRA";

+

+    private static MsoPropertiesFactory msoPropertiesFactory = new MsoPropertiesFactory();

+

+    private static MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL);

+

+    private static boolean noProperties = true;

+

+    public synchronized static MsoJavaProperties loadMsoProperties() {

+        MsoJavaProperties msoProperties;

+        try {

+            msoProperties = msoPropertiesFactory.getMsoJavaProperties(MSO_PROP_APIHANDLER_INFRA);

+        } catch(Exception e) {

+            msoLogger.error(MessageEnum.APIH_LOAD_PROPERTIES_FAIL, MSO_PROP_APIHANDLER_INFRA, "", "", MsoLogger.ErrorCode.DataError,

+                    "Exception when loading MSO Properties", e);

+            return null;

+        }

+

+        if(msoProperties != null && msoProperties.size() > 0) {

+            noProperties = false;

+            msoLogger.info(MessageEnum.APIH_PROPERTY_LOAD_SUC, "", "");

+            return msoProperties;

+        } else {

+            msoLogger.error(MessageEnum.APIH_NO_PROPERTIES, MSO_PROP_APIHANDLER_INFRA, "", "", MsoLogger.ErrorCode.DataError,

+                    "No MSO APIH_INFRA Properties found");

+            return null;

+        }

+    }

+

+    public synchronized static final boolean getNoPropertiesState() {

+        return noProperties;

+    }

+

+    /**

+     * post the recipe Uri

+     * <br>

+     * 

+     * @param recipeUri The request recipe uri

+     * @param requestId the request id

+     * @param recipeTimeout The recipe time out

+     * @param requestAction The request action

+     * @param serviceInstanceId The service instance id

+     * @param serviceType The service Type

+     * @param requestDetails The request Details, these information is from runtime

+     * @param recipeParamXsd The recipe params, its from recipe design

+     * @return The response of the recipe.

+     * @throws ClientProtocolException

+     * @throws IOException

+     * @since ONAP Beijing Release

+     */

+    public static HttpResponse post(String recipeUri, String requestId, int recipeTimeout, String requestAction, String serviceInstanceId, String serviceType,

+            String requestDetails, String recipeParamXsd) throws ClientProtocolException, IOException {

+

+        HttpClient client = HttpClientBuilder.create().build();

+

+        HttpPost post = new HttpPost(recipeUri);

+        MsoJavaProperties props = loadMsoProperties();

+        RequestConfig requestConfig =

+                RequestConfig.custom().setSocketTimeout(recipeTimeout).setConnectTimeout(recipeTimeout).setConnectionRequestTimeout(recipeTimeout).build();

+        post.setConfig(requestConfig);

+        msoLogger.debug("call the bpmn,  url:" + recipeUri);

+        String jsonReq = wrapResourceRequest(requestId, recipeTimeout, requestAction, serviceInstanceId, serviceType, requestDetails, recipeParamXsd);

+

+        StringEntity input = new StringEntity(jsonReq);

+        input.setContentType(CONTENT_TYPE_JSON);

+        String encryptedCredentials;

+        if(props != null) {

+            encryptedCredentials = props.getProperty(CAMUNDA_AUTH, null);

+            if(encryptedCredentials != null) {

+                String userCredentials = getEncryptedPropValue(encryptedCredentials, DEFAULT_BPEL_AUTH, ENCRYPTION_KEY);

+                if(userCredentials != null) {

+                    post.addHeader("Authorization", "Basic " + new String(DatatypeConverter.printBase64Binary(userCredentials.getBytes())));

+                }

+            }

+        }

+        post.setEntity(input);

+        return client.execute(post);

+    }

+

+    /**

+     * prepare the resource recipe bpmn request.

+     * <br>

+     * 

+     * @param requestId

+     * @param recipeTimeout

+     * @param requestAction

+     * @param serviceInstanceId

+     * @param serviceType

+     * @param requestDetails

+     * @param recipeParams

+     * @return

+     * @since ONAP Beijing Release

+     */

+    private static String wrapResourceRequest(String requestId, int recipeTimeout, String requestAction, String serviceInstanceId, String serviceType,

+            String requestDetails, String recipeParams) {

+        String jsonReq = null;

+        if(requestId == null) {

+            requestId = "";

+        }

+        if(requestAction == null) {

+            requestAction = "";

+        }

+        if(serviceInstanceId == null) {

+            serviceInstanceId = "";

+        }

+

+        if(requestDetails == null) {

+            requestDetails = "";

+        }

+

+        try {

+            ResourceRecipeRequest recipeRequest = new ResourceRecipeRequest();

+            BpmnParam resourceInput = new BpmnParam();

+            BpmnParam host = new BpmnParam();

+            BpmnParam requestIdInput = new BpmnParam();

+            BpmnParam requestActionInput = new BpmnParam();

+            BpmnParam serviceInstanceIdInput = new BpmnParam();

+            BpmnParam serviceTypeInput = new BpmnParam();

+            BpmnParam recipeParamsInput = new BpmnParam();

+            // host.setValue(parseURL());

+            requestIdInput.setValue(requestId);

+            requestActionInput.setValue(requestAction);

+            serviceInstanceIdInput.setValue(serviceInstanceId);

+            recipeParamsInput.setValue(recipeParams);

+            resourceInput.setValue(requestDetails);

+            recipeRequest.setHost(host);

+            recipeRequest.setRequestId(requestIdInput);

+            recipeRequest.setRequestAction(requestActionInput);

+            recipeRequest.setServiceInstanceId(serviceInstanceIdInput);

+            recipeRequest.setServiceType(serviceTypeInput);

+            recipeRequest.setRecipeParams(recipeParamsInput);

+            jsonReq = recipeRequest.toString();

+            msoLogger.debug("request body is " + jsonReq);

+        } catch(Exception e) {

+            msoLogger.error(MessageEnum.APIH_WARP_REQUEST, "Camunda", "wrapVIDRequest", MsoLogger.ErrorCode.BusinessProcesssError, "Error in APIH Warp request",

+                    e);

+        }

+        return jsonReq;

+    }

+

+    /**

+     * <br>

+     * 

+     * @param prop

+     * @param defaultValue

+     * @param encryptionKey

+     * @return

+     * @since ONAP Beijing Release

+     */

+    protected static String getEncryptedPropValue(String prop, String defaultValue, String encryptionKey) {

+        try {

+            return CryptoUtils.decrypt(prop, encryptionKey);

+        } catch(GeneralSecurityException e) {

+            msoLogger.debug("Security exception", e);

+        }

+        return defaultValue;

+    }

+

+}

diff --git a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/recipe/ResourceRecipeRequest.java b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/recipe/ResourceRecipeRequest.java
new file mode 100644
index 0000000000..5bf5a02a38
--- /dev/null
+++ b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/recipe/ResourceRecipeRequest.java
@@ -0,0 +1,143 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - SO
+ * ================================================================================
+ * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.openecomp.mso.bpmn.common.recipe;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+import com.fasterxml.jackson.annotation.JsonRootName;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+
+/**
+ * java object of the resource recipe , it
+ * will be passed to the Camunda process
+ */
+@JsonPropertyOrder({"resourceInput", "host", "requestId", "requestAction", "serviceInstanceId", "serviceType", "recipeParams"})
+@JsonRootName("variables")
+public class ResourceRecipeRequest {
+
+    @JsonProperty("resourceInput")
+    private BpmnParam resourceInput;
+
+    @JsonProperty("host")
+    private BpmnParam host;
+
+    @JsonProperty("requestId")
+    private BpmnParam requestId;
+
+    @JsonProperty("requestAction")
+    private BpmnParam requestAction;
+
+    @JsonProperty("serviceInstanceId")
+    private BpmnParam serviceInstanceId;
+
+    @JsonProperty("serviceType")
+    private BpmnParam serviceType;
+
+    @JsonProperty("recipeParams")
+    private BpmnParam recipeParams;
+
+    @JsonProperty("resourceInput")
+    public BpmnParam getResourceInput() {
+        return resourceInput;
+    }
+
+    @JsonProperty("resourceInput")
+    public void setResourceInput(BpmnParam resourceInput) {
+        this.resourceInput = resourceInput;
+    }
+
+    @JsonProperty("host")
+    public BpmnParam getHost() {
+        return host;
+    }
+
+    @JsonProperty("host")
+    public void setHost(BpmnParam host) {
+        this.host = host;
+    }
+
+    @JsonProperty("requestId")
+    public BpmnParam getRequestId() {
+        return requestId;
+    }
+
+    @JsonProperty("requestId")
+    public void setRequestId(BpmnParam requestId) {
+        this.requestId = requestId;
+    }
+
+    @JsonProperty("requestAction")
+    public BpmnParam getRequestAction() {
+        return requestAction;
+    }
+
+    @JsonProperty("requestAction")
+    public void setRequestAction(BpmnParam requestAction) {
+        this.requestAction = requestAction;
+    }
+
+    @JsonProperty("serviceInstanceId")
+    public BpmnParam getServiceInstanceId() {
+        return serviceInstanceId;
+    }
+
+    @JsonProperty("serviceInstanceId")
+    public void setServiceInstanceId(BpmnParam serviceInstanceId) {
+        this.serviceInstanceId = serviceInstanceId;
+    }
+
+    @JsonProperty("serviceType")
+    public BpmnParam getServiceType() {
+        return serviceType;
+    }
+
+    @JsonProperty("serviceType")
+    public void setServiceType(BpmnParam serviceType) {
+        this.serviceType = serviceType;
+    }
+
+    @JsonProperty("recipeParams")
+    public BpmnParam getRecipeParams() {
+        return recipeParams;
+    }
+
+    @JsonProperty("recipeParams")
+    public void setRecipeParams(BpmnParam recipeParams) {
+        this.recipeParams = recipeParams;
+    }
+
+    @Override
+    public String toString() {
+        ObjectMapper mapper = new ObjectMapper();
+        mapper.configure(SerializationFeature.WRAP_ROOT_VALUE, true);
+        String jsonStr = "ResourceRecipeRequest";
+        try {
+            jsonStr = mapper.writeValueAsString(this);
+        } catch(JsonProcessingException e) {
+
+            e.printStackTrace();
+        }
+        return jsonStr;
+    }
+
+}