2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.controlloop;
23 import org.onap.policy.controlloop.VirtualControlLoopEvent;
24 import org.onap.policy.controlloop.VirtualControlLoopNotification;
25 import org.onap.policy.controlloop.ControlLoopEventStatus;
26 import org.onap.policy.controlloop.ControlLoopNotificationType;
27 import org.onap.policy.controlloop.ControlLoopLogger;
28 import org.onap.policy.controlloop.policy.PolicyResult;
29 import org.onap.policy.controlloop.policy.ControlLoopPolicy;
30 import org.onap.policy.controlloop.policy.Policy;
31 import org.onap.policy.controlloop.eventmanager.ControlLoopEventManager;
32 import org.onap.policy.controlloop.eventmanager.ControlLoopEventManager.NEW_EVENT_STATUS;
33 import org.onap.policy.controlloop.eventmanager.ControlLoopOperationManager;
34 import org.onap.policy.controlloop.actor.so.SOActorServiceProvider;
35 import org.onap.policy.appc.Request;
36 import org.onap.policy.appc.Response;
37 import org.onap.policy.appc.CommonHeader;
38 import org.onap.policy.appclcm.LcmRequestWrapper;
39 import org.onap.policy.appclcm.LcmResponseWrapper;
40 import org.onap.policy.appclcm.LcmRequest;
41 import org.onap.policy.appclcm.LcmResponse;
42 import org.onap.policy.appclcm.LcmCommonHeader;
43 import org.onap.policy.vfc.VFCRequest;
44 import org.onap.policy.vfc.VFCResponse;
45 import org.onap.policy.vfc.VFCManager;
46 import org.onap.policy.so.SOManager;
47 import org.onap.policy.so.SORequest;
48 import org.onap.policy.so.SORequestStatus;
49 import org.onap.policy.so.SORequestDetails;
50 import org.onap.policy.so.SOModelInfo;
51 import org.onap.policy.so.SOCloudConfiguration;
52 import org.onap.policy.so.SORequestInfo;
53 import org.onap.policy.so.SORequestParameters;
54 import org.onap.policy.so.SORelatedInstanceListElement;
55 import org.onap.policy.so.SORelatedInstance;
56 import org.onap.policy.so.SOResponse;
57 import org.onap.policy.so.SOResponseWrapper;
58 import org.onap.policy.guard.PolicyGuard;
59 import org.onap.policy.guard.PolicyGuard.LockResult;
60 import org.onap.policy.guard.TargetLock;
61 import org.onap.policy.guard.GuardResult;
62 import org.onap.policy.guard.PolicyGuardRequest;
63 import org.onap.policy.guard.PolicyGuardResponse;
64 import org.onap.policy.guard.PolicyGuardXacmlRequestAttributes;
65 import org.onap.policy.guard.PolicyGuardXacmlHelper;
67 import org.yaml.snakeyaml.Yaml;
68 import org.yaml.snakeyaml.constructor.Constructor;
70 import org.slf4j.LoggerFactory;
71 import org.slf4j.Logger;
73 import java.time.Instant;
74 import java.util.LinkedList;
75 import java.util.Iterator;
77 import org.onap.policy.drools.system.PolicyEngine;
80 * This structure mimics the Params structure.
81 * Its only purpose is to allow management of
82 * rules by the PAP component..
83 * It has no use at runtime since the rules go by
84 * Params for matching purposes.
87 closedLoopControlName : String
88 controlLoopYaml : String
92 * Control Loop Identity
95 closedLoopControlName : String
96 controlLoopYaml : String
100 * Used to clean up Params that no longer have associated rules.
102 declare ParamsCleaner
103 closedLoopControlName : String
104 controlLoopYaml : String
111 declare OperationTimer
112 closedLoopControlName : String
120 declare ControlLoopTimer
121 closedLoopControlName : String
128 * Called once and only once to insert the parameters into working memory for this Closed Loop policy.
129 * This has a higher salience so we can ensure that the Params is created before we have a chance to
130 * discard any events.
133 rule "${policyName}.SETUP"
136 not( Params( getClosedLoopControlName() == "${closedLoopControlName}", getControlLoopYaml() == "${controlLoopYaml}" ) )
139 Params params = new Params();
140 params.setClosedLoopControlName("${closedLoopControlName}");
141 params.setControlLoopYaml("${controlLoopYaml}");
144 // Note: globals have bad behavior when persistence is used,
145 // hence explicitly getting the logger vs using a global
147 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
148 logger.info("{}: {} : YAML=[{}]", params.getClosedLoopControlName(), drools.getRule().getName(), params.getControlLoopYaml());
153 * This rule responds to DCAE Events where there is no manager yet. Either it is
154 * the first ONSET, or a subsequent badly formed Event (i.e. Syntax error, or is-closed-loop-disabled)
157 rule "${policyName}.EVENT"
159 $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
160 $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName() )
161 not ( ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() ) )
164 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
165 logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
170 // Check the event, because we need it to not be null when
171 // we create the ControlLoopEventManager. The ControlLoopEventManager
172 // will do extra syntax checking as well check if the closed loop is disabled.
174 if ($event.getRequestId() == null) {
175 VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
176 notification.setNotification(ControlLoopNotificationType.REJECTED);
177 notification.setFrom("policy");
178 notification.setMessage("Missing requestId");
179 notification.setPolicyName(drools.getRule().getName());
180 notification.setPolicyScope("${policyScope}");
181 notification.setPolicyVersion("${policyVersion}");
184 // Let interested parties know
186 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
189 // Retract it from memory
192 } else if ($event.getClosedLoopEventStatus() != ControlLoopEventStatus.ONSET) {
193 throw new ControlLoopException($event.getClosedLoopEventStatus() + " received with no prior onset");
196 // Create an EventManager
198 ControlLoopEventManager manager = new ControlLoopEventManager($params.getClosedLoopControlName(), $event.getRequestId());
200 // Determine if EventManager can actively process the event (i.e. syntax, is_closed_loop_disabled checks etc.)
202 VirtualControlLoopNotification notification = manager.activate($params.getControlLoopYaml(), $event);
203 notification.setFrom("pdp-0001-controller=controlloop"); // Engine.getInstanceName()
204 notification.setPolicyName(drools.getRule().getName());
205 notification.setPolicyScope("${policyScope}");
206 notification.setPolicyVersion("${policyVersion}");
208 // Are we actively pursuing this event?
210 if (notification.getNotification() == ControlLoopNotificationType.ACTIVE) {
212 // Insert Event Manager into memory, this will now kick off processing.
216 // Let interested parties know
218 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
220 // Setup the Overall Control Loop timer
222 ControlLoopTimer clTimer = new ControlLoopTimer();
223 clTimer.setClosedLoopControlName($event.getClosedLoopControlName());
224 clTimer.setRequestID($event.getRequestId().toString());
225 clTimer.setDelay(manager.getControlLoopTimeout(1500) + "s");
232 // Let interested parties know
234 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
236 // Retract it from memory
242 // Now that the manager is inserted into Drools working memory, we'll wait for
243 // another rule to fire in order to continue processing. This way we can also
244 // then screen for additional ONSET and ABATED events for this RequestId.
247 } catch (Exception e) {
248 logger.warn("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName(), e);
250 VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
251 notification.setNotification(ControlLoopNotificationType.REJECTED);
252 notification.setMessage("Exception occurred: " + e.getMessage());
253 notification.setPolicyName(drools.getRule().getName());
254 notification.setPolicyScope("${policyScope}");
255 notification.setPolicyVersion("${policyVersion}");
259 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
269 * This rule happens when we got a valid ONSET, closed loop is enabled and an Event Manager
270 * is now created. We can start processing the yaml specification via the Event Manager.
273 rule "${policyName}.EVENT.MANAGER"
275 $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
276 $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName() )
277 $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
278 $clTimer : ControlLoopTimer ( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString() )
281 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
282 logger.info("{}: {}: event={} manager={} clTimer={}",
283 $params.getClosedLoopControlName(), drools.getRule().getName(),
284 $event, $manager, $clTimer);
288 // Check which event this is.
290 ControlLoopEventManager.NEW_EVENT_STATUS eventStatus = $manager.onNewEvent($event);
292 // Check what kind of event this is
294 if (eventStatus == NEW_EVENT_STATUS.SUBSEQUENT_ONSET) {
296 // We don't care about subsequent onsets
298 logger.info("{}: {}: subsequent onset",
299 $params.getClosedLoopControlName(), drools.getRule().getName());
303 if (eventStatus == NEW_EVENT_STATUS.SYNTAX_ERROR) {
305 // Ignore any bad syntax events
307 logger.warn("{}: {}: syntax error",
308 $params.getClosedLoopControlName(), drools.getRule().getName());
313 // We only want the initial ONSET event in memory,
314 // all the other events need to be retracted to support
315 // cleanup and avoid the other rules being fired for this event.
317 if (eventStatus != NEW_EVENT_STATUS.FIRST_ONSET) {
318 logger.warn("{}: {}: not first onset",
319 $params.getClosedLoopControlName(), drools.getRule().getName());
323 logger.debug("{}: {}: target={}", $params.getClosedLoopControlName(),
324 drools.getRule().getName(), $event.getTarget());
326 // Now start seeing if we need to process this event
330 // Check if this is a Final Event
332 VirtualControlLoopNotification notification = $manager.isControlLoopFinal();
335 if (notification != null) {
337 // Its final, but are we waiting for abatement?
339 if ($manager.getNumAbatements() > 0) {
340 logger.info("{}: {}: abatement received for {}. Closing the control loop",
341 $params.getClosedLoopControlName(), drools.getRule().getName(),
342 $event.getRequestId());
343 notification.setFrom("policy");
344 notification.setPolicyName(drools.getRule().getName());
345 notification.setPolicyScope("${policyScope}");
346 notification.setPolicyVersion("${policyVersion}");
348 // In this case, we are done
350 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
354 TargetLock lock = $manager.unlockCurrentOperation();
356 logger.debug("{}: {}: retracting lock=", $params.getClosedLoopControlName(),
357 drools.getRule().getName(), lock);
361 // Retract everything from memory
363 logger.info("{}: {}: retracting onset, manager, and timer",
364 $params.getClosedLoopControlName(), drools.getRule().getName());
366 retract($manager.getOnsetEvent());
370 // TODO - what if we get subsequent Events for this RequestId?
371 // By default, it will all start over again. May be confusing for Ruby.
372 // Or, we could track this and then subsequently ignore the events
376 // Check whether we need to wait for abatement
378 if ($manager.getProcessor().getControlLoop().getAbatement() == true && notification.getNotification() == ControlLoopNotificationType.FINAL_SUCCESS) {
379 logger.info("{}: {}: waiting for abatement ..",
380 $params.getClosedLoopControlName(), drools.getRule().getName());
382 logger.info("{}: {}: no abatement expect for {}. Closing the control loop",
383 $params.getClosedLoopControlName(), drools.getRule().getName(),
384 $event.getRequestId());
386 notification.setFrom("policy");
387 notification.setPolicyName(drools.getRule().getName());
388 notification.setPolicyScope("${policyScope}");
389 notification.setPolicyVersion("${policyVersion}");
392 // In this case, we are done
394 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
398 TargetLock lock = $manager.unlockCurrentOperation();
400 logger.debug("{}: {}: retracting lock=", $params.getClosedLoopControlName(),
401 drools.getRule().getName(), lock);
405 // Retract everything from memory
407 logger.info("{}: {}: retracting onset, manager, and timer",
408 $params.getClosedLoopControlName(), drools.getRule().getName());
410 retract($manager.getOnsetEvent());
417 // NOT final, so let's ask for the next operation
419 ControlLoopOperationManager operation = $manager.processControlLoop();
420 if (operation != null) {
422 // Let's ask for a lock right away
424 LockResult<GuardResult, TargetLock> result = $manager.lockCurrentOperation();
425 logger.info("{}: {}: guard lock acquired={}",
426 $params.getClosedLoopControlName(), drools.getRule().getName(),
428 if (result.getA().equals(GuardResult.LOCK_ACQUIRED)) {
430 // insert the operation into memory
435 // insert operation timeout object
437 OperationTimer opTimer = new OperationTimer();
438 opTimer.setClosedLoopControlName($event.getClosedLoopControlName());
439 opTimer.setRequestID($event.getRequestId().toString());
440 opTimer.setDelay(operation.getOperationTimeout().toString() + "s");
444 // Insert lock into memory
446 insert(result.getB());
449 logger.debug("The target resource {} is already processing",
450 $event.getAai().get($event.getTarget()));
451 notification = new VirtualControlLoopNotification($event);
452 notification.setNotification(ControlLoopNotificationType.REJECTED);
453 notification.setMessage("The target " + $event.getAai().get($event.getTarget()) + " is already locked");
454 notification.setFrom("policy");
455 notification.setPolicyName(drools.getRule().getName());
456 notification.setPolicyScope("${policyScope}");
457 notification.setPolicyVersion("${policyVersion}");
459 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
465 if(result.getB() != null) {
466 retract(result.getB());
469 logger.info("{}: {}: starting operation={}",
470 $params.getClosedLoopControlName(), drools.getRule().getName(),
474 // Probably waiting for abatement
476 logger.info("{}: {}: no operation, probably waiting for abatement",
477 $params.getClosedLoopControlName(), drools.getRule().getName());
480 } catch (Exception e) {
481 logger.warn("{}: {}: unexpected",
482 $params.getClosedLoopControlName(),
483 drools.getRule().getName(), e);
485 VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
486 notification.setNotification(ControlLoopNotificationType.FINAL_FAILURE);
487 notification.setMessage(e.getMessage());
488 notification.setFrom("policy");
489 notification.setPolicyName(drools.getRule().getName());
490 notification.setPolicyScope("${policyScope}");
491 notification.setPolicyVersion("${policyVersion}");
493 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
504 * Guard Permitted, let's send request to the actor.
507 rule "${policyName}.EVENT.MANAGER.OPERATION.LOCKED.GUARD_PERMITTED"
509 $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
510 $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName() )
511 $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
512 $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId(), "Permit".equalsIgnoreCase(getGuardApprovalStatus()) )
513 $lock : TargetLock (requestID == $event.getRequestId())
514 $opTimer : OperationTimer( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString() )
517 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
518 logger.info("{}: {}: event={} manager={} operation={} lock={}",
519 $params.getClosedLoopControlName(), drools.getRule().getName(),
520 $event, $manager, $operation, $lock);
522 Object request = null;
523 boolean caughtException = false;
525 request = $operation.startOperation($event);
527 catch (ControlLoopException e) {
528 String msg = e.getMessage();
529 logger.warn("{}: {}: operation={}: AAI failure: {}",
530 $params.getClosedLoopControlName(), drools.getRule().getName(),
532 $operation.setOperationHasException(msg);
535 caughtException = true;
538 // Having the modify statement in the catch clause doesn't work for whatever reason
539 if (caughtException) {
540 modify($manager) {finishOperation($operation)};
542 else if (request != null) {
543 logger.debug("{}: {}: starting operation ..",
544 $params.getClosedLoopControlName(), drools.getRule().getName());
546 // Tell interested parties we are performing this Operation
548 VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
549 notification.setNotification(ControlLoopNotificationType.OPERATION);
550 notification.setMessage($operation.getOperationMessage());
551 notification.setHistory($operation.getHistory());
552 notification.setFrom("policy");
553 notification.setPolicyName(drools.getRule().getName());
554 notification.setPolicyScope("${policyScope}");
555 notification.setPolicyVersion("${policyVersion}");
557 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
559 switch ($operation.policy.getActor()){
563 if (request instanceof Request) {
564 PolicyEngine.manager.deliver("APPC-CL", request);
566 else if (request instanceof LcmRequestWrapper) {
567 PolicyEngine.manager.deliver("APPC-LCM-READ", request);
571 // at this point the AAI named query request should have already been made, the response recieved and used
572 // in the construction of the SO Request which is stored in operationRequest
574 if(request instanceof SORequest) {
575 // Call SO. The response will be inserted into memory once it's received
576 SOActorServiceProvider.sendRequest($event.getRequestId().toString(), drools.getWorkingMemory(), request);
580 if (request instanceof VFCRequest) {
582 Thread t = new Thread(new VFCManager(drools.getWorkingMemory(), (VFCRequest)request));
589 // What happens if its null?
591 logger.warn("{}: {}: unexpected null operation request",
592 $params.getClosedLoopControlName(),
593 drools.getRule().getName());
594 if ("SO".equals($operation.policy.getActor())) {
597 modify($manager) {finishOperation($operation)};
599 else if ("vfc".equalsIgnoreCase($operation.policy.getActor())) {
602 modify($manager) {finishOperation($operation)};
611 * We were able to acquire a lock so now let's ask Xacml Guard whether
612 * we are allowed to proceed with the request to the actor.
615 rule "${policyName}.EVENT.MANAGER.OPERATION.LOCKED.GUARD_NOT_YET_QUERIED"
617 $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
618 $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName() )
619 $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
620 $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId(), getGuardApprovalStatus() == "NONE" )
621 $lock : TargetLock (requestID == $event.getRequestId())
624 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
625 logger.info("{}: {}: event={} manager={} operation={} lock={}",
626 $params.getClosedLoopControlName(), drools.getRule().getName(),
627 $event, $manager, $operation, $lock);
630 // Sending notification that we are about to query Guard ("DB write - start operation")
632 VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
633 notification.setNotification(ControlLoopNotificationType.OPERATION);
634 notification.setMessage("Sending guard query for " + $operation.policy.getActor() + " " + $operation.policy.getRecipe());
635 notification.setHistory($operation.getHistory());
636 notification.setFrom("policy");
637 notification.setPolicyName(drools.getRule().getName());
638 notification.setPolicyScope("${policyScope}");
639 notification.setPolicyVersion("${policyVersion}");
641 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
644 // Now send Guard Request to XACML Guard. In order to bypass the call to Guard,
645 // just change guardEnabled to false.
647 // In order to use REST XACML, provide a URL instead of "" as a second argument
648 // to the CallGuardTask() and set the first argument to null
649 // (instead of XacmlPdpEngine).
652 // NOTE: The environment properties uses "guard.disabled" but the boolean is guardEnabled
653 boolean guardEnabled = "false".equalsIgnoreCase(PolicyEngine.manager.getEnvironmentProperty("guard.disabled"));
657 Thread t = new Thread(new org.onap.policy.guard.CallGuardTask(
658 drools.getWorkingMemory(),
659 $event.getClosedLoopControlName(),
660 $operation.policy.getActor().toString(),
661 $operation.policy.getRecipe(),
662 $operation.getTargetEntity(),
663 $event.getRequestId().toString()
668 insert(new PolicyGuardResponse("Permit", $event.getRequestId(), $operation.policy.getRecipe()));
674 // This rule will be triggered when a thread talking to the XACML Guard inserts a
675 // guardResponse object into the working memory
677 rule "${policyName}.GUARD.RESPONSE"
679 $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
680 $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName(), closedLoopEventStatus == ControlLoopEventStatus.ONSET )
681 $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
682 $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId() )
683 $lock : TargetLock (requestID == $event.getRequestId())
684 $opTimer : OperationTimer( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString() )
685 $guardResponse : PolicyGuardResponse(requestID == $event.getRequestId(), $operation.policy.recipe == operation)
688 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
689 logger.info("{}: {}: event={} manager={} operation={} lock={} opTimer={} guardResponse={}",
690 $params.getClosedLoopControlName(), drools.getRule().getName(),
691 $event, $manager, $operation, $lock, $opTimer, $guardResponse);
694 //we will permit the operation if there was no Guard for it
695 if("Indeterminate".equalsIgnoreCase($guardResponse.getResult())){
696 $guardResponse.setResult("Permit");
700 // This notification has Guard result in "message". ("DB write - end operation in case of Guard Deny")
702 VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
703 notification.setNotification(ControlLoopNotificationType.OPERATION);
704 notification.setMessage("Guard result for " + $operation.policy.getActor() + " " + $operation.policy.getRecipe() + " is " + $guardResponse.getResult());
705 notification.setHistory($operation.getHistory());
706 notification.setFrom("policy");
707 notification.setPolicyName(drools.getRule().getName());
708 notification.setPolicyScope("${policyScope}");
709 notification.setPolicyVersion("${policyVersion}");
711 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
713 if("Permit".equalsIgnoreCase($guardResponse.getResult())){
715 modify($operation){setGuardApprovalStatus($guardResponse.getResult())};
718 //This is the Deny case
719 $operation.startOperation($event);
720 $operation.setOperationHasGuardDeny();
723 modify($manager) {finishOperation($operation)};
726 retract($guardResponse);
732 * This rule responds to APPC Response Events
734 * I would have like to be consistent and write the Response like this:
735 * $response : Response( CommonHeader.RequestId == $onset.getRequestId() )
737 * However, no compile error was given. But a runtime error was given. I think
738 * because drools is confused between the classname CommonHeader vs the property CommonHeader.
741 rule "${policyName}.APPC.RESPONSE"
743 $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
744 $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName(), closedLoopEventStatus == ControlLoopEventStatus.ONSET )
745 $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
746 $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId() )
747 $opTimer : OperationTimer( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString() )
748 $lock : TargetLock (requestID == $event.getRequestId())
749 $response : Response( getCommonHeader().RequestId == $event.getRequestId() )
752 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
753 logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
754 logger.debug("{}: {}: event={} manager={} operation={} lock={} opTimer={} response={}",
755 $params.getClosedLoopControlName(), drools.getRule().getName(),
756 $event, $manager, $operation, $lock, $opTimer, $response);
758 // Get the result of the operation
760 PolicyResult policyResult = $operation.onResponse($response);
761 if (policyResult != null) {
762 logger.debug("{}: {}: operation finished - result={}",
763 $params.getClosedLoopControlName(), drools.getRule().getName(),
766 // This Operation has completed, construct a notification showing our results. (DB write - end operation)
768 VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
769 notification.setFrom("policy");
770 notification.setPolicyName(drools.getRule().getName());
771 notification.setPolicyScope("${policyScope}");
772 notification.setPolicyVersion("${policyVersion}");
773 notification.setMessage($operation.getOperationHistory());
774 notification.setHistory($operation.getHistory());
775 if (policyResult.equals(PolicyResult.SUCCESS)) {
776 notification.setNotification(ControlLoopNotificationType.OPERATION_SUCCESS);
778 // Let interested parties know
780 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
782 notification.setNotification(ControlLoopNotificationType.OPERATION_FAILURE);
784 // Let interested parties know
786 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
789 // Ensure the operation is complete
791 if ($operation.isOperationComplete() == true) {
793 // It is complete, remove it from memory
797 // We must also retract the timer object
798 // NOTE: We could write a Rule to do this
802 // Complete the operation
804 modify($manager) {finishOperation($operation)};
807 // Just doing this will kick off the LOCKED rule again
809 modify($operation) {};
813 // Its not finished yet (i.e. expecting more Response objects)
815 // Or possibly it is a leftover response that we timed the request out previously
819 // We are going to retract these objects from memory
826 * The problem with Responses is that they don't have a controlLoopControlName
827 * field in them, so the only way to attach them is via RequestId. If we have multiple
828 * control loop .drl's loaded in the same container, we need to be sure the cleanup
829 * rules don't remove Responses for other control loops.
832 rule "${policyName}.APPC.RESPONSE.CLEANUP"
834 $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
835 $response : Response($id : getCommonHeader().RequestId )
836 not ( VirtualControlLoopEvent( requestId == $id, closedLoopEventStatus == ControlLoopEventStatus.ONSET ) )
839 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
840 logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
841 logger.debug("{}: {}: orphan appc response={}",
842 $params.getClosedLoopControlName(), drools.getRule().getName(), $id);
852 * This rule responds to APPC Response Events using the new LCM interface provided by appc
855 rule "${policyName}.APPC.LCM.RESPONSE"
857 $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
858 $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName(), closedLoopEventStatus == ControlLoopEventStatus.ONSET )
859 $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
860 $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId() )
861 $opTimer : OperationTimer( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString() )
862 $lock : TargetLock (requestID == $event.getRequestId())
863 $response : LcmResponseWrapper( getBody().getCommonHeader().getRequestId() == $event.getRequestId() )
866 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
867 logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
868 logger.debug("{}: {}: event={} manager={} operation={} lock={} opTimer={} response={}",
869 $params.getClosedLoopControlName(), drools.getRule().getName(),
870 $event, $manager, $operation, $lock, $operation, $opTimer, $response);
873 // Get the result of the operation
875 PolicyResult policyResult = $operation.onResponse($response);
876 if (policyResult != null) {
877 logger.debug("{}: {}: operation finished - result={}",
878 $params.getClosedLoopControlName(), drools.getRule().getName(),
882 // This Operation has completed, construct a notification showing our results. (DB write - end operation)
884 VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
885 notification.setFrom("policy");
886 notification.setPolicyName(drools.getRule().getName());
887 notification.setPolicyScope("${policyScope}");
888 notification.setPolicyVersion("${policyVersion}");
889 notification.setMessage($operation.getOperationHistory());
890 notification.setHistory($operation.getHistory());
891 if (policyResult.equals(PolicyResult.SUCCESS)) {
892 notification.setNotification(ControlLoopNotificationType.OPERATION_SUCCESS);
894 notification.setNotification(ControlLoopNotificationType.OPERATION_FAILURE);
896 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
898 // Ensure the operation is complete
900 if ($operation.isOperationComplete() == true) {
902 // It is complete, remove it from memory
906 // We must also retract the timer object
907 // NOTE: We could write a Rule to do this
911 // Complete the operation
913 modify($manager) {finishOperation($operation)};
916 // Just doing this will kick off the LOCKED rule again
918 modify($operation) {};
922 // Its not finished yet (i.e. expecting more Response objects)
924 // Or possibly it is a leftover response that we timed the request out previously
928 // We are going to retract these objects from memory
935 * Clean Up any lingering LCM reponses
938 rule "${policyName}.APPC.LCM.RESPONSE.CLEANUP"
940 $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
941 $response : LcmResponseWrapper($id : getBody().getCommonHeader().getRequestId )
942 not ( VirtualControlLoopEvent( requestId == $id, closedLoopEventStatus == ControlLoopEventStatus.ONSET ) )
945 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
946 logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
947 logger.debug("{}: {}: orphan appc response={}",
948 $params.getClosedLoopControlName(), drools.getRule().getName(), $id);
957 * This rule responds to SO Response Events
960 rule "${policyName}.SO.RESPONSE"
962 $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
963 $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName(), closedLoopEventStatus == ControlLoopEventStatus.ONSET )
964 $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
965 $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId() )
966 $opTimer : OperationTimer( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString() )
967 $lock : TargetLock (requestID == $event.getRequestId())
968 $response : SOResponseWrapper(requestID.toString() == $event.getRequestId().toString() )
971 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
972 logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
973 logger.debug("{}: {}: event={} manager={} operation={} lock={} opTimer={} response={}",
974 $params.getClosedLoopControlName(), drools.getRule().getName(),
975 $event, $manager, $operation, $lock, $operation, $opTimer, $response);
977 // Get the result of the operation
979 PolicyResult policyResult = $operation.onResponse($response);
980 if (policyResult != null) {
981 logger.debug("{}: {}: operation finished - result={}",
982 $params.getClosedLoopControlName(), drools.getRule().getName(),
986 // This Operation has completed, construct a notification showing our results
988 VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
989 notification.setFrom("policy");
990 notification.setPolicyName(drools.getRule().getName());
991 notification.setPolicyScope("${policyScope}");
992 notification.setPolicyVersion("${policyVersion}");
993 notification.setMessage($operation.getOperationHistory());
994 notification.setHistory($operation.getHistory());
995 if (policyResult.equals(PolicyResult.SUCCESS)) {
996 notification.setNotification(ControlLoopNotificationType.OPERATION_SUCCESS);
998 notification.setNotification(ControlLoopNotificationType.OPERATION_FAILURE);
1001 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
1003 // Ensure the operation is complete
1005 if ($operation.isOperationComplete() == true) {
1007 // It is complete, remove it from memory
1009 retract($operation);
1011 // We must also retract the timer object
1012 // NOTE: We could write a Rule to do this
1016 // Complete the operation
1018 modify($manager) {finishOperation($operation)};
1021 // Just doing this will kick off the LOCKED rule again
1023 modify($operation) {};
1027 // Its not finished yet (i.e. expecting more Response objects)
1029 // Or possibly it is a leftover response that we timed the request out previously
1033 // We are going to retract these objects from memory
1041 * This rule responds to VFC Response Events
1044 rule "${policyName}.VFC.RESPONSE"
1046 $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
1047 $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName(), closedLoopEventStatus == ControlLoopEventStatus.ONSET )
1048 $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
1049 $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId() )
1050 $opTimer : OperationTimer( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString() )
1051 $lock : TargetLock (requestID == $event.getRequestId())
1052 $response : VFCResponse( requestId.toString() == $event.getRequestId().toString() )
1054 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
1055 logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
1056 logger.debug("{}: {}: event={} manager={} operation={} lock={} opTimer={} response={}",
1057 $params.getClosedLoopControlName(), drools.getRule().getName(),
1058 $event, $manager, $operation, $lock, $operation, $opTimer, $response);
1060 // Get the result of the operation
1062 PolicyResult policyResult = $operation.onResponse($response);
1063 if (policyResult != null) {
1065 // This Operation has completed, construct a notification showing our results
1067 VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
1068 notification.setFrom("policy");
1069 notification.setPolicyName(drools.getRule().getName());
1070 notification.setPolicyScope("${policyScope}");
1071 notification.setPolicyVersion("${policyVersion}");
1072 notification.setMessage($operation.getOperationHistory());
1073 notification.setHistory($operation.getHistory());
1075 // Ensure the operation is complete
1077 if ($operation.isOperationComplete() == true) {
1079 // It is complete, remove it from memory
1081 retract($operation);
1083 // We must also retract the timer object
1084 // NOTE: We could write a Rule to do this
1088 // Complete the operation
1090 modify($manager) {finishOperation($operation)};
1093 // Just doing this will kick off the LOCKED rule again
1095 modify($operation) {};
1099 // Its not finished yet (i.e. expecting more Response objects)
1101 // Or possibly it is a leftover response that we timed the request out previously
1105 // We are going to retract these objects from memory
1113 * This is the timer that manages the timeout for an individual operation.
1116 rule "${policyName}.EVENT.MANAGER.OPERATION.TIMEOUT"
1119 $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
1120 $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName() )
1121 $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
1122 $operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.getClosedLoopControlName(), onset.getRequestId() == $event.getRequestId() )
1123 $opTimer : OperationTimer( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString(), $to : getDelay() )
1124 $lock : TargetLock (requestID == $event.getRequestId())
1127 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
1128 logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
1129 logger.debug("{}: {}: event={} manager={} operation={} lock={} opTimer={}",
1130 $params.getClosedLoopControlName(), drools.getRule().getName(),
1131 $event, $manager, $operation, $lock, $operation, $opTimer);
1134 // Tell it its timed out
1136 $operation.setOperationHasTimedOut();
1138 // Create a notification for it ("DB Write - end operation")
1140 VirtualControlLoopNotification notification = new VirtualControlLoopNotification($event);
1141 notification.setFrom("policy");
1142 notification.setPolicyName(drools.getRule().getName());
1143 notification.setPolicyScope("${policyScope}");
1144 notification.setPolicyVersion("${policyVersion}");
1145 notification.setNotification(ControlLoopNotificationType.OPERATION_FAILURE);
1146 notification.setMessage($operation.getOperationHistory());
1147 notification.setHistory($operation.getHistory());
1149 // Let interested parties know
1151 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
1153 // Get rid of the timer
1157 // Ensure the operation is complete
1159 if ($operation.isOperationComplete() == true) {
1161 // It is complete, remove it from memory
1163 retract($operation);
1165 // Complete the operation
1167 modify($manager) {finishOperation($operation)};
1170 // Just doing this will kick off the LOCKED rule again
1172 modify($operation) {};
1178 * This is the timer that manages the overall control loop timeout.
1181 rule "${policyName}.EVENT.MANAGER.TIMEOUT"
1184 $params : Params( getClosedLoopControlName() == "${closedLoopControlName}" )
1185 $event : VirtualControlLoopEvent( closedLoopControlName == $params.getClosedLoopControlName() )
1186 $manager : ControlLoopEventManager( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId() )
1187 $clTimer : ControlLoopTimer ( closedLoopControlName == $event.getClosedLoopControlName(), requestID == $event.getRequestId().toString(), $to : getDelay() )
1190 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
1191 logger.info("{}: {}", $params.getClosedLoopControlName(), drools.getRule().getName());
1193 logger.debug("{}: {}: event={}",
1194 $params.getClosedLoopControlName(), drools.getRule().getName(),
1197 // Tell the Event Manager it has timed out
1199 VirtualControlLoopNotification notification = $manager.setControlLoopTimedOut();
1200 if (notification != null) {
1201 notification.setFrom("policy");
1202 notification.setPolicyName(drools.getRule().getName());
1203 notification.setPolicyScope("${policyScope}");
1204 notification.setPolicyVersion("${policyVersion}");
1206 // Let interested parties know
1208 PolicyEngine.manager.deliver("POLICY-CL-MGT", notification);
1211 // Retract the event
1218 * This rule cleans up the manager and other objects after an event has
1222 rule "${policyName}.EVENT.MANAGER.CLEANUP"
1224 $manager : ControlLoopEventManager( $clName : getClosedLoopControlName(), $requestId : getRequestID() )
1225 $clTimer : ControlLoopTimer ( closedLoopControlName == $clName, requestID == $requestId.toString() )
1226 $operations : LinkedList()
1227 from collect( ControlLoopOperationManager( onset.closedLoopControlName == $clName, onset.getRequestId() == $requestId ) )
1228 $opTimers : LinkedList()
1229 from collect( OperationTimer( closedLoopControlName == $clName, requestID == $requestId.toString() ) )
1230 $locks : LinkedList()
1231 from collect( TargetLock (requestID == $requestId) )
1232 not( VirtualControlLoopEvent( closedLoopControlName == $clName, requestId == $requestId ) )
1235 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
1236 logger.info("{}: {}", $clName, drools.getRule().getName());
1238 logger.debug("{}: {}: manager={} clTimer={} operations={}",
1239 $clName, drools.getRule().getName(),
1240 $manager, $clTimer, $operations.size());
1243 // Retract EVERYTHING
1248 for(Object manager: $operations) {
1249 retract((ControlLoopOperationManager) manager);
1251 for(Object opTimer: $opTimers) {
1252 retract((OperationTimer) opTimer);
1254 for(Object lock: $locks) {
1255 TargetLock tgt = (TargetLock) lock;
1257 // Ensure we release the lock
1259 PolicyGuard.unlockTarget(tgt);
1266 * This rule will clean up any rogue onsets where there is no
1267 * ControlLoopParams object corresponding to the onset event.
1270 rule "${policyName}.EVENT.CLEANUP"
1272 $event : VirtualControlLoopEvent( $clName: closedLoopControlName )
1273 not ( Params( getClosedLoopControlName() == $clName) )
1276 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
1277 logger.info("{}: {}", $clName, drools.getRule().getName());
1278 logger.debug("{}: {}: orphan onset event={}",
1279 $clName, drools.getRule().getName(), $event);
1286 * When rules are deleted, the associated Params (and its subordinate objects)
1287 * remain in working memory, because there are no longer any rules to clean
1288 * them up. However, ANY time new rules are loaded, this rule will trigger
1289 * a clean-up of ALL Params, regardless of their name & yaml, thus removing
1290 * any that no longer have associated rules.
1291 * This has a higher salience so that we immediately check Params when the
1292 * rules change, before processing any events.
1295 rule "${policyName}.PARAMS.CHECKUP"
1298 Params( $clName: closedLoopControlName, $yaml: controlLoopYaml )
1301 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
1302 logger.info("{}: {} : YAML=[{}]", $clName, drools.getRule().getName(), $yaml);
1304 ParamsCleaner cleaner = new ParamsCleaner();
1305 cleaner.setClosedLoopControlName($clName);
1306 cleaner.setControlLoopYaml($yaml);
1313 * This rule removes "cleaner" objects for rules that are still active, thus
1314 * preventing the associated Params objects from being removed. Any cleaners
1315 * that are left after this rule has fired will cause their corresponding Params
1317 * This has a higher salience so that we discard the cleaner before it has
1318 * a chance to force the removal of the associated Params.
1321 rule "${policyName}.CLEANER.ACTIVE"
1324 $cleaner: ParamsCleaner( getClosedLoopControlName() == "${closedLoopControlName}", getControlLoopYaml() == "${controlLoopYaml}" )
1327 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
1328 logger.info("{}: {} : YAML=[{}]", $cleaner.getClosedLoopControlName(), drools.getRule().getName(), $cleaner.getControlLoopYaml());
1335 * This rule removes Params objects that no longer have associated rules; if a
1336 * Params still had associated rules, then the cleaner would have been removed
1337 * by those rules and thus this rule would not fire.
1338 * This has a higher salience so that we remove old Params before it causes any
1339 * events to be processed.
1342 rule "${policyName}.PARAMS.CLEANUP"
1345 $params: Params( $clName: closedLoopControlName, $yaml: controlLoopYaml )
1346 ParamsCleaner( getClosedLoopControlName() == $clName, getControlLoopYaml() == $yaml )
1349 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
1350 logger.info("{}: {} : YAML=[{}]", $params.getClosedLoopControlName(), drools.getRule().getName(), $params.getControlLoopYaml());
1354 // Note: the cleaner may be needed for cleaning additional params, thus
1355 // we do not retract it here - we'll leave that to another rule
1360 * This rule removes "cleaner" objects when they're no longer needed.
1363 rule "${policyName}.CLEANER.CLEANUP"
1365 $cleaner: ParamsCleaner( )
1368 Logger logger = LoggerFactory.getLogger(drools.getRule().getPackage());
1369 logger.info("{}: {} : YAML=[{}]", $cleaner.getClosedLoopControlName(), drools.getRule().getName(), $cleaner.getControlLoopYaml());