1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
|
package org.openecomp.mso.bpmn.common.scripts
import java.text.SimpleDateFormat
import java.net.URLEncoder
import org.apache.commons.codec.binary.Base64
import org.apache.commons.lang3.*
import org.camunda.bpm.engine.delegate.BpmnError
import org.camunda.bpm.engine.runtime.Execution
import groovy.json.*
import org.json.JSONObject
import org.openecomp.mso.bpmn.core.WorkflowException
import org.openecomp.mso.bpmn.core.json.JsonUtils
import org.openecomp.mso.rest.APIResponse
import org.openecomp.mso.rest.RESTClient
import org.openecomp.mso.rest.RESTConfig
class SDNCAdapterRestV1 extends AbstractServiceTaskProcessor {
ExceptionUtil exceptionUtil = new ExceptionUtil()
JsonUtils jsonUtil = new JsonUtils()
/**
* Processes the incoming request.
*/
public void preProcessRequest (Execution execution) {
def method = getClass().getSimpleName() + '.preProcessRequest(' +
'execution=' + execution.getId() +
')'
def isDebugLogEnabled = execution.getVariable('isDebugLogEnabled')
logDebug('Entered ' + method, isDebugLogEnabled)
def prefix="SDNCREST_"
execution.setVariable("prefix", prefix)
setSuccessIndicator(execution, false)
try {
// Determine the request type and log the request
String request = validateRequest(execution, "mso-request-id")
String requestType = jsonUtil.getJsonRootProperty(request)
execution.setVariable(prefix + 'requestType', requestType)
logDebug(getProcessKey(execution) + ': ' + prefix + 'requestType = ' + requestType, isDebugLogEnabled)
utils.logAudit('SDNCAdapterRestV1, request: ' + request)
// Determine the SDNCAdapter endpoint
String sdncAdapterEndpoint = execution.getVariable("URN_mso_adapters_sdnc_rest_endpoint")
if (sdncAdapterEndpoint == null || sdncAdapterEndpoint.isEmpty()) {
String msg = getProcessKey(execution) + ': mso:adapters:sdnc:rest:endpoint URN mapping is not defined'
logDebug(msg, isDebugLogEnabled)
logError(msg)
exceptionUtil.buildAndThrowWorkflowException(execution, 2000, msg)
}
while (sdncAdapterEndpoint.endsWith('/')) {
sdncAdapterEndpoint = sdncAdapterEndpoint.substring(0, sdncAdapterEndpoint.length()-1)
}
String sdncAdapterMethod = null
String sdncAdapterUrl = null
String sdncAdapterRequest = request
if ('SDNCServiceRequest'.equals(requestType)) {
// Get the sdncRequestId from the request
String sdncRequestId = jsonUtil.getJsonValue(request, requestType + ".sdncRequestId")
if (sdncRequestId == null || sdncRequestId.isEmpty()) {
String msg = getProcessKey(execution) + ': no sdncRequestId in ' + requestType
logDebug(msg, isDebugLogEnabled)
logError(msg)
exceptionUtil.buildAndThrowWorkflowException(execution, 2000, msg)
}
execution.setVariable('SDNCAResponse_CORRELATOR', sdncRequestId)
logDebug(getProcessKey(execution) + ': SDNCAResponse_CORRELATOR = ' + sdncRequestId, isDebugLogEnabled)
// Get the bpNotificationUrl from the request (just to make sure it's there)
String bpNotificationUrl = jsonUtil.getJsonValue(request, requestType + ".bpNotificationUrl")
if (bpNotificationUrl == null || bpNotificationUrl.isEmpty()) {
String msg = getProcessKey(execution) + ': no bpNotificationUrl in ' + requestType
logDebug(msg, isDebugLogEnabled)
logError(msg)
exceptionUtil.buildAndThrowWorkflowException(execution, 2000, msg)
}
sdncAdapterMethod = 'POST'
sdncAdapterUrl = sdncAdapterEndpoint + '/services'
} else {
String msg = getProcessKey(execution) + ': Unsupported request type: ' + requestType
logDebug(msg, isDebugLogEnabled)
logError(msg)
exceptionUtil.buildAndThrowWorkflowException(execution, 2000, msg)
}
execution.setVariable(prefix + 'sdncAdapterMethod', sdncAdapterMethod)
logDebug(getProcessKey(execution) + ': ' + prefix + 'sdncAdapterMethod = ' + sdncAdapterMethod, isDebugLogEnabled)
execution.setVariable(prefix + 'sdncAdapterUrl', sdncAdapterUrl)
logDebug(getProcessKey(execution) + ': ' + prefix + 'sdncAdapterUrl = ' + sdncAdapterUrl, isDebugLogEnabled)
execution.setVariable(prefix + 'sdncAdapterRequest', sdncAdapterRequest)
logDebug(getProcessKey(execution) + ': ' + prefix + 'sdncAdapterRequest = \n' + sdncAdapterRequest, isDebugLogEnabled)
// Get the Basic Auth credentials for the SDNCAdapter (yes... we ARE using the PO adapters credentials)
String basicAuthValue = execution.getVariable("URN_mso_adapters_po_auth")
if (basicAuthValue == null || basicAuthValue.isEmpty()) {
logDebug(getProcessKey(execution) + ": mso:adapters:po:auth URN mapping is not defined", isDebugLogEnabled)
logError(getProcessKey(execution) + ": mso:adapters:po:auth URN mapping is not defined")
} else {
logDebug(getProcessKey(execution) + ": Obtained BasicAuth credentials for SDNCAdapter:" +
basicAuthValue, isDebugLogEnabled)
try {
def encodedString = utils.getBasicAuth(basicAuthValue, execution.getVariable("URN_mso_msoKey"))
execution.setVariable(prefix + 'basicAuthHeaderValue', encodedString)
} catch (IOException ex) {
logDebug(getProcessKey(execution) + ": Unable to encode BasicAuth credentials for SDNCAdapter", isDebugLogEnabled)
logError(getProcessKey(execution) + ": Unable to encode BasicAuth credentials for SDNCAdapter")
}
}
// Set the timeout value, e.g. PT5M. It may be specified in the request as the
// bpTimeout value. If it's not in the request, use the URN mapping value.
String timeout = jsonUtil.getJsonValue(request, requestType + ".bpTimeout")
if (timeout == null || timeout.isEmpty()) {
timeout = execution.getVariable("URN_mso_sdnc_timeout")
}
execution.setVariable(prefix + 'timeout', timeout)
logDebug(getProcessKey(execution) + ': ' + prefix + 'timeout = ' + timeout, isDebugLogEnabled)
} catch (BpmnError e) {
throw e
} catch (Exception e) {
String msg = 'Caught exception in ' + method + ": " + e
logDebug(msg, isDebugLogEnabled)
logError(msg)
exceptionUtil.buildAndThrowWorkflowException(execution, 2000, msg)
}
}
/**
* Sends the request to the SDNC adapter.
*/
public void sendRequestToSDNCAdapter(Execution execution) {
def method = getClass().getSimpleName() + '.sendRequestToSDNCAdapter(' +
'execution=' + execution.getId() +
')'
def isDebugLogEnabled = execution.getVariable('isDebugLogEnabled')
logDebug('Entered ' + method, isDebugLogEnabled)
String prefix = execution.getVariable('prefix')
try {
String sdncAdapterMethod = execution.getVariable(prefix + 'sdncAdapterMethod')
String sdncAdapterUrl = execution.getVariable(prefix + 'sdncAdapterUrl')
String sdncAdapterRequest = execution.getVariable(prefix + 'sdncAdapterRequest')
utils.logAudit("Outgoing SDNC Rest Request is: " + sdncAdapterRequest)
RESTConfig config = new RESTConfig(sdncAdapterUrl)
RESTClient client = new RESTClient(config).
addHeader("Content-Type", "application/json").
addAuthorizationHeader(execution.getVariable(prefix + "basicAuthHeaderValue"))
APIResponse response
if ("GET".equals(sdncAdapterMethod)) {
response = client.httpGet()
} else if ("PUT".equals(sdncAdapterMethod)) {
response = client.httpPut(sdncAdapterRequest)
} else if ("POST".equals(sdncAdapterMethod)) {
response = client.httpPost(sdncAdapterRequest)
} else if ("DELETE".equals(sdncAdapterMethod)) {
response = client.httpDelete(sdncAdapterRequest)
} else {
String msg = 'Unsupported HTTP method "' + sdncAdapterMethod + '" in ' + method + ": " + e
logDebug(msg, isDebugLogEnabled)
logError(msg)
exceptionUtil.buildAndThrowWorkflowException(execution, 2000, msg)
}
execution.setVariable(prefix + "sdncAdapterStatusCode", response.getStatusCode())
execution.setVariable(prefix + "sdncAdapterResponse", response.getResponseBodyAsString())
} catch (BpmnError e) {
throw e
} catch (Exception e) {
String msg = 'Caught exception in ' + method + ": " + e
logDebug(msg, isDebugLogEnabled)
logError(msg)
exceptionUtil.buildAndThrowWorkflowException(execution, 2000, msg)
}
}
/**
* Processes a callback.
*/
public void processCallback(Execution execution){
def method = getClass().getSimpleName() + '.processCallback(' +
'execution=' + execution.getId() +
')'
def isDebugLogEnabled = execution.getVariable('isDebugLogEnabled')
logDebug('Entered ' + method, isDebugLogEnabled)
String prefix = execution.getVariable('prefix')
String callback = execution.getVariable('SDNCAResponse_MESSAGE')
utils.logAudit("Incoming SDNC Rest Callback is: " + callback)
try {
logDebug(getProcessKey(execution) + ": received callback:\n" + callback, isDebugLogEnabled)
int callbackNumber = 1
while (execution.getVariable(prefix + 'callback' + callbackNumber) != null) {
++callbackNumber
}
execution.setVariable(prefix + 'callback' + callbackNumber, callback)
execution.removeVariable('SDNCAResponse_MESSAGE')
String responseType = jsonUtil.getJsonRootProperty(callback)
// Get the ackFinalIndicator and make sure it's either Y or N. Default to Y.
String ackFinalIndicator = jsonUtil.getJsonValue(callback, responseType + ".ackFinalIndicator")
if (!'N'.equals(ackFinalIndicator)) {
ackFinalIndicator = 'Y'
}
execution.setVariable(prefix + "ackFinalIndicator", ackFinalIndicator)
if (responseType.endsWith('Error')) {
sdncAdapterBuildWorkflowException(execution, callback)
}
} catch (Exception e) {
callback = callback == null || String.valueOf(callback).isEmpty() ? "NONE" : callback
String msg = "Received error from SDNCAdapter: " + callback
logDebug(getProcessKey(execution) + ': ' + msg, isDebugLogEnabled)
exceptionUtil.buildWorkflowException(execution, 5300, msg)
}
}
/**
* Tries to parse the response as XML to extract the information to create
* a WorkflowException. If the response cannot be parsed, a more generic
* WorkflowException is created.
*/
public void sdncAdapterBuildWorkflowException(Execution execution, String response) {
try {
String responseType = jsonUtil.getJsonRootProperty(response)
String responseCode = jsonUtil.getJsonValue(response, responseType + ".responseCode")
String responseMessage = jsonUtil.getJsonValue(response, responseType + ".responseMessage")
String info = ""
if (responseCode != null && !responseCode.isEmpty()) {
info += " responseCode='" + responseCode + "'"
}
if (responseMessage != null && !responseMessage.isEmpty()) {
info += " responseMessage='" + responseMessage + "'"
}
// Note: the mapping function handles a null or empty responseCode
int mappedResponseCode = Integer.parseInt(exceptionUtil.MapSDNCResponseCodeToErrorCode(responseCode));
exceptionUtil.buildWorkflowException(execution, mappedResponseCode, "Received " + responseType +
" from SDNCAdapter:" + info)
} catch (Exception e) {
response = response == null || String.valueOf(response).isEmpty() ? "NONE" : response
exceptionUtil.buildWorkflowException(execution, 5300, "Received error from SDNCAdapter: " + response)
}
}
/**
* Gets the last callback request from the execution, or null if there was no callback.
*/
public String getLastCallback(Execution execution) {
def method = getClass().getSimpleName() + '.getLastCallback(' +
'execution=' + execution.getId() +
')'
def isDebugLogEnabled = execution.getVariable('isDebugLogEnabled')
logDebug('Entered ' + method, isDebugLogEnabled)
String prefix = execution.getVariable('prefix')
try {
int callbackNumber = 1
String callback = null
while (true) {
String thisCallback = (String) execution.getVariable(prefix + 'callback' + callbackNumber)
if (thisCallback == null) {
break
}
callback = thisCallback
++callbackNumber
}
return callback
} catch (Exception e) {
String msg = 'Caught exception in ' + method + ": " + e
logDebug(msg, isDebugLogEnabled)
logError(msg)
exceptionUtil.buildAndThrowWorkflowException(execution, 2000, msg)
}
}
/**
* Sets the timeout value to wait for the next notification.
*/
public void setTimeoutValue(Execution execution) {
def method = getClass().getSimpleName() + '.setTimeoutValue(' +
'execution=' + execution.getId() +
')'
def isDebugLogEnabled = execution.getVariable('isDebugLogEnabled')
logDebug('Entered ' + method, isDebugLogEnabled)
String prefix = execution.getVariable('prefix')
try {
def timeoutValue = execution.getVariable("URN_mso_sdnc_timeout")
if (execution.getVariable(prefix + 'callback1') != null) {
// Waiting for subsequent notifications
}
} catch (Exception e) {
String msg = 'Caught exception in ' + method + ": " + e
logDebug(msg, isDebugLogEnabled)
logError(msg)
exceptionUtil.buildAndThrowWorkflowException(execution, 2000, msg)
}
}
}
|
