bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowResource.java

   1 /*-\r
   2  * ============LICENSE_START=======================================================\r
   3  * OPENECOMP - MSO\r
   4  * ================================================================================\r
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * ================================================================================\r
   7  * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * you may not use this file except in compliance with the License.\r
   9  * You may obtain a copy of the License at\r
  10  * \r
  11  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * \r
  13  * Unless required by applicable law or agreed to in writing, software\r
  14  * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * See the License for the specific language governing permissions and\r
  17  * limitations under the License.\r
  18  * ============LICENSE_END=========================================================\r
  19  */\r
  20 \r
  21 package org.openecomp.mso.bpmn.common.workflow.service;\r
  22 \r
  23 import java.util.HashMap;\r
  24 import java.util.List;\r
  25 import java.util.Map;\r
  26 import java.util.UUID;\r
  27 import java.util.concurrent.atomic.AtomicLong;\r
  28 \r
  29 import javax.ws.rs.Consumes;\r
  30 import javax.ws.rs.POST;\r
  31 import javax.ws.rs.Path;\r
  32 import javax.ws.rs.PathParam;\r
  33 import javax.ws.rs.Produces;\r
  34 import javax.ws.rs.core.Context;\r
  35 import javax.ws.rs.core.Response;\r
  36 import javax.ws.rs.core.UriInfo;\r
  37 \r
  38 import org.camunda.bpm.engine.HistoryService;\r
  39 import org.camunda.bpm.engine.ProcessEngineException;\r
  40 import org.camunda.bpm.engine.ProcessEngineServices;\r
  41 import org.camunda.bpm.engine.ProcessEngines;\r
  42 import org.camunda.bpm.engine.RuntimeService;\r
  43 import org.camunda.bpm.engine.history.HistoricVariableInstance;\r
  44 import org.camunda.bpm.engine.runtime.ProcessInstance;\r
  45 import org.camunda.bpm.engine.variable.VariableMap;\r
  46 import org.camunda.bpm.engine.variable.Variables;\r
  47 import org.camunda.bpm.engine.variable.Variables.SerializationDataFormats;\r
  48 import org.camunda.bpm.engine.variable.impl.VariableMapImpl;\r
  49 import org.openecomp.mso.bpmn.core.WorkflowException;\r
  50 import org.openecomp.mso.logger.MessageEnum;\r
  51 import org.openecomp.mso.logger.MsoLogger;\r
  52 import org.slf4j.MDC;\r
  53 \r
  54 @Path("/workflow")\r
  55 public class WorkflowResource {\r
  56         \r
  57         private ProcessEngineServices pes4junit = null;\r
  58 \r
  59         private static final MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL);\r
  60         private static final String LOGMARKER = "[WRKFLOW-RESOURCE]";\r
  61 \r
  62         private static final int DEFAULT_WAIT_TIME = 30000;\r
  63 \r
  64         @Context\r
  65         private UriInfo uriInfo = null;\r
  66 \r
  67         /**\r
  68          * Starts the process instance and responds to client synchronously\r
  69          * If the request does not contain mso-service-request-timeout then it waits for the value specified in DEFAULT_WAIT_TIME\r
  70          * Note: value specified in mso-service-request-timeout is in seconds\r
  71          * During polling time, if there is an exception encountered in the process execution then polling is stopped and the error response is \r
  72          * returned to the client\r
  73          * @param processKey\r
  74          * @param variableMap\r
  75          * @return\r
  76          */\r
  77         @POST\r
  78         @Path("/services/{processKey}")\r
  79         @Produces("application/json")\r
  80         @Consumes("application/json")\r
  81         public Response startProcessInstanceByKey(@PathParam("processKey") String processKey,\r
  82                         VariableMapImpl variableMap) {\r
  83 \r
  84                 Map<String, Object> inputVariables = getInputVariables(variableMap);    \r
  85                 setLogContext(processKey, inputVariables);\r
  86 \r
  87                 WorkflowResponse workflowResponse = new WorkflowResponse();\r
  88                 long startTime = System.currentTimeMillis();\r
  89                 ProcessInstance processInstance = null;\r
  90 \r
  91                 try {\r
  92                         //Kickoff the process\r
  93                         ProcessThread thread = new ProcessThread(inputVariables,processKey,msoLogger);\r
  94                         thread.start();\r
  95 \r
  96                         Map<String, Object> responseMap = null;\r
  97 \r
  98                         //wait for process to be completed\r
  99                         long waitTime = getWaitTime(inputVariables);\r
 100                         long now = System.currentTimeMillis();\r
 101                         long start = now;\r
 102                         long endTime = start + waitTime;\r
 103                         long pollingInterval = 500;\r
 104 \r
 105                         // TEMPORARY LOGIC FOR UNIT TEST REFACTORING\r
 106                         // If this is a unit test (method is invoked directly), wait a max\r
 107                         // of 5 seconds after process ended for a result.  In production,\r
 108                         // wait up to 60 seconds.\r
 109                         long timeToWaitAfterProcessEnded = uriInfo == null ? 5000 : 60000;\r
 110                         AtomicLong timeProcessEnded = new AtomicLong(0);\r
 111                         boolean endedWithNoResponse = false;\r
 112 \r
 113                         while (now <= endTime) {\r
 114                                 Thread.sleep(pollingInterval);\r
 115 \r
 116                                 now = System.currentTimeMillis();\r
 117 \r
 118                                 // Increase the polling interval over time\r
 119 \r
 120                                 long elapsed = now - start;\r
 121 \r
 122                                 if (elapsed > 60000) {\r
 123                                         pollingInterval = 5000;\r
 124                                 } else if (elapsed > 10000) {\r
 125                                         pollingInterval = 1000;\r
 126                                 }\r
 127                                 Exception exception = thread.getException();\r
 128                                 if (exception != null) {\r
 129                                         throw new Exception(exception);\r
 130                                 }\r
 131 \r
 132                                 processInstance = thread.getProcessInstance();\r
 133 \r
 134                                 if (processInstance == null) {\r
 135                                         msoLogger.debug(LOGMARKER + processKey + " process has not been created yet");\r
 136                                         continue;\r
 137                                 }\r
 138 \r
 139                                 String processInstanceId = processInstance.getId();\r
 140                                 workflowResponse.setProcessInstanceID(processInstanceId);                               \r
 141 \r
 142                                 responseMap = getResponseMap(processInstance, processKey, timeProcessEnded);\r
 143 \r
 144                                 if (responseMap == null) {\r
 145                                         msoLogger.debug(LOGMARKER + processKey + " has not produced a response yet");\r
 146 \r
 147                                         if (timeProcessEnded.longValue() != 0) {\r
 148                                                 long elapsedSinceEnded = System.currentTimeMillis() - timeProcessEnded.longValue();\r
 149 \r
 150                                                 if (elapsedSinceEnded > timeToWaitAfterProcessEnded) {\r
 151                                                         endedWithNoResponse = true;\r
 152                                                         break;\r
 153                                                 }\r
 154                                         }\r
 155                                 } else {\r
 156                                         processResponseMap(workflowResponse, responseMap);\r
 157                                         recordEvents(processKey, workflowResponse, startTime);\r
 158                                         return Response.status(workflowResponse.getMessageCode()).entity(workflowResponse).build();\r
 159                                 }\r
 160                         }\r
 161 \r
 162                         //if we dont get response after waiting then send timeout response\r
 163 \r
 164                         String state;\r
 165                         String processInstanceId;\r
 166 \r
 167                         if (processInstance == null) {\r
 168                                 processInstanceId = "N/A";\r
 169                                 state = "NOT STARTED";\r
 170                         } else {\r
 171                                 processInstanceId = processInstance.getProcessInstanceId();\r
 172                                 state = isProcessEnded(processInstanceId) ? "ENDED" : "NOT ENDED";\r
 173                         }\r
 174 \r
 175                         workflowResponse.setMessage("Fail");\r
 176                         if (endedWithNoResponse) {\r
 177                                 workflowResponse.setResponse("Process ended without producing a response");\r
 178                         } else {\r
 179                                 workflowResponse.setResponse("Request timed out, process state: " + state);\r
 180                         }\r
 181                         workflowResponse.setProcessInstanceID(processInstanceId);\r
 182                         recordEvents(processKey, workflowResponse, startTime);\r
 183                         workflowResponse.setMessageCode(500);\r
 184                         return Response.status(500).entity(workflowResponse).build();\r
 185                 } catch (Exception ex) {\r
 186                         msoLogger.debug(LOGMARKER + "Exception in startProcessInstance by key");\r
 187                         ex.printStackTrace();\r
 188                         workflowResponse.setMessage("Fail" );\r
 189                         workflowResponse.setResponse("Error occurred while executing the process: " + ex.getMessage());\r
 190                         if (processInstance != null) workflowResponse.setProcessInstanceID(processInstance.getId());\r
 191                         \r
 192                         msoLogger.error(MessageEnum.BPMN_GENERAL_EXCEPTION_ARG,  "BPMN", MDC.get(processKey), \r
 193                                         MsoLogger.ErrorCode.UnknownError, LOGMARKER + workflowResponse.getMessage()\r
 194                                         + " for processKey: " + processKey + " with response: " + workflowResponse.getResponse());\r
 195                         \r
 196                         workflowResponse.setMessageCode(500);\r
 197                         recordEvents(processKey, workflowResponse, startTime);\r
 198                         return Response.status(500).entity(workflowResponse).build();\r
 199                 }\r
 200         }\r
 201 \r
 202         /**\r
 203          * Returns the wait time, this is used by the resource on how long it should wait to send a response\r
 204          * If none specified DEFAULT_WAIT_TIME is used\r
 205          * @param inputVariables\r
 206          * @return\r
 207          */\r
 208         private int getWaitTime(Map<String, Object> inputVariables)\r
 209         {\r
 210                 String timeout = inputVariables.get("mso-service-request-timeout") == null\r
 211                         ? null : inputVariables.get("mso-service-request-timeout").toString();          \r
 212 \r
 213                 if (timeout != null) {\r
 214                         try {\r
 215                                 return Integer.parseInt(timeout)*1000;\r
 216                         } catch (NumberFormatException nex) {\r
 217                                 msoLogger.debug("Invalid input for mso-service-request-timeout");\r
 218                         }\r
 219                 }\r
 220                 return DEFAULT_WAIT_TIME;\r
 221         }\r
 222         \r
 223         private void recordEvents(String processKey, WorkflowResponse response, long startTime) {\r
 224                 \r
 225                 msoLogger.recordMetricEvent ( startTime, MsoLogger.StatusCode.COMPLETE, MsoLogger.ResponseCode.Suc, \r
 226                                 LOGMARKER + response.getMessage() + " for processKey: "\r
 227                                 + processKey + " with response: " + response.getResponse(), "BPMN", MDC.get(processKey), null);\r
 228                 \r
 229                 msoLogger.recordAuditEvent (startTime, MsoLogger.StatusCode.COMPLETE, MsoLogger.ResponseCode.Suc, \r
 230                                 LOGMARKER + response.getMessage() + " for processKey: "\r
 231                                 + processKey + " with response: " + response.getResponse());\r
 232         }\r
 233 \r
 234         private void setLogContext(String processKey, Map<String, Object> inputVariables) {\r
 235                 MsoLogger.setServiceName("MSO." + processKey);\r
 236                 if (inputVariables != null) {\r
 237                         MsoLogger.setLogContext(getValueFromInputVariables(inputVariables, "mso-request-id"),\r
 238                                 getValueFromInputVariables(inputVariables, "mso-service-instance-id"));\r
 239                 }\r
 240         }\r
 241 \r
 242         private String getValueFromInputVariables(Map<String,Object> inputVariables, String key) {\r
 243                 Object value = inputVariables.get(key);\r
 244                 if (value == null) {\r
 245                         return "N/A";\r
 246                 } else {\r
 247                         return value.toString();\r
 248                 }\r
 249         }\r
 250         \r
 251         /**\r
 252          * Checks to see if the specified process is ended.\r
 253          * @param processInstanceId the process instance ID\r
 254          * @return true if the process is ended\r
 255          */\r
 256         private boolean isProcessEnded(String processInstanceId) {\r
 257                 ProcessEngineServices pes = getProcessEngineServices();\r
 258                 return pes.getRuntimeService().createProcessInstanceQuery().processInstanceId(processInstanceId).singleResult() == null ? true : false ;        \r
 259         }\r
 260 \r
 261         private void processResponseMap(WorkflowResponse workflowResponse, Map<String, Object> responseMap) {\r
 262                 Object object = responseMap.get("Response");\r
 263                 String response = object == null ? null : String.valueOf(object);\r
 264                 if(response == null){\r
 265                         object = responseMap.get("WorkflowResponse");\r
 266                         response = object == null ? null : String.valueOf(object);\r
 267                 }\r
 268 \r
 269                 workflowResponse.setResponse(response); \r
 270 \r
 271                 object = responseMap.get("ResponseCode");\r
 272                 String responseCode = object == null ? null : String.valueOf(object);\r
 273 \r
 274                 try {\r
 275                         workflowResponse.setMessageCode(Integer.parseInt(responseCode));\r
 276                 } catch(NumberFormatException nex) {\r
 277                         msoLogger.debug(LOGMARKER + "Failed to parse ResponseCode: " + responseCode);\r
 278                         workflowResponse.setMessageCode(-1);\r
 279                 }\r
 280 \r
 281                 Object status = responseMap.get("Status");\r
 282 \r
 283                 if ("Success".equalsIgnoreCase(String.valueOf(status))) {\r
 284                         workflowResponse.setMessage("Success");\r
 285                 } else if ("Fail".equalsIgnoreCase(String.valueOf(status))) {\r
 286                         workflowResponse.setMessage("Fail");\r
 287                 } else {\r
 288                         msoLogger.debug(LOGMARKER + "Unrecognized Status: " + responseCode);\r
 289                         workflowResponse.setMessage("Fail");\r
 290                 }\r
 291         }\r
 292 \r
 293         /**\r
 294          * @version 1.0\r
 295          * Triggers the workflow in a separate thread\r
 296          */\r
 297         private class ProcessThread extends Thread {\r
 298                 private final Map<String,Object> inputVariables;\r
 299                 private final String processKey;\r
 300                 private final MsoLogger msoLogger;\r
 301                 private final String businessKey;\r
 302                 private ProcessInstance processInstance = null;\r
 303                 private Exception exception = null;\r
 304 \r
 305                 public ProcessThread(Map<String, Object> inputVariables, String processKey, MsoLogger msoLogger) {\r
 306                         this.inputVariables = inputVariables;\r
 307                         this.processKey = processKey;\r
 308                         this.msoLogger = msoLogger;\r
 309                         this.businessKey = UUID.randomUUID().toString();\r
 310                 }\r
 311 \r
 312                 /**\r
 313                  * If an exception occurs when starting the process instance, it may\r
 314                  * be obtained by calling this method.  Note that exceptions are only\r
 315                  * recorded while the process is executing in its original thread.\r
 316                  * Once a process is suspended, exception recording stops.\r
 317                  * @return the exception, or null if none has occurred\r
 318                  */\r
 319                 public Exception getException() {\r
 320                         return exception;\r
 321                 }\r
 322 \r
 323                 \r
 324                 public ProcessInstance getProcessInstance() {\r
 325                         return this.processInstance;\r
 326                 }\r
 327                 \r
 328                 /**\r
 329                  * Sets the process instance exception.\r
 330                  * @param exception the exception\r
 331                  */\r
 332                 private void setException(Exception exception) {\r
 333                         this.exception = exception;\r
 334                 }\r
 335 \r
 336                 public void run() {\r
 337                         setLogContext(processKey, inputVariables);\r
 338 \r
 339                         long startTime = System.currentTimeMillis();\r
 340                         \r
 341                         try {\r
 342                                 msoLogger.debug(LOGMARKER + "***Received MSO startProcessInstanceByKey with processKey:"\r
 343                                         + processKey + " and variables: " + inputVariables);\r
 344                                 \r
 345                                 msoLogger.recordAuditEvent (startTime, MsoLogger.StatusCode.COMPLETE, MsoLogger.ResponseCode.Suc, LOGMARKER\r
 346                                                 + "Call to MSO workflow/services in Camunda. Received MSO startProcessInstanceByKey with"\r
 347                                                 + " processKey:" + processKey\r
 348                                                 + " businessKey:" + businessKey\r
 349                                                 + " variables: " + inputVariables);\r
 350                                                 \r
 351                                 RuntimeService runtimeService = getProcessEngineServices().getRuntimeService();\r
 352 \r
 353                                 // Note that this method doesn't return until the process suspends\r
 354                                 // itself or finishes.  We provide a business key so we can identify\r
 355                                 // the process instance immediately.\r
 356                                 processInstance = runtimeService.startProcessInstanceByKey(\r
 357                                         processKey, inputVariables);\r
 358 \r
 359                         } catch (Exception e) {\r
 360                                 msoLogger.debug(LOGMARKER + "ProcessThread caught an exception executing "\r
 361                                         + processKey + ": " + e);\r
 362                                 setException(e);\r
 363                         }\r
 364                 }\r
 365 \r
 366         }\r
 367 \r
 368         private Map<String, Object> getInputVariables(VariableMapImpl variableMap) {\r
 369                 VariableMap inputVariables = Variables.createVariables();\r
 370                 @SuppressWarnings("unchecked")\r
 371                 Map<String, Object> vMap = (Map<String, Object>) variableMap.get("variables");\r
 372                 for (String key : vMap.keySet()) { //variabe name vn\r
 373                         @SuppressWarnings("unchecked")\r
 374                         Map<String, Object> valueMap = (Map<String,Object>)vMap.get(key); //value, type\r
 375                         inputVariables.putValueTyped(key, Variables\r
 376                         .objectValue(valueMap.get("value"))\r
 377                         .serializationDataFormat(SerializationDataFormats.JAVA) // tells the engine to use java serialization for persisting the value\r
 378                         .create());\r
 379                 }\r
 380                 return inputVariables;\r
 381         }\r
 382 \r
 383         /**\r
 384          * Attempts to get a response map from the specified process instance.\r
 385          * @return the response map, or null if it is unavailable\r
 386          */\r
 387         private Map<String, Object> getResponseMap(ProcessInstance processInstance,\r
 388                         String processKey, AtomicLong timeProcessEnded) {\r
 389 \r
 390                 String responseMapVariable = processKey + "ResponseMap";\r
 391                 String processInstanceId = processInstance.getId();\r
 392 \r
 393                 // Query the runtime service to see if a response map is ready.\r
 394 \r
 395 /*              RuntimeService runtimeService = getProcessEngineServices().getRuntimeService();\r
 396                 List<Execution> executions = runtimeService.createExecutionQuery()\r
 397                         .processInstanceId(processInstanceId).list();\r
 398 \r
 399                 for (Execution execution : executions) {\r
 400                         @SuppressWarnings("unchecked")\r
 401                         Map<String, Object> responseMap = (Map<String, Object>)\r
 402                                 getVariableFromExecution(runtimeService, execution.getId(),\r
 403                                         responseMapVariable);\r
 404 \r
 405                         if (responseMap != null) {\r
 406                                 msoLogger.debug(LOGMARKER + "Obtained " + responseMapVariable\r
 407                                         + " from process " + processInstanceId + " execution "\r
 408                                         + execution.getId());\r
 409                                 return responseMap;\r
 410                         }\r
 411                 }\r
 412 */\r
 413                 //Querying history seem to return consistent results compared to querying the runtime service\r
 414 \r
 415                 boolean alreadyEnded = timeProcessEnded.longValue() != 0;\r
 416 \r
 417                 if (alreadyEnded || isProcessEnded(processInstance.getId())) {\r
 418                         if (!alreadyEnded) {\r
 419                                 timeProcessEnded.set(System.currentTimeMillis());\r
 420                         }\r
 421 \r
 422                         // Query the history service to see if a response map exists.\r
 423 \r
 424                         HistoryService historyService = getProcessEngineServices().getHistoryService();\r
 425                         @SuppressWarnings("unchecked")\r
 426                         Map<String, Object> responseMap = (Map<String, Object>)\r
 427                                 getVariableFromHistory(historyService, processInstance.getId(),\r
 428                                         responseMapVariable);\r
 429 \r
 430                         if (responseMap != null) {\r
 431                                 msoLogger.debug(LOGMARKER + "Obtained " + responseMapVariable\r
 432                                         + " from process " + processInstanceId + " history");\r
 433                                 return responseMap;\r
 434                         }\r
 435 \r
 436                         // Query the history service for old-style response variables.\r
 437 \r
 438                         String prefix = (String) getVariableFromHistory(historyService, processInstanceId, "prefix");\r
 439 \r
 440                         if (prefix != null) {\r
 441                                 \r
 442                                 // Check for 'WorkflowResponse' variable\r
 443                                 Object workflowResponseObject = getVariableFromHistory(historyService, processInstanceId, "WorkflowResponse");\r
 444                                 String workflowResponse = workflowResponseObject == null ? null : String.valueOf(workflowResponseObject);\r
 445                                 msoLogger.debug(LOGMARKER + "WorkflowResponse: " + workflowResponse);\r
 446                                 \r
 447                                 if (workflowResponse != null) {\r
 448                                         Object responseCodeObject = getVariableFromHistory(historyService, processInstanceId, prefix + "ResponseCode");\r
 449                                         String responseCode = responseCodeObject == null ? null : String.valueOf(responseCodeObject);\r
 450                                         msoLogger.debug(LOGMARKER + prefix + "ResponseCode: " + responseCode);\r
 451                                         responseMap = new HashMap<String, Object>();\r
 452                                         responseMap.put("WorkflowResponse", workflowResponse);\r
 453                                         responseMap.put("ResponseCode", responseCode);\r
 454                                         responseMap.put("Status", "Success");\r
 455                                         return responseMap;\r
 456                                 }\r
 457                                 \r
 458                                 \r
 459                                 // Check for 'WorkflowException' variable\r
 460                                 WorkflowException workflowException = null;\r
 461                                 String workflowExceptionText = null;\r
 462 \r
 463                                 Object workflowExceptionObject = getVariableFromHistory(historyService, processInstanceId, "WorkflowException");\r
 464                                 if(workflowExceptionObject != null) {\r
 465                                         if(workflowExceptionObject instanceof WorkflowException) {\r
 466                                                 workflowException = (WorkflowException) workflowExceptionObject;\r
 467                                                 workflowExceptionText = workflowException.toString();\r
 468                                                 responseMap = new HashMap<String, Object>();\r
 469                                                 responseMap.put("WorkflowException", workflowExceptionText);\r
 470                                                 responseMap.put("ResponseCode", workflowException.getErrorCode());\r
 471                                                 responseMap.put("Status", "Fail");\r
 472                                                 return responseMap;\r
 473                                         }\r
 474                                         else if (workflowExceptionObject instanceof String) {\r
 475                                                 Object object = getVariableFromHistory(historyService, processInstanceId, prefix + "ResponseCode");\r
 476                                                 String responseCode = object == null ? null : String.valueOf(object);\r
 477                                                 workflowExceptionText = (String) workflowExceptionObject;\r
 478                                                 responseMap = new HashMap<String, Object>();\r
 479                                                 responseMap.put("WorkflowException", workflowExceptionText);\r
 480                                                 responseMap.put("ResponseCode", responseCode);\r
 481                                                 responseMap.put("Status", "Fail");\r
 482                                                 return responseMap;\r
 483                                         }\r
 484                                         \r
 485                                 }\r
 486                                 msoLogger.debug(LOGMARKER + "WorkflowException: " + workflowExceptionText);\r
 487                                 \r
 488                                 // BEGIN LEGACY SUPPORT.  TODO: REMOVE THIS CODE\r
 489                                 Object object = getVariableFromHistory(historyService, processInstanceId, processKey + "Response");\r
 490                                 String response = object == null ? null : String.valueOf(object);\r
 491                                 msoLogger.debug(LOGMARKER + processKey + "Response: " + response);\r
 492 \r
 493                                 if (response != null) {\r
 494                                         object = getVariableFromHistory(historyService, processInstanceId, prefix + "ResponseCode");\r
 495                                         String responseCode = object == null ? null : String.valueOf(object);\r
 496                                         msoLogger.debug(LOGMARKER + prefix + "ResponseCode: " + responseCode);\r
 497                                         responseMap = new HashMap<String, Object>();\r
 498                                         responseMap.put("Response", response);\r
 499                                         responseMap.put("ResponseCode", responseCode);\r
 500                                         responseMap.put("Status", "Success");\r
 501                                         return responseMap;\r
 502                                 }\r
 503         \r
 504                                 object = getVariableFromHistory(historyService, processInstanceId, prefix + "ErrorResponse");\r
 505                                 String errorResponse = object == null ? null : String.valueOf(object);\r
 506                                 msoLogger.debug(LOGMARKER + prefix + "ErrorResponse: " + errorResponse);\r
 507 \r
 508                                 if (errorResponse != null) {\r
 509                                         object = getVariableFromHistory(historyService, processInstanceId, prefix + "ResponseCode");\r
 510                                         String responseCode = object == null ? null : String.valueOf(object);\r
 511                                         msoLogger.debug(LOGMARKER + prefix + "ResponseCode: " + responseCode);\r
 512                                         responseMap = new HashMap<String, Object>();\r
 513                                         responseMap.put("Response", errorResponse);\r
 514                                         responseMap.put("ResponseCode", responseCode);\r
 515                                         responseMap.put("Status", "Fail");\r
 516                                         return responseMap;\r
 517                                 }\r
 518                                 // END LEGACY SUPPORT.  TODO: REMOVE THIS CODE\r
 519                         }\r
 520                 }\r
 521                 return null;\r
 522         }\r
 523         \r
 524         /**\r
 525          * Gets a variable value from the specified execution.\r
 526          * @return the variable value, or null if the variable could not be\r
 527          * obtained\r
 528          */\r
 529         private Object getVariableFromExecution(RuntimeService runtimeService,\r
 530                         String executionId, String variableName) {\r
 531                 try {\r
 532                         return runtimeService.getVariable(executionId, variableName);\r
 533                 } catch (ProcessEngineException e) {\r
 534                         // Most likely cause is that the execution no longer exists.\r
 535                         msoLogger.debug("Error retrieving execution " + executionId\r
 536                                 + " variable " + variableName + ": " + e);\r
 537                         return null;\r
 538                 }\r
 539         }\r
 540         /**\r
 541          * Gets a variable value from specified historical process instance.\r
 542          * @return the variable value, or null if the variable could not be\r
 543          * obtained\r
 544          */\r
 545         private Object getVariableFromHistory(HistoryService historyService,\r
 546                         String processInstanceId, String variableName) {\r
 547                 try {\r
 548                         HistoricVariableInstance v = historyService.createHistoricVariableInstanceQuery()\r
 549                                 .processInstanceId(processInstanceId).variableName(variableName).singleResult();\r
 550                         return v == null ? null : v.getValue();\r
 551                 } catch (Exception e) {\r
 552                         msoLogger.debug("Error retrieving process " + processInstanceId\r
 553                                 + " variable " + variableName + " from history: " + e);\r
 554                         return null;\r
 555                 }\r
 556         }\r
 557         \r
 558         @POST\r
 559         @Path("/services/{processKey}/{processInstanceId}")\r
 560         @Produces("application/json")\r
 561         @Consumes("application/json")\r
 562         public WorkflowResponse getProcessVariables(@PathParam("processKey") String processKey, @PathParam("processInstanceId") String processInstanceId) {\r
 563                 //TODO filter only set of variables\r
 564                 WorkflowResponse response = new WorkflowResponse();\r
 565 \r
 566                 long startTime = System.currentTimeMillis();\r
 567                 try {\r
 568                         ProcessEngineServices engine = getProcessEngineServices();\r
 569                         List<HistoricVariableInstance> variables = engine.getHistoryService().createHistoricVariableInstanceQuery().processInstanceId(processInstanceId).list();\r
 570                         Map<String,String> variablesMap = new HashMap<String,String>();\r
 571                         for (HistoricVariableInstance variableInstance: variables) {\r
 572                                 variablesMap.put(variableInstance.getName(), variableInstance.getValue().toString());\r
 573                         }\r
 574 \r
 575                         msoLogger.debug(LOGMARKER + "***Received MSO getProcessVariables with processKey:" + processKey + " and variables: " + variablesMap.toString());\r
 576                         \r
 577                         msoLogger.recordAuditEvent (startTime, MsoLogger.StatusCode.COMPLETE, MsoLogger.ResponseCode.Suc, LOGMARKER \r
 578                                         + "Call to MSO workflow/services in Camunda. Received MSO getProcessVariables with processKey:" \r
 579                                         + processKey + " and variables: " \r
 580                                         + variablesMap.toString());\r
 581                         \r
 582                         \r
 583                         response.setVariables(variablesMap);\r
 584                         response.setMessage("Success");\r
 585                         response.setResponse("Successfully retrieved the variables"); \r
 586                         response.setProcessInstanceID(processInstanceId);\r
 587 \r
 588                         msoLogger.debug(LOGMARKER + response.getMessage() + " for processKey: " + processKey + " with response: " + response.getResponse());\r
 589                 } catch (Exception ex) {\r
 590                         response.setMessage("Fail");\r
 591                         response.setResponse("Failed to retrieve the variables," + ex.getMessage()); \r
 592                         response.setProcessInstanceID(processInstanceId);\r
 593                         \r
 594                         msoLogger.error (MessageEnum.BPMN_GENERAL_EXCEPTION_ARG, "BPMN", MDC.get(processKey), MsoLogger.ErrorCode.UnknownError, LOGMARKER \r
 595                                         + response.getMessage() \r
 596                                         + " for processKey: " \r
 597                                         + processKey \r
 598                                         + " with response: " \r
 599                                         + response.getResponse());\r
 600                         \r
 601                 }\r
 602                 \r
 603                 msoLogger.recordMetricEvent ( startTime, MsoLogger.StatusCode.COMPLETE, MsoLogger.ResponseCode.Suc, \r
 604                                 LOGMARKER + response.getMessage() + " for processKey: "\r
 605                                 + processKey + " with response: " + response.getResponse(), "BPMN", MDC.get(processKey), null);\r
 606                 \r
 607                 msoLogger.recordAuditEvent (startTime, MsoLogger.StatusCode.COMPLETE, MsoLogger.ResponseCode.Suc, \r
 608                                 LOGMARKER + response.getMessage() + " for processKey: "\r
 609                                 + processKey + " with response: " + response.getResponse());\r
 610                 \r
 611                 return response;\r
 612         }\r
 613 \r
 614         private ProcessEngineServices getProcessEngineServices() {\r
 615                 if (pes4junit == null) {\r
 616                         return ProcessEngines.getDefaultProcessEngine();\r
 617                 } else {\r
 618                         return pes4junit;\r
 619                 }\r
 620         }\r
 621 \r
 622         public void setProcessEngineServices4junit(ProcessEngineServices pes) {\r
 623                 pes4junit = pes;\r
 624         }\r
 625 }\r