aboutsummaryrefslogtreecommitdiffstats
path: root/vid-app-common/src/main/java/org/onap/vid/controller/test/TestMsoController.java
blob: 4cb0d6c1667743c7114693b2dedb3cb3ebcd23c8 (plain)
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
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
/*-
 * ============LICENSE_START=======================================================
 * VID
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. 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.onap.vid.controller.test;

import com.fasterxml.jackson.databind.ObjectMapper;
import org.onap.portalsdk.core.controller.RestrictedBaseController;
import org.onap.vid.model.ExceptionResponse;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.stream.Collectors;

/*
 * The "TestMsoController" class is primarily designed to help test "msoCommitController.js"
 * 
 * This class expects and receives JSON data in the same format as expected
 * in the "real" application version of this code. However, string versions of JSON are
 * maintained internally here instead of marshalled / unmarshalled JSON objects.
 * The primary reasons for this were to encapsulate all the test code in this single file and
 * minimize the time required to support initial test cases.
 * 
 * The non-test equivalent of this controller could alternatively incorporate POJO objects
 * instead of strings. However, the same data format sent to / received from the browser
 * JavaScript code would still be expected.
 * 
 * Two specific mechanisms used in this test class may be useful to the application version:
 * 
 * 		1) The use of "{variable}" elements in @RequestMappings along with the corresponding
 * 		@PathVariable declarations.
 * 
 * 		2) The use of @ExceptionHandler for general purpose exception handler.
 * 		(See @ExceptionHandler comments)
 *
 * This class is intended to be used in either:
 * 
 * 		A) Eclipse environments
 * 	OR
 * 		B) Linux environments with ONLY a single user running tests.
 *		The "quick and dirty" error simulation approach used here makes use of static states for some
 *		scenarios. Thus multiple users simultaneously testing in Linux environments
 *		may have contention issues.
 */

/**
 * The Class TestMsoController.
 */
@RestController
@RequestMapping("testmso")
public class TestMsoController extends RestrictedBaseController {

	/*
	 * Artificial delay (in milliseconds) added before responding to create /
	 * delete requests
	 */

	/** The Constant TEST_DELAY_SHORT_MSEC. */
	private final static int TEST_DELAY_SHORT_MSEC = 1000;

	/*
	 * Long delay to simulate non-responsive server test
	 */

	/** The Constant TEST_DELAY_LONG_MSEC. */
	private final static int TEST_DELAY_LONG_MSEC = 15000;

	/*
	 * Default number of polls expected before transaction complete.
	 */

	/** The Constant MAXIMUM_POLLS_DEFAULT. */
	private final static int MAXIMUM_POLLS_DEFAULT = 4;

	/*
	 * Number of polls to simulate "maximum polls exceeded" test.
	 */

	/** The Constant MAXIMUM_POLLS_LARGE. */
	private final static int MAXIMUM_POLLS_LARGE = 10;

	/*
	 * Simulated error types. The GUI front end is expected to set these values
	 * in the "modelName" field of the "mso_create_svc_instance" request.
	 */

	/** The Constant ERROR_POLICY_EXCEPTION. */
	private final static String ERROR_POLICY_EXCEPTION = "ERROR_POLICY_EXCEPTION";

	/** The Constant ERROR_SERVICE_EXCEPTION. */
	private final static String ERROR_SERVICE_EXCEPTION = "ERROR_SERVICE_EXCEPTION";

	/** The Constant ERROR_POLL_FAILURE. */
	private final static String ERROR_POLL_FAILURE = "ERROR_POLL_FAILURE";

	/** The Constant ERROR_INVALID_FIELD_INITIAL. */
	private final static String ERROR_INVALID_FIELD_INITIAL = "ERROR_INVALID_FIELD_INITIAL";

	/** The Constant ERROR_INVALID_FIELD_POLL. */
	private final static String ERROR_INVALID_FIELD_POLL = "ERROR_INVALID_FIELD_POLL";

	/** The Constant ERROR_GENERAL_SERVER_EXCEPTION. */
	private final static String ERROR_GENERAL_SERVER_EXCEPTION = "ERROR_GENERAL_SERVER_EXCEPTION";

	/** The Constant ERROR_MAX_POLLS. */
	private final static String ERROR_MAX_POLLS = "ERROR_MAX_POLLS";

	/** The Constant ERROR_SERVER_TIMEOUT_INITIAL. */
	private final static String ERROR_SERVER_TIMEOUT_INITIAL = "ERROR_SERVER_TIMEOUT_INITIAL";

	/** The Constant ERROR_SERVER_TIMEOUT_POLL. */
	private final static String ERROR_SERVER_TIMEOUT_POLL = "ERROR_SERVER_TIMEOUT_POLL";

	/** The simulated error. */
	private String simulatedError = "";

	/** The maximum polls. */
	private int maximumPolls = 0;

	/** The attempt count. */
	private int attemptCount = 0;

	/**
	 * Creates the svc instance.
	 *
	 * @param request the request
	 * @return the response entity
	 * @throws Exception the exception
	 */
	@RequestMapping(value = "/mso_create_svc_instance", method = RequestMethod.POST)
	public ResponseEntity<String> createSvcInstance(HttpServletRequest request) throws Exception {
		readAndLogRequest("CREATE SERVICE INSTANCE", request);
		Thread.sleep(TEST_DELAY_SHORT_MSEC);
		maximumPolls = MAXIMUM_POLLS_DEFAULT; // Simulates MSO polling behavior
		attemptCount = 0;

		/*
		 * This block of code simulates various errors and would NOT be expected
		 * in a non-test method
		 */
		System.err.println("simulatedError: " + simulatedError);

		if (simulatedError.equals(ERROR_POLICY_EXCEPTION)) {
			return new ResponseEntity<String>(policyExceptionResponse, HttpStatus.OK);
		}
		if (simulatedError.equals(ERROR_SERVICE_EXCEPTION)) {
			return new ResponseEntity<String>(serviceExceptionResponse, HttpStatus.OK);
		}
		if (simulatedError.equals(ERROR_INVALID_FIELD_INITIAL)) {
			/*
			 * Force invalid response field name. Return
			 * "XXXXXrequestReferences" instead of "requestReferences"
			 */
			return new ResponseEntity<String>(acceptResponse.replace("requestReferences", "XXXXXrequestReferences"),
					HttpStatus.OK);
		}

		if (simulatedError.equals(ERROR_GENERAL_SERVER_EXCEPTION)) {
			throw new IOException("an example of an IO exception");
		}

		if (simulatedError.equals(ERROR_SERVER_TIMEOUT_INITIAL)) {
			Thread.sleep(TEST_DELAY_LONG_MSEC);
		}

		if (simulatedError.equals(ERROR_MAX_POLLS)) {
			maximumPolls = MAXIMUM_POLLS_LARGE;
		}

		/*
		 * End of block of simulated error code.
		 */

		return new ResponseEntity<String>(acceptResponse, HttpStatus.OK);
	}

	/**
	 * Delete svc instance.
	 *
	 * @param serviceInstanceId the service instance id
	 * @param request the request
	 * @return the response entity
	 * @throws Exception the exception
	 */
	@RequestMapping(value = "/mso_delete_svc_instance/{serviceInstanceId}", method = RequestMethod.POST)
	public ResponseEntity<String> deleteSvcInstance(@PathVariable("serviceInstanceId") String serviceInstanceId,
													HttpServletRequest request) throws Exception {
		readAndLogRequest("DELETE SERVICE INSTANCE: serviceInstanceId: " + serviceInstanceId, request);
		Thread.sleep(TEST_DELAY_SHORT_MSEC);
		maximumPolls = MAXIMUM_POLLS_DEFAULT; // Simulates MSO polling behavior
		attemptCount = 0;
		return new ResponseEntity<String>(acceptResponse, HttpStatus.OK);
	}

	/**
	 * Creates the vnf instance.
	 *
	 * @param serviceInstanceId the service instance id
	 * @param request the request
	 * @return the response entity
	 * @throws Exception the exception
	 */
	@RequestMapping(value = "/mso_create_vnf_instance/{serviceInstanceId}", method = RequestMethod.POST)
	public ResponseEntity<String> createVnfInstance(@PathVariable("serviceInstanceId") String serviceInstanceId,
													HttpServletRequest request) throws Exception {
		readAndLogRequest("CREATE VNF INSTANCE: serviceInstanceId: " + serviceInstanceId, request);
		Thread.sleep(TEST_DELAY_SHORT_MSEC);
		maximumPolls = MAXIMUM_POLLS_DEFAULT; // Simulates MSO polling behavior
		attemptCount = 0;
		return new ResponseEntity<String>(acceptResponse, HttpStatus.OK);
	}

	/**
	 * Delete vnf instance.
	 *
	 * @param serviceInstanceId the service instance id
	 * @param vnfInstanceId the vnf instance id
	 * @param request the request
	 * @return the response entity
	 * @throws Exception the exception
	 */
	@RequestMapping(value = "/mso_delete_vnf_instance/{serviceInstanceId}/vnfs/{vnfInstanceId}", method = RequestMethod.POST)
	public ResponseEntity<String> deleteVnfInstance(@PathVariable("serviceInstanceId") String serviceInstanceId,
													@PathVariable("vnfInstanceId") String vnfInstanceId, HttpServletRequest request) throws Exception {
		readAndLogRequest(
				"DELETE VNF INSTANCE: serviceInstanceId: " + serviceInstanceId + " vnfInstanceId: " + vnfInstanceId,
				request);
		Thread.sleep(TEST_DELAY_SHORT_MSEC);
		maximumPolls = MAXIMUM_POLLS_DEFAULT; // Simulates MSO polling behavior
		attemptCount = 0;
		return new ResponseEntity<String>(acceptResponse, HttpStatus.OK);
	}

	/**
	 * Creates the vf module instance.
	 *
	 * @param serviceInstanceId the service instance id
	 * @param vnfInstanceId the vnf instance id
	 * @param request the request
	 * @return the response entity
	 * @throws Exception the exception
	 */
	// /serviceInstances/v2/ff305d54-75b4-431b-adb2-eb6b9e5ff000/vnfs/ff305d54-75b4-ff1b-adb2-eb6b9e5460ff/vfModules
	@RequestMapping(value = "/mso_create_vfmodule_instance/{serviceInstanceId}/vnfs/{vnfInstanceId}", method = RequestMethod.POST)
	public ResponseEntity<String> createVfModuleInstance(@PathVariable("serviceInstanceId") String serviceInstanceId,
														 @PathVariable("vnfInstanceId") String vnfInstanceId, HttpServletRequest request) throws Exception {
		readAndLogRequest("CREATE VF MODULE INSTANCE: serviceInstanceId: " + serviceInstanceId + " vnfInstanceId: "
				+ vnfInstanceId, request);
		Thread.sleep(TEST_DELAY_SHORT_MSEC);
		maximumPolls = MAXIMUM_POLLS_DEFAULT; // Simulates MSO polling behavior
		attemptCount = 0;
		return new ResponseEntity<String>(acceptResponse, HttpStatus.OK);
	}

	/**
	 * Delete vf module instance.
	 *
	 * @param serviceInstanceId the service instance id
	 * @param vnfInstanceId the vnf instance id
	 * @param vfModuleInstanceId the vf module instance id
	 * @param request the request
	 * @return the response entity
	 * @throws Exception the exception
	 */
	// /serviceInstances/v2/ff305d54-75b4-431b-adb2-eb6b9e5ff000/vnfs/ff305d54-75b4-ff1b-adb2-eb6b9e5460ff/vfModules/ff305d54-75b4-ff1b-bdb2-eb6b9e5460ff
	@RequestMapping(value = "/mso_delete_vfmodule_instance/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfModuleInstanceId}", method = RequestMethod.POST)
	public ResponseEntity<String> deleteVfModuleInstance(@PathVariable("serviceInstanceId") String serviceInstanceId,
														 @PathVariable("vnfInstanceId") String vnfInstanceId,
														 @PathVariable("vfModuleInstanceId") String vfModuleInstanceId, HttpServletRequest request)
			throws Exception {
		readAndLogRequest("DELETE VF MODULE INSTANCE: serviceInstanceId: " + serviceInstanceId + " vnfInstanceId: "
				+ vnfInstanceId + " vfModuleInstanceId: " + vfModuleInstanceId, request);
		Thread.sleep(TEST_DELAY_SHORT_MSEC);
		maximumPolls = MAXIMUM_POLLS_DEFAULT; // Simulates MSO polling behavior
		attemptCount = 0;
		return new ResponseEntity<String>(acceptResponse, HttpStatus.OK);
	}

	// POST
	/**
	 * Creates the volume group instance.
	 *
	 * @param serviceInstanceId the service instance id
	 * @param vnfInstanceId the vnf instance id
	 * @param request the request
	 * @return the response entity
	 * @throws Exception the exception
	 */
	// /serviceInstances/v2/ff305d54-75b4-431b-adb2-eb6b9e5ff000/volumeGroups
	@RequestMapping(value = "/mso_create_volumegroup_instance/{serviceInstanceId}/vnfs/{vnfInstanceId}", method = RequestMethod.POST)
	public ResponseEntity<String> createVolumeGroupInstance(@PathVariable("serviceInstanceId") String serviceInstanceId,
															@PathVariable("vnfInstanceId") String vnfInstanceId, HttpServletRequest request) throws Exception {
		readAndLogRequest("CREATE VOLUME GROUP INSTANCE: seviceInstanceId: " + serviceInstanceId + " vnfInstanceId: "
				+ vnfInstanceId, request);
		Thread.sleep(TEST_DELAY_SHORT_MSEC);
		maximumPolls = MAXIMUM_POLLS_DEFAULT; // Simulates MSO polling behavior
		attemptCount = 0;
		return new ResponseEntity<String>(acceptResponse, HttpStatus.OK);
	}

	/**
	 * Delete volume group instance.
	 *
	 * @param serviceInstanceId the service instance id
	 * @param vnfInstanceId the vnf instance id
	 * @param volumeGroupInstanceId the volume group instance id
	 * @param request the request
	 * @return the response entity
	 * @throws Exception the exception
	 */
	// /serviceInstances/v2/ff305d54-75b4-431b-adb2-eb6b9e5ff000/volumeGroups/ff305d54-75b4-ff1b-cdb2-eb6b9e5460ff
	@RequestMapping(value = "/mso_delete_volumegroup_instance/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}", method = RequestMethod.POST)
	public ResponseEntity<String> deleteVolumeGroupInstance(@PathVariable("serviceInstanceId") String serviceInstanceId,
															@PathVariable("vnfInstanceId") String vnfInstanceId,
															@PathVariable("volumeGroupInstanceId") String volumeGroupInstanceId, HttpServletRequest request)
			throws Exception {
		readAndLogRequest("DELETE NW INSTANCE: serviceInstanceId: " + serviceInstanceId + " vnfInstanceId: "
				+ vnfInstanceId + " volumeGroupInstanceId: " + volumeGroupInstanceId, request);
		Thread.sleep(TEST_DELAY_SHORT_MSEC);
		maximumPolls = MAXIMUM_POLLS_DEFAULT; // Simulates MSO polling behavior
		attemptCount = 0;
		return new ResponseEntity<String>(acceptResponse, HttpStatus.OK);
	}

	/**
	 * Creates the nw instance.
	 *
	 * @param serviceInstanceId the service instance id
	 * @param request the request
	 * @return the response entity
	 * @throws Exception the exception
	 */
	@RequestMapping(value = "/mso_create_nw_instance/{serviceInstanceId}", method = RequestMethod.POST)
	public ResponseEntity<String> createNwInstance(@PathVariable("serviceInstanceId") String serviceInstanceId,
												   HttpServletRequest request) throws Exception {
		readAndLogRequest("CREATE NW INSTANCE: serviceInstanceId: " + serviceInstanceId, request);
		Thread.sleep(TEST_DELAY_SHORT_MSEC);
		maximumPolls = MAXIMUM_POLLS_DEFAULT; // Simulates MSO polling behavior
		attemptCount = 0;
		return new ResponseEntity<String>(acceptResponse, HttpStatus.OK);
	}

	/**
	 * Delete nw instance.
	 *
	 * @param serviceInstanceId the service instance id
	 * @param networkInstanceId the network instance id
	 * @param request the request
	 * @return the response entity
	 * @throws Exception the exception
	 */
	@RequestMapping(value = "/mso_delete_nw_instance/{serviceInstanceId}/networks/{networkInstanceId}", method = RequestMethod.POST)
	public ResponseEntity<String> deleteNwInstance(@PathVariable("serviceInstanceId") String serviceInstanceId,
												   @PathVariable("networkInstanceId") String networkInstanceId, HttpServletRequest request) throws Exception {
		readAndLogRequest("DELETE NW INSTANCE: serviceInstanceId: " + serviceInstanceId + " networkInstanceId: "
				+ networkInstanceId, request);
		Thread.sleep(TEST_DELAY_SHORT_MSEC);
		maximumPolls = MAXIMUM_POLLS_DEFAULT; // Simulates MSO polling behavior
		attemptCount = 0;
		return new ResponseEntity<String>(acceptResponse, HttpStatus.OK);
	}

	/**
	 * Gets the orchestration request.
	 *
	 * @param requestId the request id
	 * @param request the request
	 * @return the orchestration request
	 * @throws Exception the exception
	 */
	@RequestMapping(value = "/mso_get_orch_req/{requestId}", method = RequestMethod.GET)
	public ResponseEntity<String> getOrchestrationRequest(@PathVariable("requestId") String requestId,
														  HttpServletRequest request) throws Exception {

		System.err.println("GET ORCHESTRATION REQUEST: requestId: " + requestId);

		/*
		 * This block of code simulates various errors and would NOT be expected
		 * in a non-test method
		 */

		if (simulatedError.equals(ERROR_INVALID_FIELD_POLL)) {
			/*
			 * Force invalid response field name. Return "XXXXXrequestStatus"
			 * instead of "requestStatus"
			 */
			return new ResponseEntity<String>(inProgressResponse.replace("requestStatus", "XXXXXrequestStatus"),
					HttpStatus.OK);
		}

		if (simulatedError.equals(ERROR_POLL_FAILURE)) {
			/*
			 * Force status field with "Failure"
			 */
			return new ResponseEntity<String>(inProgressResponse.replace("InProgress", "Failure"), HttpStatus.OK);
		}

		if (simulatedError.equals(ERROR_SERVER_TIMEOUT_POLL)) {
			Thread.sleep(TEST_DELAY_LONG_MSEC);
		}

		/*
		 * End of block of simulated error code.
		 */

		/*
		 * This logic simulates how MSO might behave ... i.e. return different
		 * results depending on the value of 'maximumPolls'.
		 *
		 */
		int percentProgress = (++attemptCount * 100) / maximumPolls;

		System.err.println("attempts: " + attemptCount + " max: " + maximumPolls + " percent: " + percentProgress);

		String response = inProgressResponse.replace("\"50\"", "\"" + Integer.toString(percentProgress) + "\"");

		if (attemptCount < maximumPolls) {
			if (attemptCount > 1) {
				response = response.replace("vLan setup", "setup step " + Integer.toString(attemptCount));
			}
			return new ResponseEntity<String>(response, HttpStatus.OK);
		} else {
			return new ResponseEntity<String>(
					response.replace("InProgress", "Complete").replace("vLan setup complete", ""), HttpStatus.OK);
		}
	}

	/**
	 * Gets the orchestration requests.
	 *
	 * @param filterString the filter string
	 * @param request the request
	 * @return the orchestration requests
	 * @throws Exception the exception
	 */
	@RequestMapping(value = "/mso_get_orch_reqs/{filterString}", method = RequestMethod.GET)
	public ResponseEntity<String> getOrchestrationRequests(@PathVariable("filterString") String filterString,
														   HttpServletRequest request) throws Exception {

		System.err.println("GET ORCHESTRATION REQUESTS: filterString: " + filterString);

		return new ResponseEntity<String>(getOrchestrationRequestsResponse, HttpStatus.OK);

	}

	/*
	 * General purpose exception handler that could be used in application code.
	 * 
	 * The method returns exceptions as error code 500. Both the exception type
	 * and message are written as a JSON object.
	 * 
	 * See the following references:
	 * 
	 * 1) The ExceptionResponse POJO.
	 * 
	 * 2) The "getHttpErrorMessage" function in "utilityService.js" - an example
	 * of how the browser JavaScript code can interpret this response.
	 */

	/**
	 * Exception.
	 *
	 * @param e the e
	 * @param response the response
	 * @throws IOException Signals that an I/O exception has occurred.
	 */
	@ExceptionHandler(Exception.class)
	private void exception(Exception e, HttpServletResponse response) throws IOException {

		/*
		 * This logging step should preferably be replaced with an appropriate
		 * logging method consistent whatever logging mechanism the rest of the
		 * application code uses.
		 */

		e.printStackTrace(System.err);

		response.setContentType("application/json; charset=UTF-8");
		response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);

		ExceptionResponse exceptionResponse = new ExceptionResponse();
		exceptionResponse.setException(e.getClass().toString().replaceFirst("^.*\\.", ""));
		exceptionResponse.setMessage(e.getMessage());

		response.getWriter().write(new ObjectMapper().writeValueAsString(exceptionResponse));

		response.flushBuffer();

	}

	/*
	 * 'readAndLogRequest' only intended to be used for testing.
	 * 
	 * The method reads JSON from the input stream and thus prevents other
	 * mechanisms from reading the input.
	 */

	/**
	 * Read and log request.
	 *
	 * @param label the label
	 * @param request the request
	 * @throws Exception the exception
	 */
	private void readAndLogRequest(String label, HttpServletRequest request) throws Exception {
		String input = request.getReader().lines().collect(Collectors.joining(System.lineSeparator()));

		ObjectMapper mapper = new ObjectMapper();
		Object json = mapper.readValue(input, Object.class);

		System.err.println(label + "\n" + mapper.writerWithDefaultPrettyPrinter().writeValueAsString(json));

		/*
		 * Only needed for error simulation ...
		 */
		if (input.matches("^.*modelName.*$")) {
			simulatedError = input.replaceAll("^.*\"modelName\":\"", "").replaceAll("\".*$", "");
		}
	}

	/*
	 * Various test responses:
	 */

	// @formatter:off

	/** The accept response. */
	/*
	 * Sample responses to initial create / delete transaction
	 */
	private String acceptResponse =
			"{" +
					"  \"status\": 202," +
					"  \"entity\": {" +
					"      \"requestReferences\": {" +
					"         \"instanceId\": \"bc305d54-75b4-431b-adb2-eb6b9e546014\"," +
					"         \"requestId\": \"rq1234d1-5a33-55df-13ab-12abad84e331\"" +
					"      }" +
					"  }" +
					"}";

	/** The policy exception response. */
	private String policyExceptionResponse =
			"{" +
					"  \"status\": 400," +
					"  \"entity\": { " +
					"    \"requestError\": {" +
					"      \"policyException\": {" +
					"        \"messageId\": \"POL9003\"," +
					"        \"text\": \"Message content size exceeds the allowable limit\"" +
					"      }" +
					"    }" +
					"  }" +
					"}";

	/** The service exception response. */
	private String serviceExceptionResponse =
			"{" +
					"  \"status\": 400," +
					"  \"entity\": { " +
					"    \"requestError\": {" +
					"      \"serviceException\": {" +
					"        \"messageId\": \"SVC2000\"," +
					"        \"text\": \"Missing Parameter: %1. Error code is %2\"," +
					"        \"variables\": [" +
					"          \"severity\"," +
					"          \"400\"" +
					"        ]" +
					"      }" +
					"    }" +
					"  }" +
					"}" +
					"";

	/** The in progress response. */
	/*
	 * Sample response to subsequent getOrchestrationRequest
	 */
	private String inProgressResponse =
			"{" +
					"   \"status\": 200," +
					"   \"entity\": {" +
					"      \"request\": {" +
					"         \"requestId\": \"rq1234d1-5a33-55df-13ab-12abad84e333\"," +
					"         \"startTime\": \"Thu, 04 Jun 2009 02:51:59 GMT\"," +
					"         \"instanceIds\": {" +
					"            \"serviceInstanceId\": \"bc305d54-75b4-431b-adb2-eb6b9e546014\"" +
					"         }," +
					"         \"requestScope\": \"service\"," +
					"         \"requestType\": \"createInstance\"," +
					"         \"requestDetails\": {" +
					"            \"modelInfo\": {" +
					"               \"modelType\": \"service\"," +
					"               \"modelId\": \"sn5256d1-5a33-55df-13ab-12abad84e764\"," +
					"               \"modelNameVersionId\": \"ab6478e4-ea33-3346-ac12-ab121484a333\"," +
					"               \"modelName\": \"WanBonding\"," +
					"               \"modelVersion\": \"1\"" +
					"            }," +
					"            \"subscriberInfo\": {" +
					"                \"globalSubscriberId\": \"C12345\"," +
					"                \"subscriberName\": \"General Electric Division 12\"" +
					"            }," +
					"            \"requestParameters\": {" +
					"               \"vpnId\": \"1a2b3c4d5e6f\"," +
					"               \"productName\": \"Trinity\"," +
					"               \"customerId\": \"icore9883749\"" +
					"            }" +
					"         }," +
					"         \"requestStatus\": {" +
					"            \"timestamp\": \"Thu, 04 Jun 2009 02:53:39 GMT\"," +
					"            \"requestState\": \"InProgress\"," +
					"            \"statusMessage\": \"vLan setup complete\"," +
					"            \"percentProgress\": \"50\"" +
					"         }" +
					"      }" +
					"   }" +
					"}";
	
	/*
	 * Sample response to subsequent getOrchestrationRequests
	 */

	/** The get orchestration requests response. */
	private String getOrchestrationRequestsResponse =
			"{" +
					"   \"status\": 200," +
					"   \"entity\": {" +
					"      \"requestList\": [" +
					"         {" +
					"            \"request\": {" +
					"               \"requestId\": \"rq1234d1-5a33-55df-13ab-12abad84e333\"," +
					"               \"startTime\": \"Thu, 04 Jun 2009 02:51:59 GMT\"," +
					"               \"finishTime\": \"Thu, 04 Jun 2009 02:55:59 GMT\"," +
					"               \"instanceReferences\": {" +
					"                  \"serviceInstanceId\": \"bc305d54-75b4-431b-adb2-eb6b9e546014\"" +
					"               }," +
					"               \"requestScope\": \"service\"," +
					"               \"requestType\": \"createInstance\"," +
					"               \"requestDetails\": {" +
					"                  \"modelInfo\": {" +
					"                     \"modelType\": \"service\"," +
					"                     \"modelId\": \"sn5256d1-5a33-55df-13ab-12abad84e764\"," +
					"                     \"modelNameVersionId\": \"ab6478e4-ea33-3346-ac12-ab121484a333\"," +
					"                     \"modelName\": \"WanBonding\"," +
					"                     \"modelVersion\": \"1\"" +
					"                  }," +
					"                  \"subscriberInfo\": {" +
					"                      \"globalSubscriberId\": \"C12345\"," +
					"                      \"subscriberName\": \"General Electric Division 12\"" +
					"                  }," +
					"                  \"requestParameters\": {" +
					"                     \"vpnId\": \"1a2b3c4d5e6f\"," +
					"                     \"productName\": \"Trinity\"," +
					"                     \"customerId\": \"icore9883749\"" +
					"                  }" +
					"               }," +
					"               \"requestStatus\": {" +
					"                  \"timestamp\": \"Thu, 04 Jun 2009 02:54:49 GMT\"," +
					"                  \"requestState\": \"complete\"," +
					"                  \"statusMessage\": \"Resource Created\"," +
					"                  \"percentProgress\": \"100\"" +
					"               }" +
					"            }" +
					"         }," +
					"         {" +
					"            \"request\": {" +
					"               \"requestId\": \"rq1234d1-5a33-55df-13ab-12abad84e334\"," +
					"               \"startTime\": \"Thu, 04 Jun 2009 03:52:59 GMT\"," +
					"               \"instanceReferences\": {" +
					"                  \"serviceInstanceId\": \"bc305d54-75b4-431b-adb2-eb6b9e546014\"" +
					"               }," +
					"               \"requestScope\": \"service\"," +
					"               \"requestType\": \"updateInstance\"," +
					"               \"requestDetails\": {" +
					"                  \"modelInfo\": {" +
					"                     \"modelType\": \"service\"," +
					"                     \"modelId\": \"sn5256d1-5a33-55df-13ab-12abad84e764\"," +
					"                     \"modelNameVersionId\": \"ab6478e4-ea33-3346-ac12-ab121484a333\"," +
					"                     \"modelName\": \"WanBonding\"," +
					"                     \"modelVersion\": \"1\"" +
					"                  }," +
					"                  \"subscriberInfo\": {" +
					"                      \"globalSubscriberId\": \"C12345\"," +
					"                      \"subscriberName\": \"General Electric Division 12\"" +
					"                  }," +
					"                  \"requestParameters\": {" +
					"                     \"vpnId\": \"1a2b3c4d5e70\"," +
					"                     \"productName\": \"Trinity\"," +
					"                     \"customerId\": \"icore9883749\"" +
					"                  }" +
					"               }," +
					"               \"requestStatus\": {" +
					"                  \"timestamp\": \"Thu, 04 Jun 2009 03:53:39 GMT\"," +
					"                  \"requestState\": \"InProgress\"," +
					"                  \"statusMessage\": \"vLan setup complete\"," +
					"                  \"percentProgress\": \"50\"" +
					"               }" +
					"            }" +
					"         }" +
					"      ]" +
					"   }" +
					"}";
}