2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Modifications Copyright (c) 2019 Samsung
8 * ================================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 * ============LICENSE_END=========================================================
23 package org.onap.so.bpmn.common.scripts;
24 import org.onap.so.bpmn.core.UrnPropertiesReader
25 import org.onap.so.logger.ErrorCode;
27 import java.text.SimpleDateFormat
29 import org.camunda.bpm.engine.delegate.DelegateExecution
30 import org.onap.so.bpmn.core.WorkflowException
31 import org.onap.so.logger.MessageEnum
32 import org.slf4j.Logger
33 import org.slf4j.LoggerFactory
35 import static org.apache.commons.lang3.StringUtils.*
38 // SDNC Adapter Request/Response processing
39 public class SDNCAdapter extends AbstractServiceTaskProcessor {
40 private static final Logger logger = LoggerFactory.getLogger( SDNCAdapter.class);
44 ExceptionUtil exceptionUtil = new ExceptionUtil()
46 // Script Task: Process SDNC Workflow Request
47 // Params: Workflow DelegateExecution
48 // Assume: Received SDNCAdapterWorkflowRequest is in variable 'sdncAdapterWorkflowRequest'
49 // Put created SDNCAdapterRequest in variable 'sdncAdapterRequest'
50 public void preProcessRequest (DelegateExecution execution) {
53 logger.trace("Begin PreProcess SDNCAdapterRequestScript ")
54 logger.debug("Incoming sdncAdapterWorkflowRequest:\n" + execution.getVariable("sdncAdapterWorkflowRequest"))
56 // Initialize some variables used throughout the flow
57 execution.setVariable("prefix", Prefix)
58 execution.setVariable("sdncAdapterResponse", "")
59 execution.setVariable("asynchronousResponseTimeout", false)
60 execution.setVariable("continueListening", false)
61 execution.setVariable("SDNCA_SuccessIndicator", false)
62 execution.setVariable("SDNCA_InterimNotify", false)
64 String requestId = execution.getVariable("mso-request-id")
65 if(isBlank(requestId)){
66 exceptionUtil.buildAndThrowWorkflowException(execution, 400, 'mso-request-id not provided by calling flow')
70 String basicAuthValue = UrnPropertiesReader.getVariable("mso.adapters.po.auth", execution)
73 def encodedString = utils.getBasicAuth(basicAuthValue, UrnPropertiesReader.getVariable("mso.msoKey", execution))
74 execution.setVariable("BasicAuthHeaderValue",encodedString)
75 } catch (IOException ex) {
76 logger.error("{} {} {} {}", MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
77 "Unable to encode username password string", "BPMN",
78 ErrorCode.UnknownError.getValue());
81 // TODO Use variables instead of passing xml request - Huh?
83 // Get original RequestHeader
84 def sdncwfreq= execution.getVariable("sdncAdapterWorkflowRequest")
85 def requestHeader = utils.getNodeXml(sdncwfreq, "RequestHeader")
86 requestHeader = requestHeader.replace("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n", "")
88 // Set Callback URL to use from URN Mapping or jBoss Property
89 def origCallbackUrl = utils.getNodeText(requestHeader, "CallbackUrl")
90 def callbackUrlToUse = UrnPropertiesReader.getVariable("mso.workflow.sdncadapter.callback", execution)
91 MsoUtils msoUtil = new MsoUtils()
92 def useQualifiedHostName = UrnPropertiesReader.getVariable("mso.use.qualified.host", execution)
93 if((useQualifiedHostName!=null) && (useQualifiedHostName.equals("true"))){
94 callbackUrlToUse = msoUtil.getQualifiedHostNameForCallback(callbackUrlToUse)
96 logger.debug("Callback URL to use:\n" + callbackUrlToUse)
97 requestHeader = requestHeader.replace(origCallbackUrl, callbackUrlToUse)
99 // Get parameters from request header
100 def sdnca_svcInstanceId = utils.getNodeText(requestHeader, "SvcInstanceId") // optional
101 logger.debug("SvcInstanceId: " + sdnca_svcInstanceId)
102 def sdnca_msoAction = utils.getNodeText(requestHeader, "MsoAction") // optional
103 logger.debug("MsoAction: " + sdnca_msoAction)
104 def sdnca_svcAction = utils.getNodeText(requestHeader, "SvcAction")
105 logger.debug("SvcAction: " + sdnca_svcAction)
106 def sdnca_svcOperation = utils.getNodeText(requestHeader, "SvcOperation")
107 logger.debug("SvcOperation: " + sdnca_svcOperation)
108 def sdncRequestData = utils.getChildNodes(sdncwfreq, "SDNCRequestData")
109 sdncRequestData = sdncRequestData.replace("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n", "")
110 sdncRequestData = sdncRequestData.replaceAll('tag0:', '').replaceAll(':tag0', '')
111 logger.debug("SDNCRequestData:\n" + sdncRequestData)
112 def sdnca_serviceType = ""
113 if (utils.nodeExists(sdncwfreq, "service-type")) {
114 sdnca_serviceType = utils.getNodeText(sdncwfreq, "service-type")
116 logger.debug("service-type: " + sdnca_serviceType)
117 def serviceConfigActivate = false
119 if ((sdnca_svcAction == 'activate') && (sdnca_svcOperation == 'service-configuration-operation') && (sdnca_serviceType == 'uCPE-VMS')) {
120 serviceConfigActivate = true
121 if (utils.nodeExists(sdncwfreq, 'source')) {
122 source = utils.getNodeText(sdncwfreq, 'source')
125 execution.setVariable("serviceConfigActivate", serviceConfigActivate)
126 logger.debug("serviceConfigActivate: " + serviceConfigActivate)
127 execution.setVariable("source", source)
128 logger.debug("source: " + source)
130 //calling process should pass a generated uuid if sending multiple sdnc requests
131 def sdncRequestId = utils.getNodeText(requestHeader, "RequestId")
132 execution.setVariable(Prefix + "requestId", sdncRequestId)
134 // Prepare SDNC Request to the SDNC Adapter
135 String sdncAdapterRequest = """
136 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
138 <aetgt:SDNCAdapterRequest xmlns:aetgt="http://org.onap/workflow/sdnc/adapter/schema/v1" xmlns:sdncadaptersc="http://org.onap/workflow/sdnc/adapter/schema/v1">
139 <sdncadapter:RequestHeader xmlns:sdncadapter="http://org.onap/workflow/sdnc/adapter/schema/v1">
140 <sdncadapter:RequestId>${MsoUtils.xmlEscape(sdncRequestId)}</sdncadapter:RequestId>"""
142 if (sdnca_svcInstanceId != null) {
143 sdncAdapterRequest += """
144 <sdncadapter:SvcInstanceId>${MsoUtils.xmlEscape(sdnca_svcInstanceId)}</sdncadapter:SvcInstanceId>"""
145 execution.setVariable("serviceInstanceId", sdnca_svcInstanceId)
148 sdncAdapterRequest += """
149 <sdncadapter:SvcAction>${MsoUtils.xmlEscape(sdnca_svcAction)}</sdncadapter:SvcAction>
150 <sdncadapter:SvcOperation>${MsoUtils.xmlEscape(sdnca_svcOperation)}</sdncadapter:SvcOperation>
151 <sdncadapter:CallbackUrl>${MsoUtils.xmlEscape(callbackUrlToUse)}</sdncadapter:CallbackUrl>"""
153 if (sdnca_msoAction != null) {
154 sdncAdapterRequest += """
155 <sdncadapter:MsoAction>${MsoUtils.xmlEscape(sdnca_msoAction)}</sdncadapter:MsoAction>"""
158 sdncAdapterRequest += """
159 </sdncadapter:RequestHeader>
160 <sdncadaptersc:RequestData>
162 </sdncadaptersc:RequestData></aetgt:SDNCAdapterRequest></SOAP-ENV:Body></SOAP-ENV:Envelope>"""
164 logger.debug("Outgoing SDNCAdapterRequest:\n" + sdncAdapterRequest)
165 execution.setVariable("sdncAdapterRequest", sdncAdapterRequest)
167 logger.debug(UrnPropertiesReader.getVariable("mso.adapters.sdnc.endpoint", execution))
169 logger.debug('Internal Error occured during PreProcess Method: ', e)
170 exceptionUtil.buildAndThrowWorkflowException(execution, 9999, 'Internal Error occured during PreProcess Method') // TODO: what message and error code?
172 logger.trace("End pre Process SDNCRequestScript ")
175 public void postProcessResponse (DelegateExecution execution) {
178 logger.trace("Begin POSTProcess SDNCAdapter ")
179 logger.trace("Incoming sdncAdapterCallbackRequest:\n" + execution.getVariable("sdncAdapterCallbackRequest"))
181 // Check the sdnccallback request and get the responsecode
182 def sdnccallbackreq = execution.getVariable("sdncAdapterCallbackRequest")
183 def callbackRequestData = ""
184 def callbackHeader = ""
186 if(sdnccallbackreq != null){
187 callbackHeader = utils.getNodeXml(sdnccallbackreq, "CallbackHeader")
188 callbackRequestData = utils.getNodeXml(sdnccallbackreq, "RequestData")
190 callbackHeader = callbackHeader.replace("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n", "")
192 callbackRequestData = callbackRequestData.replace("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n", "")
194 logger.trace("EnhancedCallbackRequestData:\n" + callbackRequestData)
195 execution.setVariable("enhancedCallbackRequestData", callbackRequestData)
197 String sdncAdapterWorkflowResponse ="""
198 <sdncadapterworkflow:SDNCAdapterWorkflowResponse xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
199 <sdncadapterworkflow:response-data>
201 ${callbackRequestData}
202 </sdncadapterworkflow:response-data>
203 </sdncadapterworkflow:SDNCAdapterWorkflowResponse>"""
206 sdncAdapterWorkflowResponse = utils.formatXml(sdncAdapterWorkflowResponse)
207 execution.setVariable("sdncAdapterResponse", sdncAdapterWorkflowResponse)
208 // TODO: Should deprecate use of processKey+Response variable for the response. Will use "WorkflowResponse" instead
209 execution.setVariable("WorkflowResponse", sdncAdapterWorkflowResponse)
211 // Check final indicator to determine if we are to continue listening or not
212 def continueListening = false
213 if (utils.nodeExists(callbackRequestData, "ack-final-indicator")) {
214 if (utils.getNodeText(callbackRequestData, "ack-final-indicator") == 'N') {
215 continueListening = true
218 execution.setVariable("continueListening", continueListening)
219 logger.debug("Continue Listening: " + continueListening)
220 execution.setVariable("asynchronousResponseTimeout", false)
222 // Timed out waiting for asynchronous message, build error response
223 exceptionUtil.buildWorkflowException(execution, 500, "SDNC Callback Timeout Error")
224 execution.setVariable("asynchronousResponseTimeout", true)
225 logger.debug("Timed out waiting for asynchronous message")
228 logger.debug('Internal Error occured during PostProcess Method: ' + e)
229 exceptionUtil.buildAndThrowWorkflowException(execution, 9999, 'Internal Error occured during PostProcess Method') // TODO: what message and error code?
231 logger.trace("End POSTProcess SDNCAdapter ")
234 public void callbackResponsecheck(DelegateExecution execution){
236 def sdnccallbackreq=execution.getVariable("sdncAdapterCallbackRequest")
237 logger.debug("sdncAdapterCallbackRequest :" + sdnccallbackreq)
238 if (sdnccallbackreq==null){
239 execution.setVariable("callbackResponseReceived",false);
241 execution.setVariable("callbackResponseReceived",true);
245 public void resetCallbackRequest(DelegateExecution execution) {
247 logger.trace("Begin Reset Callback Info SDNCAdapter ")
249 // Clear sdncAdapterCallbackRequest variable
250 execution.removeVariable("sdncAdapterCallbackRequest")
252 // Determine and set SDNC Timeout Value
253 def enhancedCallbackRequestData = execution.getVariable("enhancedCallbackRequestData")
254 logger.debug("sdncAdapter - enhancedCallbackRequestData :" + enhancedCallbackRequestData)
256 if (enhancedCallbackRequestData != null) {
257 if (utils.nodeExists(enhancedCallbackRequestData, "ack-final-indicator")) {
258 if (utils.getNodeText(enhancedCallbackRequestData, "ack-final-indicator") == 'N') {
263 def timeoutValue = UrnPropertiesReader.getVariable("mso.adapters.sdnc.timeout", execution)
264 if(timeoutValue==null)
266 def sdncAdapterWorkflowRequest = execution.getVariable("sdncAdapterWorkflowRequest")
267 if (interim && utils.nodeExists(sdncAdapterWorkflowRequest, "InterimSDNCTimeOutValueInHours")) {
268 timeoutValue = "PT" + utils.getNodeText(sdncAdapterWorkflowRequest, "InterimSDNCTimeOutValueInHours") + "H"
269 } else if (utils.nodeExists(sdncAdapterWorkflowRequest, "SDNCTimeOutValueInMinutes")) {
270 timeoutValue = "PT" + utils.getNodeText(sdncAdapterWorkflowRequest, "SDNCTimeOutValueInMinutes") + "M"
272 execution.setVariable("sdncTimeoutValue", timeoutValue)
273 logger.debug("Setting SDNC Timeout Value to " + timeoutValue)
275 logger.trace("End Reset Callback Info SDNCAdapter ")
279 public void prepareDBMessage(DelegateExecution execution) {
281 logger.trace("Begin Prepare DB Message SDNCAdapter ")
284 def dbRequestId = execution.getVariable("mso-request-id")
285 String dbUpdateInterimStageCompletion = """
286 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
288 <DBAdapter:updateInterimStageCompletion xmlns:DBAdapter="http://org.onap.so/requestsdb">
289 <requestId>${MsoUtils.xmlEscape(dbRequestId)}</requestId>
290 <interimStageCompletion>1</interimStageCompletion>
291 <lastModifiedBy>BPEL</lastModifiedBy>
292 </DBAdapter:updateInterimStageCompletion>
297 execution.setVariable("dbUpdateInterimStageCompletion", dbUpdateInterimStageCompletion)
298 logger.debug("sdncAdapter - dbUpdateInterimStageCompletion :" + dbUpdateInterimStageCompletion)
299 logger.debug("DB UpdateInterimStageCompletion:\n" + dbUpdateInterimStageCompletion)
300 logger.trace("End Prepare DB Message SDNCAdapter ")
303 public String generateCurrentTimeInUtc(){
304 final SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
305 sdf.setTimeZone(TimeZone.getTimeZone("UTC"));
306 final String utcTime = sdf.format(new Date());
310 public void toggleSuccessIndicator(DelegateExecution execution){
311 execution.setVariable("SDNCA_SuccessIndicator", true)
312 logger.debug("Setting SDNCA Success Indicator to True")
315 public void assignError(DelegateExecution execution){
316 logger.trace("Started Assign Error ")
317 WorkflowException wf = execution.getVariable("WorkflowException")
319 exceptionUtil.buildWorkflowException(execution, 5000, "SDNCAdapter Encountered an Internal Error") // TODO: Not sure what message and error code we want here.....
321 execution.setVariable("WorkflowException", wf)
324 logger.debug("Outgoing WorkflowException is: " + execution.getVariable("WorkflowException"))
325 logger.trace("End Assign Error ")
328 public void setTimeout(DelegateExecution execution){
329 logger.trace("Started SetTimeout ")
330 logger.debug("Timer expired, telling correlation service to stop listening")
331 execution.setVariable("asynchronousResponseTimeout", true)
333 logger.debug("Timed out branch sleeping for one second to give success branch a chance to complete if running")
335 logger.trace("End SetTimeout ")