bpmn/MSOCommonBPMN/src/main/groovy/org/openecomp/mso/bpmn/common/scripts/SDNCAdapter.groovy

   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.scripts;\r
  22 \r
  23 import java.text.SimpleDateFormat\r
  24 \r
  25 import org.camunda.bpm.engine.runtime.Execution\r
  26 import org.openecomp.mso.bpmn.core.WorkflowException\r
  27 \r
  28 \r
  29 // SDNC Adapter Request/Response processing\r
  30 \r
  31 public class SDNCAdapter extends AbstractServiceTaskProcessor {\r
  32 \r
  33         def Prefix="SDNCA_"\r
  34         ExceptionUtil exceptionUtil = new ExceptionUtil()\r
  35 \r
  36         // Script Task: Process SDNC Workflow Request\r
  37         // Params:      Workflow Execution\r
  38         // Assume:      Received SDNCAdapterWorkflowRequest is in variable 'sdncAdapterWorkflowRequest'\r
  39         //                      Put created SDNCAdapterRequest in variable 'sdncAdapterRequest'\r
  40         public void preProcessRequest (Execution execution) {\r
  41                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")\r
  42                 try{\r
  43 \r
  44                         utils.log("DEBUG", "=========== Begin PreProcess SDNCAdapterRequestScript  ===========", isDebugEnabled)\r
  45                         utils.log("DEBUG", "Incoming sdncAdapterWorkflowRequest:\n" + execution.getVariable("sdncAdapterWorkflowRequest"), isDebugEnabled)\r
  46 \r
  47                         // Initialize some variables used throughout the flow\r
  48                         execution.setVariable("prefix", Prefix)\r
  49                         execution.setVariable("sdncAdapterResponse", "")\r
  50                         execution.setVariable("asynchronousResponseTimeout", false)\r
  51                         execution.setVariable("continueListening", false)\r
  52                         execution.setVariable("SDNCA_SuccessIndicator", false)\r
  53 \r
  54                         // Authorization Info\r
  55                         String basicAuthValue = execution.getVariable("URN_mso_adapters_po_auth")\r
  56                         utils.log("DEBUG", "Obtained BasicAuth userid password for sdnc adapter:" + basicAuthValue, isDebugEnabled)\r
  57                         try {\r
  58                                 def encodedString = utils.getBasicAuth(basicAuthValue, execution.getVariable("URN_mso_msoKey"))\r
  59                                 execution.setVariable("BasicAuthHeaderValue",encodedString)\r
  60                         } catch (IOException ex) {\r
  61                                 utils.log("ERROR", "Unable to encode username password string")\r
  62                         }\r
  63 \r
  64                         // TODO Use variables instead of passing xml request - Huh?\r
  65 \r
  66                         // Get original RequestHeader\r
  67                         def sdncwfreq= execution.getVariable("sdncAdapterWorkflowRequest")\r
  68                         def requestHeader = utils.getNodeXml(sdncwfreq, "RequestHeader")\r
  69                         requestHeader = requestHeader.replace("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n", "")\r
  70                         utils.log("DEBUG", "RequestHeader:\n" + requestHeader, isDebugEnabled)\r
  71 \r
  72                         // Set Callback URL to use from URN Mapping or jBoss Property\r
  73                         def origCallbackUrl = utils.getNodeText(requestHeader, "CallbackUrl")\r
  74                         def callbackUrlToUse = execution.getVariable("URN_mso_workflow_sdncadapter_callback")\r
  75                         MsoUtils msoUtil = new MsoUtils()\r
  76                         def useQualifiedHostName = execution.getVariable("URN_mso_use_qualified_host")\r
  77                         if((useQualifiedHostName!=null) && (useQualifiedHostName.equals("true"))){\r
  78                                 callbackUrlToUse = msoUtil.getQualifiedHostNameForCallback(callbackUrlToUse)\r
  79                         }\r
  80                         utils.log("DEBUG", "Callback URL to use:\n" + callbackUrlToUse, isDebugEnabled)\r
  81                         requestHeader = requestHeader.replace(origCallbackUrl, callbackUrlToUse)\r
  82 \r
  83                         // Get parameters from request header\r
  84                         def sdnca_svcInstanceId = utils.getNodeText1(requestHeader, "SvcInstanceId") // optional\r
  85                         utils.log("DEBUG", "SvcInstanceId: " + sdnca_svcInstanceId, isDebugEnabled)\r
  86                         def sdnca_msoAction = utils.getNodeText1(requestHeader, "MsoAction") // optional\r
  87                         utils.log("DEBUG", "MsoAction: " + sdnca_msoAction, isDebugEnabled)\r
  88                         def sdnca_svcAction = utils.getNodeText(requestHeader, "SvcAction")\r
  89                         utils.log("DEBUG", "SvcAction: " + sdnca_svcAction, isDebugEnabled)\r
  90                         def sdnca_svcOperation = utils.getNodeText(requestHeader, "SvcOperation")\r
  91                         utils.log("DEBUG", "SvcOperation: " + sdnca_svcOperation, isDebugEnabled)\r
  92                         def sdncRequestData = utils.getChildNodes(sdncwfreq, "SDNCRequestData")\r
  93                         sdncRequestData = sdncRequestData.replace("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n", "")\r
  94                         sdncRequestData = sdncRequestData.replaceAll('tag0:', '').replaceAll(':tag0', '')\r
  95                         utils.log("DEBUG", "SDNCRequestData:\n" + sdncRequestData, isDebugEnabled)\r
  96                         def sdnca_serviceType = ""\r
  97                         if (utils.nodeExists(sdncwfreq, "service-type")) {\r
  98                                 sdnca_serviceType = utils.getNodeText(sdncwfreq, "service-type")\r
  99                         }\r
 100                         utils.log("DEBUG", "service-type: " + sdnca_serviceType, isDebugEnabled)\r
 101                         def serviceConfigActivate = false\r
 102                         def source = ''\r
 103                         if ((sdnca_svcAction == 'activate') && (sdnca_svcOperation == 'service-configuration-operation') && (sdnca_serviceType == 'uCPE-VMS')) {\r
 104                                 serviceConfigActivate = true\r
 105                                 if (utils.nodeExists(sdncwfreq, 'source')) {\r
 106                                         source = utils.getNodeText(sdncwfreq, 'source')\r
 107                                 }\r
 108                         }\r
 109                         execution.setVariable("serviceConfigActivate", serviceConfigActivate)\r
 110                         utils.log("DEBUG", "serviceConfigActivate: " + serviceConfigActivate, isDebugEnabled)\r
 111                         execution.setVariable("source", source)\r
 112                         utils.log("DEBUG", "source: " + source, isDebugEnabled)\r
 113 \r
 114                         //calling process should pass a generated uuid if sending multiple sdnc requests\r
 115                         def requestId = utils.getNodeText(requestHeader, "RequestId")\r
 116                         execution.setVariable(Prefix + "requestId", requestId)\r
 117 \r
 118                         // Prepare SDNC Request to the SDNC Adapter\r
 119                         String sdncAdapterRequest = """\r
 120                         <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">\r
 121                         <SOAP-ENV:Body>\r
 122                         <aetgt:SDNCAdapterRequest xmlns:aetgt="http://org.openecomp/workflow/sdnc/adapter/schema/v1" xmlns:sdncadaptersc="http://org.openecomp/workflow/sdnc/adapter/schema/v1">\r
 123                         <sdncadapter:RequestHeader xmlns:sdncadapter="http://org.openecomp/workflow/sdnc/adapter/schema/v1">\r
 124                         <sdncadapter:RequestId>${requestId}</sdncadapter:RequestId>"""\r
 125 \r
 126                         if (sdnca_svcInstanceId != null) {\r
 127                                 sdncAdapterRequest += """\r
 128                         <sdncadapter:SvcInstanceId>${sdnca_svcInstanceId}</sdncadapter:SvcInstanceId>"""\r
 129                         }\r
 130 \r
 131                         sdncAdapterRequest += """\r
 132                         <sdncadapter:SvcAction>${sdnca_svcAction}</sdncadapter:SvcAction>\r
 133                         <sdncadapter:SvcOperation>${sdnca_svcOperation}</sdncadapter:SvcOperation>\r
 134                         <sdncadapter:CallbackUrl>${callbackUrlToUse}</sdncadapter:CallbackUrl>"""\r
 135 \r
 136                         if (sdnca_msoAction != null) {\r
 137                                 sdncAdapterRequest += """\r
 138                         <sdncadapter:MsoAction>${sdnca_msoAction}</sdncadapter:MsoAction>"""\r
 139                         }\r
 140 \r
 141                         sdncAdapterRequest += """\r
 142                         </sdncadapter:RequestHeader>\r
 143                         <sdncadaptersc:RequestData>${sdncRequestData}</sdncadaptersc:RequestData></aetgt:SDNCAdapterRequest></SOAP-ENV:Body></SOAP-ENV:Envelope>"""\r
 144 \r
 145                         utils.logAudit("Outgoing SDNCAdapterRequest:\n" + sdncAdapterRequest)\r
 146                         execution.setVariable("sdncAdapterRequest", sdncAdapterRequest)\r
 147 \r
 148                         utils.log("DEBUG", execution.getVariable("sdncAdapterRequest"), isDebugEnabled)
 149                         utils.log("DEBUG", execution.getVariable("URN_mso_adapters_sdnc_endpoint"), isDebugEnabled)
 150                 }catch(Exception e){\r
 151                         utils.log("DEBUG", 'Internal Error occured during PreProcess Method: ' + e, isDebugEnabled)\r
 152                         exceptionUtil.buildAndThrowWorkflowException(execution, 9999, 'Internal Error occured during PreProcess Method') // TODO: what message and error code?\r
 153                 }\r
 154                 utils.log("DEBUG","=========== End pre Process SDNCRequestScript ===========", isDebugEnabled)\r
 155         }\r
 156 \r
 157         public void postProcessResponse (Execution execution) {\r
 158 \r
 159                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")\r
 160                 try{\r
 161                         utils.log("DEBUG","=========== Begin POSTProcess SDNCAdapter ===========", isDebugEnabled)\r
 162                         utils.log("DEBUG","Incoming sdncAdapterCallbackRequest:\n" + execution.getVariable("sdncAdapterCallbackRequest"), isDebugEnabled)\r
 163 \r
 164                         // Check the sdnccallback request and get the responsecode\r
 165                         def sdnccallbackreq = execution.getVariable("sdncAdapterCallbackRequest")\r
 166                         def callbackRequestData = ""\r
 167                         def callbackHeader = ""\r
 168                         utils.logAudit("SDNCAdapterCallback Request :" + sdnccallbackreq)\r
 169                         \r
 170                         if(sdnccallbackreq != null){\r
 171                                 callbackHeader = utils.getNodeXml(sdnccallbackreq, "CallbackHeader")\r
 172                                 callbackRequestData = utils.getNodeXml(sdnccallbackreq, "RequestData")\r
 173 \r
 174                                 callbackHeader = callbackHeader.replace("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n", "")\r
 175                                 utils.log("DEBUG","SDNCCallbackHeader is:\n" + callbackHeader, isDebugEnabled)\r
 176 \r
 177                                 callbackRequestData = callbackRequestData.replace("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n", "")\r
 178                                 utils.log("DEBUG","DECODED SDNCCallback RequestData is:\n" + callbackRequestData, isDebugEnabled)\r
 179 \r
 180                                 String sdncAdapterWorkflowResponse ="""\r
 181                                                 <sdncadapterworkflow:SDNCAdapterWorkflowResponse xmlns:sdncadapterworkflow="http://org.openecomp/mso/workflow/schema/v1">
 182                                                 <sdncadapterworkflow:response-data>\r
 183                                                 ${callbackHeader}\r
 184                                                 ${callbackRequestData}\r
 185                                                 </sdncadapterworkflow:response-data>\r
 186                                                 </sdncadapterworkflow:SDNCAdapterWorkflowResponse>"""\r
 187 \r
 188 \r
 189                                 utils.log("DEBUG","Outgoing sdncAdapterWorkflowResponse:\n" + sdncAdapterWorkflowResponse, isDebugEnabled)\r
 190                                 sdncAdapterWorkflowResponse = utils.formatXml(sdncAdapterWorkflowResponse)\r
 191                                 utils.logAudit("sdncAdapterWorkflowResponse :" + sdncAdapterWorkflowResponse)\r
 192                                 execution.setVariable("sdncAdapterResponse", sdncAdapterWorkflowResponse)\r
 193                                 // TODO: Should deprecate use of processKey+Response variable for the response. Will use "WorkflowResponse" instead\r
 194                                 execution.setVariable("WorkflowResponse", sdncAdapterWorkflowResponse)\r
 195 \r
 196                                 // Check final indicator to determine if we are to continue listening or not\r
 197                                 def String enhancedCallbackRequestData = callbackRequestData.replaceAll("&amp;", "&")\r
 198                                 enhancedCallbackRequestData = enhancedCallbackRequestData.replaceAll("&lt;", "<")\r
 199                                 enhancedCallbackRequestData = enhancedCallbackRequestData.replaceAll("&gt;", ">")\r
 200                                 // replace the data with '&' (ex: subscriber-name= 'FOUR SEASONS HEATING & COOLING'\r
 201                                 enhancedCallbackRequestData = enhancedCallbackRequestData.replace("&", "&amp;")\r
 202                                 utils.log("DEBUG","EnhancedCallbackRequestData:\n" + enhancedCallbackRequestData, isDebugEnabled)\r
 203                                 execution.setVariable("enhancedCallbackRequestData", enhancedCallbackRequestData)\r
 204                                 def continueListening = false\r
 205                                 if (utils.nodeExists(enhancedCallbackRequestData, "ack-final-indicator")) {\r
 206                                         if (utils.getNodeText(enhancedCallbackRequestData, "ack-final-indicator") == 'N') {\r
 207                                                 continueListening = true\r
 208                                         }\r
 209                                 }\r
 210                                 execution.setVariable("continueListening", continueListening)\r
 211                                 utils.log("DEBUG", "Continue Listening: " + continueListening, isDebugEnabled)\r
 212                                 execution.setVariable("asynchronousResponseTimeout", false)\r
 213                         }else{\r
 214                                 // Timed out waiting for asynchronous message, build error response\r
 215                                 exceptionUtil.buildWorkflowException(execution, 500, "SDNC Callback Timeout Error")\r
 216                                 execution.setVariable("asynchronousResponseTimeout", true)\r
 217                                 utils.log("DEBUG", "Timed out waiting for asynchronous message", isDebugEnabled)\r
 218                         }\r
 219                 }catch(Exception e){\r
 220                         utils.log("DEBUG", 'Internal Error occured during PostProcess Method: ' + e, isDebugEnabled)\r
 221                         exceptionUtil.buildAndThrowWorkflowException(execution, 9999, 'Internal Error occured during PostProcess Method') // TODO: what message and error code?\r
 222                 }\r
 223                 utils.log("DEBUG","=========== End POSTProcess SDNCAdapter ===========", isDebugEnabled)\r
 224         }\r
 225 \r
 226         public void callbackResponsecheck(Execution execution){\r
 227 \r
 228                 def sdnccallbackreq=execution.getVariable("sdncAdapterCallbackRequest")\r
 229                 utils.logAudit("sdncAdapterCallbackRequest :" + sdnccallbackreq)\r
 230                 if (sdnccallbackreq==null){\r
 231                         execution.setVariable("callbackResponseReceived",false);\r
 232                 }else{\r
 233                         execution.setVariable("callbackResponseReceived",true);\r
 234                 }\r
 235         }\r
 236 \r
 237         public void resetCallbackRequest(Execution execution) {\r
 238 \r
 239                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")\r
 240 \r
 241                 utils.log("DEBUG","=========== Begin Reset Callback Info SDNCAdapter ===========", isDebugEnabled)\r
 242 \r
 243                 // Clear sdncAdapterCallbackRequest variable\r
 244                 execution.removeVariable("sdncAdapterCallbackRequest")\r
 245 \r
 246                 // Determine and set SDNC Timeout Value\r
 247                 def enhancedCallbackRequestData = execution.getVariable("enhancedCallbackRequestData")\r
 248                 utils.logAudit("sdncAdapter - enhancedCallbackRequestData :" + enhancedCallbackRequestData)\r
 249                 def interim = false\r
 250                 if (enhancedCallbackRequestData != null) {\r
 251                         if (utils.nodeExists(enhancedCallbackRequestData, "ack-final-indicator")) {\r
 252                                 if (utils.getNodeText(enhancedCallbackRequestData, "ack-final-indicator") == 'N') {\r
 253                                         interim = true\r
 254                                 }\r
 255                         }\r
 256                 }\r
 257                 def timeoutValue = execution.getVariable("URN_mso_sdnc_timeout")\r
 258                 def sdncAdapterWorkflowRequest = execution.getVariable("sdncAdapterWorkflowRequest")\r
 259                 if (interim && utils.nodeExists(sdncAdapterWorkflowRequest, "InterimSDNCTimeOutValueInHours")) {\r
 260                         timeoutValue = "PT" + utils.getNodeText(sdncAdapterWorkflowRequest, "InterimSDNCTimeOutValueInHours") + "H"\r
 261                 } else if (utils.nodeExists(sdncAdapterWorkflowRequest, "SDNCTimeOutValueInMinutes")) {\r
 262                         timeoutValue = "PT" + utils.getNodeText(sdncAdapterWorkflowRequest, "SDNCTimeOutValueInMinutes") + "M"\r
 263                 }\r
 264                 execution.setVariable("sdncTimeoutValue", timeoutValue)\r
 265                 utils.log("DEBUG", "Setting SDNC Timeout Value to " + timeoutValue, isDebugEnabled)\r
 266 \r
 267                 utils.log("DEBUG","=========== End Reset Callback Info SDNCAdapter ===========", isDebugEnabled)\r
 268         }\r
 269 \r
 270 \r
 271         public void prepareDBMessage(Execution execution) {\r
 272 \r
 273                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")\r
 274 \r
 275                 utils.log("DEBUG","=========== Begin Prepare DB Message SDNCAdapter ===========", isDebugEnabled)\r
 276 \r
 277                 // Create DB Message\r
 278                 def dbRequestId = execution.getVariable("mso-request-id")\r
 279                 String dbUpdateInterimStageCompletion = """\r
 280                         <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">\r
 281                                 <SOAP-ENV:Body>\r
 282                                         <DBAdapter:updateInterimStageCompletion xmlns:DBAdapter="http://org.openecomp.mso/requestsdb">\r
 283                                                 <requestId>${dbRequestId}</requestId>\r
 284                                                 <interimStageCompletion>1</interimStageCompletion>\r
 285                                                 <lastModifiedBy>BPEL</lastModifiedBy>\r
 286                                 </DBAdapter:updateInterimStageCompletion>\r
 287                                 </SOAP-ENV:Body>\r
 288                         </SOAP-ENV:Envelope>\r
 289                         """\r
 290 \r
 291                 execution.setVariable("dbUpdateInterimStageCompletion", dbUpdateInterimStageCompletion)\r
 292                 utils.logAudit("sdncAdapter - dbUpdateInterimStageCompletion :" + dbUpdateInterimStageCompletion)\r
 293                 utils.log("DEBUG","DB UpdateInterimStageCompletion:\n" + dbUpdateInterimStageCompletion, isDebugEnabled)\r
 294                 utils.log("DEBUG","=========== End Prepare DB Message SDNCAdapter ===========", isDebugEnabled)\r
 295         }\r
 296 \r
 297         public String generateCurrentTimeInUtc(){\r
 298                 final  SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");\r
 299                 sdf.setTimeZone(TimeZone.getTimeZone("UTC"));\r
 300                 final String utcTime = sdf.format(new Date());\r
 301                 return utcTime;\r
 302         }\r
 303 \r
 304         public void toggleSuccessIndicator(Execution execution){\r
 305                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")\r
 306                 execution.setVariable("SDNCA_SuccessIndicator", true)\r
 307                 utils.log("DEBUG","Setting SDNCA Success Indicator to True", isDebugEnabled)\r
 308         }\r
 309 \r
 310         public void assignError(Execution execution){\r
 311                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")\r
 312                 utils.log("DEBUG","=========== Started Assign Error ===========", isDebugEnabled)\r
 313                 WorkflowException wf = execution.getVariable("WorkflowException")\r
 314                 if(wf == null){\r
 315                         exceptionUtil.buildWorkflowException(execution, 5000, "SDNCAdapter Encountered an Internal Error") // TODO: Not sure what message and error code we want here.....\r
 316                 }else{\r
 317                         execution.setVariable("WorkflowException", wf)\r
 318                 }\r
 319 \r
 320                 utils.log("DEBUG","Outgoing WorkflowException is: " + execution.getVariable("WorkflowException"), isDebugEnabled)\r
 321                 utils.log("DEBUG","=========== End Assign Error ===========", isDebugEnabled)\r
 322         }\r
 323         \r
 324         public void setTimeout(Execution execution){\r
 325                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")\r
 326                 utils.log("DEBUG","=========== Started SetTimeout ===========", isDebugEnabled)\r
 327                 utils.log("DEBUG", "Timer expired, telling correlation service to stop listening", isDebugEnabled)\r
 328                 execution.setVariable("asynchronousResponseTimeout", true)\r
 329                 \r
 330                 utils.log("DEBUG", "Timed out branch sleeping for one second to give success branch a chance to complete if running", isDebugEnabled)\r
 331                 Thread.sleep(1000)\r
 332                 utils.log("DEBUG","=========== End SetTimeout ===========", isDebugEnabled)\r
 333         }\r
 334 }\r