aboutsummaryrefslogtreecommitdiffstats
path: root/controlloop/templates/template.demo.clc/src/main/resources/__closedLoopControlName__.drl
blob: f7f04af814a320ad5695732a719ebd9480ebff55 (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
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
/*
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * Copyright (C) 2018 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.policy.controlloop;

import org.onap.policy.controlloop.VirtualControlLoopEvent;
import org.onap.policy.controlloop.VirtualControlLoopNotification;
import org.onap.policy.controlloop.ControlLoopEventStatus;
import org.onap.policy.controlloop.ControlLoopException;
import org.onap.policy.controlloop.ControlLoopNotificationType;
import org.onap.policy.controlloop.ControlLoopLogger;
import org.onap.policy.controlloop.policy.PolicyResult;
import org.onap.policy.controlloop.policy.ControlLoopPolicy;
import org.onap.policy.controlloop.policy.Policy;
import org.onap.policy.controlloop.eventmanager.ControlLoopEventManager;
import org.onap.policy.controlloop.eventmanager.ControlLoopEventManager.NEW_EVENT_STATUS;
import org.onap.policy.controlloop.eventmanager.ControlLoopOperationManager;
import org.onap.policy.controlloop.actor.so.SoActorServiceProvider;
import org.onap.policy.aai.AaiNqResponseWrapper;
import org.onap.policy.appc.Request;
import org.onap.policy.appc.Response;
import org.onap.policy.appc.CommonHeader;
import org.onap.policy.appclcm.LcmRequestWrapper;
import org.onap.policy.appclcm.LcmResponseWrapper;
import org.onap.policy.appclcm.LcmRequest;
import org.onap.policy.appclcm.LcmResponse;
import org.onap.policy.appclcm.LcmCommonHeader;
import org.onap.policy.vfc.VFCRequest;
import org.onap.policy.vfc.VFCResponse;
import org.onap.policy.vfc.VFCManager;
import org.onap.policy.so.SOManager;
import org.onap.policy.so.SORequest;
import org.onap.policy.so.SORequestStatus;
import org.onap.policy.so.SORequestDetails;
import org.onap.policy.so.SOModelInfo;
import org.onap.policy.so.SOCloudConfiguration;
import org.onap.policy.so.SORequestInfo;
import org.onap.policy.so.SORequestParameters;
import org.onap.policy.so.SORelatedInstanceListElement;
import org.onap.policy.so.SORelatedInstance;
import org.onap.policy.so.SOResponse;
import org.onap.policy.so.SOResponseWrapper;
import org.onap.policy.guard.PolicyGuard;
import org.onap.policy.guard.PolicyGuard.LockResult;
import org.onap.policy.guard.TargetLock;
import org.onap.policy.guard.GuardResult;
import org.onap.policy.guard.PolicyGuardRequest;
import org.onap.policy.guard.PolicyGuardResponse;
import org.onap.policy.guard.PolicyGuardXacmlRequestAttributes;
import org.onap.policy.guard.CallGuardTaskEmbedded;

import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.constructor.Constructor;

import org.slf4j.LoggerFactory;
import org.slf4j.Logger;

import java.time.Instant;
import java.util.LinkedList;
import java.util.Iterator;

import org.onap.policy.drools.system.PolicyEngine;

/*
 * This structure mimics the Params structure.
 * Its only purpose is to allow management of
 * rules by the PAP component..
 * It has no use at runtime since the rules go by
 * Params for matching purposes.
 */
declare PapParams
  closedLoopControlName : String
  controlLoopYaml : String
end

/*
 * Control Loop Identity
 */
declare Params
  closedLoopControlName : String
  controlLoopYaml : String
end

/*
 * Used to trigger clean up Params that no longer have associated rules.
 */
declare ParamsInitCleaner
  closedLoopControlName : String    // only used when logging
end

/*
 * Used to clean up Params that no longer have associated rules.
 */
declare ParamsCleaner
  closedLoopControlName : String
  controlLoopYaml : String
end


/*
 * Operation Timer
 */
declare OperationTimer
  closedLoopControlName : String
  requestID : String
  delay : String
end

/*
 * Control Loop Timer
 */
declare ControlLoopTimer
  closedLoopControlName : String
  requestID : String
  delay : String
end

/*
*
* Called to insert the parameters into working memory for this Closed Loop policy.  This is called
* once each time a closed loop is added or its YAML is updated.
* This has a higher salience so we can ensure that the Params is created before we have a chance to
* discard any events.
*
*/
rule "${policyName}.SETUP"
    salience 1
    when
        not( Params( getClosedLoopControlName() == "${closedLoopControlName}", getControlLoopYaml() == "${controlLoopYaml}" ) )
    then
    
    Params params = new Params();
    params.setClosedLoopControlName("${closedLoopControlName}");
    params.setControlLoopYaml("${controlLoopYaml}");
    insert(params);
    
    ParamsInitCleaner initCleaner = new ParamsInitCleaner();
    initCleaner.setClosedLoopControlName("${closedLoopControlName}");
    insert(initCleaner);

    // Note: globals have bad behavior when persistence is used,
    //       hence explicitly getting the logger vs using a global
    
    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {} : YAML=[{}]", params.getClosedLoopControlName(), drools.getRule().getName(), params.getControlLoopYaml());
end

/*
*
* This rule responds to DCAE Events where there is no manager yet. Either it is
* the first ONSET, or a subsequent badly formed Event (i.e. Syntax error, or is-closed-loop-disabled)
*
*/
rule "${policyName}.EVENT"
    when
        $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
        $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName() )
        not ( ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() ) )
    then
 
    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
    
    try {
      
        //
        // Check the event, because we need it to not be null when
        // we create the ControlLoopEventManager. The ControlLoopEventManager
        // will do extra syntax checking as well check if the closed loop is disabled.
        //
        if ($event.getRequestId() == null) {
            VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
            notification.setNotification(ControlLoopNotificationType.REJECTED);
            notification.setFrom("policy");
            notification.setMessage("Missing requestId");
            notification.setPolicyName(drools.getRule().getName());
            notification.setPolicyScope("${policyScope}");
            notification.setPolicyVersion("${policyVersion}");
            
            //
            // Let interested parties know
            //
            PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
            
            //
            // Retract it from memory
            //
            retract($event);
        } else if ($event.getClosedLoopEventStatus() != ControlLoopEventStatus.ONSET) {
            throw new ControlLoopException($event.getClosedLoopEventStatus() + " received with no prior onset");
        } else {
            //
            // Create an EventManager
            //
            ControlLoopEventManager manager = new ControlLoopEventManager($params.getClosedLoopControlName(), $event.getRequestId());
            //
            // Disable target locking
            //
            manager.setUseTargetLock(false);
            //
            // Determine if EventManager can actively process the event (i.e. syntax, is_closed_loop_disabled checks etc.)
            //
            VirtualControlLoopNotification notification = manager.activate($params.getControlLoopYaml(), $event);
            notification.setFrom("pdp-0001-controller=controlloop"); // Engine.getInstanceName()
            notification.setPolicyName(drools.getRule().getName());
            notification.setPolicyScope("${policyScope}");
            notification.setPolicyVersion("${policyVersion}");
            //
            // Are we actively pursuing this event?
            //
            if (notification.getNotification() == ControlLoopNotificationType.ACTIVE) {
                //
                // Insert Event Manager into memory, this will now kick off processing.
                //
                insert(manager);
                //
                // Let interested parties know
                //
                PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
                //
                // Setup the Overall Control Loop timer
                //
                ControlLoopTimer clTimer = new ControlLoopTimer();
                clTimer.setClosedLoopControlName($event.getClosedLoopControlName());
                clTimer.setRequestID($event.getRequestId().toString());
                clTimer.setDelay(manager.getControlLoopTimeout(1500) + "s");
                //
                // Insert it
                //
                insert(clTimer);
            } else {
                //
                // Let interested parties know
                //
                PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
                //
                // Retract it from memory
                //
                retract($event);
            }
            
            //
            // Now that the manager is inserted into Drools working memory, we'll wait for
            // another rule to fire in order to continue processing. This way we can also
            // then screen for additional ONSET and ABATED events for this RequestId.
            //
        }
    } catch (Exception e) {
        logger.warn("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName(), e);
        
        VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
        notification.setNotification(ControlLoopNotificationType.REJECTED);
        notification.setMessage("Exception occurred: " + e.getMessage());
        notification.setPolicyName(drools.getRule().getName());
        notification.setPolicyScope("${policyScope}");
        notification.setPolicyVersion("${policyVersion}");
        //
        //
        //
        PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
        //
        // Retract the event
        //
        retract($event);
    }
end

/*
*
* This rule happens when we got a valid ONSET, closed loop is enabled and an Event Manager
* is now created. We can start processing the yaml specification via the Event Manager.
*
*/
rule "${policyName}.EVENT.MANAGER"
    when
        $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
        $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName() )
        $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
        $clTimer : ControlLoopTimer ( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString() )
    then

    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}: event={} manager={} clTimer={}", 
                $params.getClosedLoopControlName(), drools.getRule().getName(),
                $event, $manager, $clTimer);
    
    try {
        //
        // Check which event this is.
        //
        ControlLoopEventManager.NEW_EVENT_STATUS eventStatus = $manager.onNewEvent($event);
        //
        // Check what kind of event this is
        //
        if (eventStatus == NEW_EVENT_STATUS.SUBSEQUENT_ONSET) {
            //
            // We don't care about subsequent onsets
            //
            logger.info("{}: {}: subsequent onset", 
                        $params.getClosedLoopControlName(), drools.getRule().getName());
            retract($event);
            return;
        }
        if (eventStatus == NEW_EVENT_STATUS.SYNTAX_ERROR) {
            //
            // Ignore any bad syntax events
            //
            logger.warn("{}: {}: syntax error", 
                        $params.getClosedLoopControlName(), drools.getRule().getName());
            retract($event);
            return;
        }
        //
        // We only want the initial ONSET event in memory,
        // all the other events need to be retracted to support
        // cleanup and avoid the other rules being fired for this event.
        //
        if (eventStatus != NEW_EVENT_STATUS.FIRST_ONSET) {
            logger.warn("{}: {}: not first onset", 
                        $params.getClosedLoopControlName(), drools.getRule().getName());
            retract($event);
        }
        
        logger.debug("{}: {}: target={}", $params.getClosedLoopControlName(), 
                     drools.getRule().getName(), $event.getTarget());
        //
        // Now start seeing if we need to process this event
        //

        //
        // Check if this is a Final Event
        //
        VirtualControlLoopNotification notification = $manager.isControlLoopFinal();
    
        if (notification != null) {
            //
            // Set common notification fields
            //
            notification.setFrom("policy");
            notification.setPolicyName(drools.getRule().getName());
            notification.setPolicyScope("${policyScope}");
            notification.setPolicyVersion("${policyVersion}");
            //
            // Its final, but are we waiting for abatement?
            //
            if ($manager.getNumAbatements() > 0) {
                //
                // We have received an abatement and are done
                //
                logger.info("{}: {}: abatement received for {}.  Closing the control loop", 
                            $params.getClosedLoopControlName(), drools.getRule().getName(), 
                            $event.getRequestId());
                //
                // Set notification message
                //
                notification.setMessage("Abatement received. Closing the control loop.");
                //
                /// DB Write---end event processing for this RequestId()
                //
                $manager.commitAbatement("Event Abated","Closed");
                //
                // Unlock the target
                //
                TargetLock lock = $manager.unlockCurrentOperation();
                if (lock != null) {
                    logger.debug("{}: {}: retracting lock=", $params.getClosedLoopControlName(), 
                                 drools.getRule().getName(), lock);
                    retract(lock);
                }
                //
                // Retract everything from memory
                //
                logger.info("{}: {}: retracting onset, manager, and timer", 
                            $params.getClosedLoopControlName(), drools.getRule().getName());
                
                retract($manager.getOnsetEvent());
                
                // don't retract manager, etc. - a clean-up rule will do that
                //
                // TODO - what if we get subsequent Events for this RequestId?
                // By default, it will all start over again. May be confusing for Ruby.
                // Or, we could track this and then subsequently ignore the events
                //
            } else {
                //
                // Check whether we need to wait for abatement
                //
                if ($manager.getProcessor().getControlLoop().getAbatement() == true && notification.getNotification() == ControlLoopNotificationType.FINAL_SUCCESS) {
                  //
                  // We will wait
                  //
                  logger.info("{}: {}: waiting for abatement ..", 
                              $params.getClosedLoopControlName(), drools.getRule().getName());
                  //
                  // Set notification message
                  //
                  notification.setMessage("Waiting for abatement");
                } else {
                  //
                  // We are done
                  //
                  logger.info("{}: {}: no abatement expected for {}.  Closing the control loop", 
                              $params.getClosedLoopControlName(), drools.getRule().getName(), 
                              $event.getRequestId());
                  //
                  // Set notification message
                  //
                  notification.setMessage("No abatement expected. Closing the control loop.");
                  //
                  // Unlock the target
                  //
                  TargetLock lock = $manager.unlockCurrentOperation();
                  if (lock != null) {
                      logger.debug("{}: {}: retracting lock=", $params.getClosedLoopControlName(), 
                                  drools.getRule().getName(), lock);
                      retract(lock);
                  }
                  //
                  // Retract everything from memory
                  //
                  logger.info("{}: {}: retracting onset, manager, and timer", 
                              $params.getClosedLoopControlName(), drools.getRule().getName());
                  
                  retract($manager.getOnsetEvent());
                
                  // don't retract manager, etc. - a clean-up rule will do that
                }
            }
            //
            // Send the notification
            //
            PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
        } else {
            //
            // NOT final, so let's ask for the next operation
            //
            ControlLoopOperationManager operation = $manager.processControlLoop();
            if (operation != null) {
              //
              // Let's ask for a lock right away
              //
              LockResult<GuardResult, TargetLock> result = $manager.lockCurrentOperation();
              logger.info("{}: {}: guard lock acquired={}", 
                            $params.getClosedLoopControlName(), drools.getRule().getName(), 
                            result.getB());
              if (result.getA().equals(GuardResult.LOCK_ACQUIRED)) {
                //
                // insert the operation into memory
                //
                insert(operation);
                
                //
                // insert operation timeout object
                //
                OperationTimer opTimer = new OperationTimer();
                opTimer.setClosedLoopControlName($event.getClosedLoopControlName());
                opTimer.setRequestID($event.getRequestId().toString());
                opTimer.setDelay(operation.getOperationTimeout().toString() + "s");
                insert(opTimer);
              
                //
                // Insert lock into memory
                //
                insert(result.getB());
              }
              else {
                logger.debug("The target resource {} is already processing",
                              $event.getAai().get($event.getTarget()));
                notification = new VirtualControlLoopNotification($event);
                notification.setNotification(ControlLoopNotificationType.REJECTED);
                notification.setMessage("The target " + $event.getAai().get($event.getTarget()) + " is already locked");
                notification.setFrom("policy");
                notification.setPolicyName(drools.getRule().getName());
                notification.setPolicyScope("${policyScope}");
                notification.setPolicyVersion("${policyVersion}");
      
                PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);              
                
                retract($event);
                
                // don't retract manager, etc. - a clean-up rule will do that
                
                if(result.getB() != null) {
                     retract(result.getB());
                }
              }
              logger.info("{}: {}: starting operation={}", 
                          $params.getClosedLoopControlName(), drools.getRule().getName(), 
                          operation);
            } else {
                //
                // Probably waiting for abatement
                //
              logger.info("{}: {}: no operation, probably waiting for abatement", 
                          $params.getClosedLoopControlName(), drools.getRule().getName());
            }
        }
    } catch (Exception e) {
        logger.warn("{}: {}: unexpected", 
                  $params.getClosedLoopControlName(), 
                  drools.getRule().getName(), e);

        VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
        notification.setNotification(ControlLoopNotificationType.FINAL_FAILURE);
        notification.setMessage(e.getMessage());
        notification.setFrom("policy");
        notification.setPolicyName(drools.getRule().getName());
        notification.setPolicyScope("${policyScope}");
        notification.setPolicyVersion("${policyVersion}");
  
        PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);              
            
        retract($event);
                
        // don't retract manager, etc. - a clean-up rule will do that
    }
        
end

/*
*
* Guard Permitted, let's send request to the actor.
*
*/
rule "${policyName}.EVENT.MANAGER.OPERATION.LOCKED.GUARD_PERMITTED"
    when
        $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
        $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName() )
        $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
        $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId(), "Permit".equalsIgnoreCase(getGuardApprovalStatus()) )
        $lock : TargetLock (requestID == $event.getRequestId())
        $opTimer : OperationTimer( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString() )
    then

    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}: event={} manager={} operation={} lock={}", 
                $params.getClosedLoopControlName(), drools.getRule().getName(),
                $event, $manager, $operation, $lock);    

    Object request = null;
    boolean caughtException = false;
    
    try {
        request = $operation.startOperation($event);
        
        if (request != null) {
          logger.debug("{}: {}: starting operation ..", 
                       $params.getClosedLoopControlName(), drools.getRule().getName());
          //
          // Tell interested parties we are performing this Operation
          //
          VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
          notification.setNotification(ControlLoopNotificationType.OPERATION);
          notification.setMessage($operation.getOperationMessage());
          notification.setHistory($operation.getHistory());
          notification.setFrom("policy");
          notification.setPolicyName(drools.getRule().getName());
          notification.setPolicyScope("${policyScope}");
          notification.setPolicyVersion("${policyVersion}");
          
          PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
          
          switch ($operation.policy.getActor()){
              
              case "APPC":
          
                  if (request instanceof Request) {
                      PolicyEngine.manager.deliver("APPC-CL", request);
                  }
                  else if (request instanceof LcmRequestWrapper) {
                      PolicyEngine.manager.deliver("APPC-LCM-READ", request);
                  }
                  break;
              case "SO":
                  // at this point the AAI named query request should have already been made, the response received
                  // and used in the construction of the SO Request which is stored in operationRequest
                  
                  if(request instanceof SORequest) {
                      // Call SO. The response will be inserted into memory once it's received 
                      SoActorServiceProvider.sendRequest($event.getRequestId().toString(), drools.getWorkingMemory(), 
                          request);                        
                  }
                  break;
              case "VFC":
                  if (request instanceof VFCRequest) {
                      // Start VFC thread
                      Thread t = new Thread(new VFCManager(drools.getWorkingMemory(), (VFCRequest)request));
                      t.start();
                  }          
                  break;
          }
        } else {
          //
          // What happens if its null?
          //
            logger.warn("{}: {}: unexpected null operation request", 
                      $params.getClosedLoopControlName(), 
                      drools.getRule().getName());
            if ("SO".equals($operation.policy.getActor())) {
                retract($opTimer);
                retract($operation);
                modify($manager) {finishOperation($operation)};
            }
            else if ("vfc".equalsIgnoreCase($operation.policy.getActor())) {
                retract($opTimer);
                retract($operation);
                modify($manager) {finishOperation($operation)};
            }
        }
        
    } catch (Exception e) {
        String msg = e.getMessage();
        logger.warn("{}: {}: operation={}:  AAI failure: {}", 
                    $params.getClosedLoopControlName(), drools.getRule().getName(),
                    $operation, msg, e);
        $operation.setOperationHasException(msg);
        
        if(request != null) {
            //
            // Create a notification for it ("DB Write - end operation")
            //
            VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
            notification.setFrom("policy");
            notification.setPolicyName(drools.getRule().getName());
            notification.setPolicyScope("${policyScope}");
            notification.setPolicyVersion("${policyVersion}");
            notification.setNotification(ControlLoopNotificationType.OPERATION_FAILURE);
            notification.setMessage($operation.getOperationHistory());
            notification.setHistory($operation.getHistory());
          
            PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
        }
    
        retract($opTimer);
        retract($operation);
        caughtException = true;
    }
    
    // Having the modify statement in the catch clause doesn't work for whatever reason
    if (caughtException) {
        modify($manager) {finishOperation($operation)};
    }
end


/*
*
* We were able to acquire a lock so now let's ask Xacml Guard whether 
* we are allowed to proceed with the request to the actor.
*
*/
rule "${policyName}.EVENT.MANAGER.OPERATION.LOCKED.GUARD_NOT_YET_QUERIED"
    when
        $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
        $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName() )
        $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
        $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId(), getGuardApprovalStatus() == "NONE" )
        $lock : TargetLock (requestID == $event.getRequestId())
    then

    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}: event={} manager={} operation={} lock={}", 
                $params.getClosedLoopControlName(), drools.getRule().getName(),
                $event, $manager, $operation, $lock);
    
    //
    // Sending notification that we are about to query Guard ("DB write - start operation")
    //
    VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
    notification.setNotification(ControlLoopNotificationType.OPERATION);
    notification.setMessage("Sending guard query for " + $operation.policy.getActor() + " " + $operation.policy.getRecipe());
    notification.setHistory($operation.getHistory());
    notification.setFrom("policy");
    notification.setPolicyName(drools.getRule().getName());
    notification.setPolicyScope("${policyScope}");
    notification.setPolicyVersion("${policyVersion}");
    
    PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
        
    //
    // Now send Guard Request to XACML Guard. In order to bypass the call to Guard, 
    // just change guardEnabled to false.
    // 
    //
    
    // NOTE: The environment properties uses "guard.disabled" but the boolean is guardEnabled
    boolean guardEnabled = "false".equalsIgnoreCase(PolicyEngine.manager.getEnvironmentProperty("guard.disabled"));
    
    if(guardEnabled){
    
        Thread t = new Thread(new CallGuardTaskEmbedded(
            drools.getWorkingMemory(),
            $event.getClosedLoopControlName(),
            $operation.policy.getActor().toString(),
            $operation.policy.getRecipe(),
            $operation.getTargetEntity(),
            $event.getRequestId().toString(),
            () -> {
                AaiNqResponseWrapper resp = $manager.getNqVserverFromAai();
                return(resp == null ? null : resp.countVfModules());
            }));
        t.start();
    }
    else{
        insert(new PolicyGuardResponse("Permit", $event.getRequestId(), $operation.policy.getRecipe()));
    }

end

//
// This rule will be triggered when a thread talking to the XACML Guard inserts a 
// guardResponse object into the working memory
//
rule "${policyName}.GUARD.RESPONSE"
    when
        $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
        $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName(), closedLoopEventStatus == ControlLoopEventStatus.ONSET )
        $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() ) 
        $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId() )
        $lock : TargetLock (requestID == $event.getRequestId())
        $opTimer : OperationTimer( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString() )
        $guardResponse : PolicyGuardResponse(requestID == $event.getRequestId(), $operation.policy.recipe == operation)
    then

    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}: event={} manager={} operation={} lock={} opTimer={} guardResponse={}", 
                 $params.getClosedLoopControlName(), drools.getRule().getName(),
                 $event, $manager, $operation, $lock, $opTimer, $guardResponse);
        
        
    //we will permit the operation if there was no Guard for it
    if("Indeterminate".equalsIgnoreCase($guardResponse.getResult())){
        $guardResponse.setResult("Permit");
    }
    
    //
    // This notification has Guard result in "message". ("DB write - end operation in case of Guard Deny")
    //
    VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
    notification.setNotification(ControlLoopNotificationType.OPERATION);
    notification.setMessage("Guard result for " + $operation.policy.getActor() + " " + $operation.policy.getRecipe() + " is " + $guardResponse.getResult());
    notification.setHistory($operation.getHistory());
    notification.setFrom("policy");
    notification.setPolicyName(drools.getRule().getName());
    notification.setPolicyScope("${policyScope}");
    notification.setPolicyVersion("${policyVersion}");
    
    PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
    
    if("Permit".equalsIgnoreCase($guardResponse.getResult())){
    
        modify($operation){setGuardApprovalStatus($guardResponse.getResult())};
    }
    else {
        //This is the Deny case
        $operation.startOperation($event);
        $operation.setOperationHasGuardDeny();
        retract($opTimer);
        retract($operation);
        modify($manager) {finishOperation($operation)};
    }
    
    retract($guardResponse);
            
end

/*
*
* This rule responds to APPC Response Events
*
* I would have like to be consistent and write the Response like this:
* $response : Response( CommonHeader.RequestId == $onset.getRequestId() )
*
* However, no compile error was given. But a runtime error was given. I think
* because drools is confused between the classname CommonHeader vs the property CommonHeader.
*
*/
rule "${policyName}.APPC.RESPONSE"
    when
        $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
        $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName(), closedLoopEventStatus == ControlLoopEventStatus.ONSET ) 
        $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
        $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId() )
        $opTimer : OperationTimer( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString() )
        $lock : TargetLock (requestID == $event.getRequestId())
        $response : Response( getCommonHeader().RequestId == $event.getRequestId() )
    then

    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
    logger.debug("{}: {}: event={} manager={} operation={} lock={} opTimer={} response={}", 
                 $params.getClosedLoopControlName(), drools.getRule().getName(),
                 $event, $manager, $operation, $lock, $opTimer, $response);
    //
    // Get the result of the operation
    //
    PolicyResult policyResult = $operation.onResponse($response);
    if (policyResult != null) {
        logger.debug("{}: {}: operation finished - result={}", 
                    $params.getClosedLoopControlName(), drools.getRule().getName(),
                    policyResult);
        //
        // This Operation has completed, construct a notification showing our results. (DB write - end operation)
        //
        VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
        notification.setFrom("policy");
        notification.setPolicyName(drools.getRule().getName());
        notification.setPolicyScope("${policyScope}");
        notification.setPolicyVersion("${policyVersion}");
        notification.setMessage($operation.getOperationHistory());
        notification.setHistory($operation.getHistory());
        if (policyResult.equals(PolicyResult.SUCCESS)) {
            notification.setNotification(ControlLoopNotificationType.OPERATION_SUCCESS);
            //
            // Let interested parties know
            //
            PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
        } else {
            notification.setNotification(ControlLoopNotificationType.OPERATION_FAILURE);
            //
            // Let interested parties know
            //
            PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
        }
        //
        // Ensure the operation is complete
        //
        if ($operation.isOperationComplete() == true) {
            //
            // It is complete, remove it from memory
            //
            retract($operation);
            //
            // We must also retract the timer object
            // NOTE: We could write a Rule to do this
            //
            retract($opTimer);
            //
            // Complete the operation
            //
            modify($manager) {finishOperation($operation)};
        } else {
            //
            // Just doing this will kick off the LOCKED rule again
            //
            modify($operation) {};
        }
    } else {
        //
        // Its not finished yet (i.e. expecting more Response objects)
        //
        // Or possibly it is a leftover response that we timed the request out previously
        //
    }
    //
    // We are going to retract these objects from memory
    //
    retract($response);
end

/*
*
* The problem with Responses is that they don't have a controlLoopControlName
* field in them, so the only way to attach them is via RequestId. If we have multiple
* control loop .drl's loaded in the same container, we need to be sure the cleanup
* rules don't remove Responses for other control loops.
*
*/
rule "${policyName}.APPC.RESPONSE.CLEANUP"
    when
        $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
        $response : Response($id : getCommonHeader().RequestId )
        not ( VirtualControlLoopEvent( requestId == $id, closedLoopEventStatus == ControlLoopEventStatus.ONSET ) ) 
    then

    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
    logger.debug("{}: {}: orphan appc response={}", 
                $params.getClosedLoopControlName(), drools.getRule().getName(), $id);
        
    //
    // Retract it
    //
    retract($response);
end

/*
*
* This rule responds to APPC Response Events using the new LCM interface provided by appc
*
*/
rule "${policyName}.APPC.LCM.RESPONSE"
    when
        $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
        $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName(), closedLoopEventStatus == ControlLoopEventStatus.ONSET ) 
        $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
        $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId() )
        $opTimer : OperationTimer( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString() )
        $lock : TargetLock (requestID == $event.getRequestId())
        $response : LcmResponseWrapper( getBody().getCommonHeader().getRequestId() == $event.getRequestId() )
    then

    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
    logger.debug("{}: {}: event={} manager={} operation={} lock={} opTimer={} response={}", 
                $params.getClosedLoopControlName(), drools.getRule().getName(),
                $event, $manager, $operation, $lock, $operation, $opTimer, $response);
    
    //
    // Get the result of the operation
    //
    PolicyResult policyResult = $operation.onResponse($response);
    if (policyResult != null) {
      logger.debug("{}: {}: operation finished - result={}", 
                  $params.getClosedLoopControlName(), drools.getRule().getName(),
                  policyResult);
      
      //
      // This Operation has completed, construct a notification showing our results. (DB write - end operation)
      //
      VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
      notification.setFrom("policy");
      notification.setPolicyName(drools.getRule().getName());
      notification.setPolicyScope("${policyScope}");
      notification.setPolicyVersion("${policyVersion}");
      notification.setMessage($operation.getOperationHistory());
      notification.setHistory($operation.getHistory());
      if (policyResult.equals(PolicyResult.SUCCESS)) {
          notification.setNotification(ControlLoopNotificationType.OPERATION_SUCCESS);
      } else {
          notification.setNotification(ControlLoopNotificationType.OPERATION_FAILURE);
      }
      PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
      //
      // Ensure the operation is complete
      //
      if ($operation.isOperationComplete() == true) {
          //
          // It is complete, remove it from memory
          //
          retract($operation);
          //
          // We must also retract the timer object
          // NOTE: We could write a Rule to do this
          //
          retract($opTimer);
          //
          // Complete the operation
          //
          modify($manager) {finishOperation($operation)};
      } else {
          //
          // Just doing this will kick off the LOCKED rule again
          //
          modify($operation) {};
      }
    } else {
        //
        // Its not finished yet (i.e. expecting more Response objects)
        //
        // Or possibly it is a leftover response that we timed the request out previously
        //
    }
    //
    // We are going to retract these objects from memory
    //
    retract($response);
end

/*
*
* Clean Up any lingering LCM reponses
*
*/
rule "${policyName}.APPC.LCM.RESPONSE.CLEANUP"
    when
        $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
        $response : LcmResponseWrapper($id : getBody().getCommonHeader().getRequestId )
        not ( VirtualControlLoopEvent( requestId == $id, closedLoopEventStatus == ControlLoopEventStatus.ONSET ) ) 
    then
    
    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
    logger.debug("{}: {}: orphan appc response={}", 
                $params.getClosedLoopControlName(), drools.getRule().getName(), $id);
    //
    // Retract it
    //
    retract($response);
end

/*
*
* This rule responds to SO Response Events
*
*/
rule "${policyName}.SO.RESPONSE"
    when
        $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
        $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName(), closedLoopEventStatus == ControlLoopEventStatus.ONSET )
        $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
        $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId() )
        $opTimer : OperationTimer( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString() )
        $lock : TargetLock (requestID == $event.getRequestId())
        $response : SOResponseWrapper(requestID.toString() == $event.getRequestId().toString() )
    then
                
    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
    logger.debug("{}: {}: event={} manager={} operation={} lock={} opTimer={} response={}", 
                $params.getClosedLoopControlName(), drools.getRule().getName(),
                $event, $manager, $operation, $lock, $operation, $opTimer, $response);
        
    // Get the result of the operation
    //
    PolicyResult policyResult = $operation.onResponse($response);
    if (policyResult != null) {
        logger.debug("{}: {}: operation finished - result={}", 
                    $params.getClosedLoopControlName(), drools.getRule().getName(),
                    policyResult);
      
        //
        // This Operation has completed, construct a notification showing our results
        //
        VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
        notification.setFrom("policy");
        notification.setPolicyName(drools.getRule().getName());
        notification.setPolicyScope("${policyScope}");
        notification.setPolicyVersion("${policyVersion}");
        notification.setMessage($operation.getOperationHistory());
        notification.setHistory($operation.getHistory());
        if (policyResult.equals(PolicyResult.SUCCESS)) {
            notification.setNotification(ControlLoopNotificationType.OPERATION_SUCCESS);
        } else {
            notification.setNotification(ControlLoopNotificationType.OPERATION_FAILURE);

        }
        PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
        //
        // Ensure the operation is complete
        //
        if ($operation.isOperationComplete() == true) {
            //
            // It is complete, remove it from memory
            //
            retract($operation);
            //
            // We must also retract the timer object
            // NOTE: We could write a Rule to do this
            //
            retract($opTimer);
            //
            // Complete the operation
            //
            modify($manager) {finishOperation($operation)};
        } else {
            //
            // Just doing this will kick off the LOCKED rule again
            //
            modify($operation) {};
        }
    } else {
        //
        // Its not finished yet (i.e. expecting more Response objects)
        //
        // Or possibly it is a leftover response that we timed the request out previously
        //
    }
    //
    // We are going to retract these objects from memory
    //
    retract($response);

end

/*
*
* This rule responds to VFC Response Events
*
*/
rule "${policyName}.VFC.RESPONSE"
    when
        $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
        $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName(), closedLoopEventStatus == ControlLoopEventStatus.ONSET )
        $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
        $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId() )
        $opTimer : OperationTimer( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString() )
        $lock : TargetLock (requestID == $event.getRequestId())
        $response : VFCResponse( requestId.toString() == $event.getRequestId().toString() ) 
    then
        Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
        logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
        logger.debug("{}: {}: event={} manager={} operation={} lock={} opTimer={} response={}", 
                    $params.getClosedLoopControlName(), drools.getRule().getName(),
                    $event, $manager, $operation, $lock, $operation, $opTimer, $response);
        
        // Get the result of the operation
        //
        PolicyResult policyResult = $operation.onResponse($response);
        if (policyResult != null) {
            //
            // This Operation has completed, construct a notification showing our results
            //
            VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
            notification.setFrom("policy");
            notification.setPolicyName(drools.getRule().getName());
            notification.setPolicyScope("${policyScope}");
            notification.setPolicyVersion("${policyVersion}");
            notification.setMessage($operation.getOperationHistory());
            notification.setHistory($operation.getHistory());
            //
            // Ensure the operation is complete
            //
            if ($operation.isOperationComplete() == true) {
                //
                // It is complete, remove it from memory
                //
                retract($operation);
                //
                // We must also retract the timer object
                // NOTE: We could write a Rule to do this
                //
                retract($opTimer);
                //
                // Complete the operation
                //
                modify($manager) {finishOperation($operation)};
            } else {
                //
                // Just doing this will kick off the LOCKED rule again
                //
                modify($operation) {};
            }
        } else {
            //
            // Its not finished yet (i.e. expecting more Response objects)
            //
            // Or possibly it is a leftover response that we timed the request out previously
            //
        }
        //
        // We are going to retract these objects from memory
        //
        retract($response);

end

/*
*
* This is the timer that manages the timeout for an individual operation.
*
*/
rule "${policyName}.EVENT.MANAGER.OPERATION.TIMEOUT"
    timer (expr: $to )
    when
        $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
        $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName() )
        $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
        $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId() )
        $opTimer : OperationTimer( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString(), $to : getDelay() )
        $lock : TargetLock (requestID == $event.getRequestId())
    then
    
    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
    logger.debug("{}: {}: event={} manager={} operation={} lock={} opTimer={}", 
                $params.getClosedLoopControlName(), drools.getRule().getName(),
                $event, $manager, $operation, $lock, $operation, $opTimer);
    
    //
    // Tell it its timed out
    //
    $operation.setOperationHasTimedOut();
    //
    // Create a notification for it ("DB Write - end operation")
    //
    VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
    notification.setFrom("policy");
    notification.setPolicyName(drools.getRule().getName());
    notification.setPolicyScope("${policyScope}");
    notification.setPolicyVersion("${policyVersion}");
    notification.setNotification(ControlLoopNotificationType.OPERATION_FAILURE);
    notification.setMessage($operation.getOperationHistory());
    notification.setHistory($operation.getHistory());
    //
    // Let interested parties know
    //
    PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
    //
    // Get rid of the timer
    //
    retract($opTimer);
    //
    // Ensure the operation is complete
    //
    if ($operation.isOperationComplete() == true) {
        //
        // It is complete, remove it from memory
        //
        retract($operation);
        //
        // Complete the operation
        //
        modify($manager) {finishOperation($operation)};
    } else {
        //
        // Just doing this will kick off the LOCKED rule again
        //
        modify($operation) {};
    }
end

/*
*
* This is the timer that manages the overall control loop timeout.
*
*/
rule "${policyName}.EVENT.MANAGER.TIMEOUT"
    timer (expr: $to )
    when
        $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
        $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName() )
        $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
        $clTimer : ControlLoopTimer ( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString(), $to : getDelay() )
    then
    
    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());

    logger.debug("{}: {}: event={}", 
              $params.getClosedLoopControlName(), drools.getRule().getName(),
              $event);
    //
    // Tell the Event Manager it has timed out
    //
    VirtualControlLoopNotification notification = $manager.setControlLoopTimedOut();
    if (notification != null) {
        notification.setFrom("policy");
        notification.setPolicyName(drools.getRule().getName());
        notification.setPolicyScope("${policyScope}");
        notification.setPolicyVersion("${policyVersion}");
        //
        // Let interested parties know
        //
        PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
    }
    //
    // Retract the event
    //
    retract($event);
end

/*
*
* This rule cleans up the manager and other objects after an event has
* been retracted.
*
*/
rule "${policyName}.EVENT.MANAGER.CLEANUP"
    when
        $manager : ControlLoopEventManager( $clName : getClosedLoopControlName(), $requestId : getRequestID() )
        $clTimer : ControlLoopTimer ( closedLoopControlName == $clName, requestID == $requestId.toString() )
        $operations : LinkedList()
                        from collect( ControlLoopOperationManager( onset.closedLoopControlName == $clName, onset.getRequestId() == $requestId ) )
        $opTimers : LinkedList()
                        from collect( OperationTimer( closedLoopControlName == $clName, requestID == $requestId.toString() ) )
        $locks : LinkedList()
                        from collect( TargetLock (requestID == $requestId) )
        not( VirtualControlLoopEvent( closedLoopControlName == $clName, requestId == $requestId ) )
    then
    
    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}", $clName, drools.getRule().getName());

    logger.debug("{}: {}: manager={} clTimer={} operations={}", 
              $clName, drools.getRule().getName(),
              $manager, $clTimer, $operations.size());
    
    //
    // Retract EVERYTHING
    //
    retract($manager);
    retract($clTimer);
    
    for(Object manager: $operations) {
        retract((ControlLoopOperationManager) manager);
    }
    for(Object opTimer: $opTimers) {
        retract((OperationTimer) opTimer);
    }
    for(Object lock: $locks) {
        TargetLock tgt = (TargetLock) lock;
        //
        // Ensure we release the lock
        //
        PolicyGuard.unlockTarget(tgt);
        retract(tgt);
    }
end

/*
*
* This rule will clean up any rogue onsets where there is no 
* ControlLoopParams object corresponding to the onset event.
*
*/
rule "${policyName}.EVENT.CLEANUP"
    when
        $event : VirtualControlLoopEvent( $clName: closedLoopControlName )
        not ( Params( getClosedLoopControlName() == $clName) )
    then
 
    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}", $clName, drools.getRule().getName());
    logger.debug("{}: {}: orphan onset event={}", 
                $clName, drools.getRule().getName(), $event);

    retract($event);
end

/*
* Creates a cleaner for every Params object.
* This has a higher salience so that it is fired before PARAMS.FINISHED in ANY policy.
*/
rule "${policyName}.PARAMS.CLEANING"
    salience 2
    when
        $params: Params( )
        ParamsInitCleaner( )
    then
 
    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {} : YAML=[{}]", $params.getClosedLoopControlName(), drools.getRule().getName(),
        $params.getControlLoopYaml());
        
    ParamsCleaner cleaner = new ParamsCleaner();
    cleaner.setClosedLoopControlName($params.getClosedLoopControlName());
    cleaner.setControlLoopYaml($params.getControlLoopYaml());
    insert(cleaner);
end

/*
* Finished creating cleaner objects, so remove the trigger.
* This has a higher salience so that it is fired before processing any events.
*/
rule "${policyName}.PARAMS.FINISHED"
    salience 1
    when
        $initCleaner: ParamsInitCleaner( )
    then
 
    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {}", $initCleaner.getClosedLoopControlName(), drools.getRule().getName());
    
    retract($initCleaner);
end

/*
* Identifies Params objects that are still active, removing their associated cleaners.
* This should only leave one active Params object for each policy.
* This has a higher salience so that it is fired before PARAMS.DELETE in ANY policy.
*/
rule "${policyName}.PARAMS.ACTIVE"
    salience 3
    when
        $params: Params( getClosedLoopControlName() == "${closedLoopControlName}",
                            getControlLoopYaml() == "${controlLoopYaml}" )
        $cleaner: ParamsCleaner( getClosedLoopControlName() == "${closedLoopControlName}",
                            getControlLoopYaml() == "${controlLoopYaml}"  )
    then
 
    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {} : YAML=[{}]", $params.getClosedLoopControlName(), drools.getRule().getName(),
        $params.getControlLoopYaml());
        
    retract($cleaner);
end

/*
* Delete Params objects that are not active (i.e., those that still have an associated
* cleaner object).
* This has a higher salience so that it is fired before PARAMS.CLEANED in ANY policy.
*/
rule "${policyName}.PARAMS.DELETE"
    salience 2
    when
        $params: Params( )
        $cleaner: ParamsCleaner( getClosedLoopControlName() == $params.getClosedLoopControlName(),
                            getControlLoopYaml() == $params.getControlLoopYaml()  )
    then
 
    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {} : YAML=[{}]", $params.getClosedLoopControlName(), drools.getRule().getName(),
        $params.getControlLoopYaml());
        
    retract($params);
end

/*
* Finished clean-up, so delete the cleaner objects.
* This has a higher salience so that it is fired before processing any events.
*/
rule "${policyName}.PARAMS.CLEANED"
    salience 1
    when
        $cleaner: ParamsCleaner( )
    then
 
    Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
    logger.info("{}: {} : YAML=[{}]", $cleaner.getClosedLoopControlName(), drools.getRule().getName(),
        $cleaner.getControlLoopYaml());
        
    retract($cleaner);
end