models-interactions/model-yaml/src/main/java/org/onap/policy/controlloop/compiler/ControlLoopCompiler.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * policy-yaml
   4  * ================================================================================
   5  * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2019 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.controlloop.compiler;
  23
  24 import com.google.common.collect.ImmutableList;
  25 import com.google.common.collect.ImmutableMap;
  26
  27 import java.io.InputStream;
  28 import java.io.Serializable;
  29 import java.util.Collections;
  30 import java.util.HashMap;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Map.Entry;
  34 import org.apache.commons.lang3.StringUtils;
  35 import org.jgrapht.DirectedGraph;
  36 import org.jgrapht.graph.ClassBasedEdgeFactory;
  37 import org.jgrapht.graph.DefaultEdge;
  38 import org.jgrapht.graph.DirectedMultigraph;
  39 import org.onap.policy.controlloop.policy.ControlLoop;
  40 import org.onap.policy.controlloop.policy.ControlLoopPolicy;
  41 import org.onap.policy.controlloop.policy.FinalResult;
  42 import org.onap.policy.controlloop.policy.Policy;
  43 import org.onap.policy.controlloop.policy.PolicyResult;
  44 import org.onap.policy.controlloop.policy.TargetType;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47 import org.yaml.snakeyaml.Yaml;
  48 import org.yaml.snakeyaml.constructor.Constructor;
  49
  50
  51 public class ControlLoopCompiler implements Serializable {
  52     private static final String OPERATION_POLICY = "Operation Policy ";
  53     private static final long serialVersionUID = 1L;
  54     private static final Logger LOGGER = LoggerFactory.getLogger(ControlLoopCompiler.class.getName());
  55
  56     /**
  57      * Compiles the policy from an object.
  58      */
  59     public static ControlLoopPolicy compile(ControlLoopPolicy policy,
  60                     ControlLoopCompilerCallback callback) throws CompilerException {
  61         //
  62         // Ensure the control loop is sane
  63         //
  64         validateControlLoop(policy.getControlLoop(), callback);
  65         //
  66         // Validate the policies
  67         //
  68         validatePolicies(policy, callback);
  69
  70         return policy;
  71     }
  72
  73     /**
  74      * Compiles the policy from an input stream.
  75      *
  76      * @param yamlSpecification the yaml input stream
  77      * @param callback method to callback during compilation
  78      * @return Control Loop object
  79      * @throws CompilerException throws any compile exception found
  80      */
  81     public static ControlLoopPolicy compile(InputStream yamlSpecification,
  82                     ControlLoopCompilerCallback callback) throws CompilerException {
  83         Yaml yaml = new Yaml(new Constructor(ControlLoopPolicy.class));
  84         Object obj = yaml.load(yamlSpecification);
  85         if (obj == null) {
  86             throw new CompilerException("Could not parse yaml specification.");
  87         }
  88         if (! (obj instanceof ControlLoopPolicy)) {
  89             throw new CompilerException("Yaml could not parse specification into required ControlLoopPolicy object");
  90         }
  91         return ControlLoopCompiler.compile((ControlLoopPolicy) obj, callback);
  92     }
  93
  94     private static void validateControlLoop(ControlLoop controlLoop,
  95                     ControlLoopCompilerCallback callback) throws CompilerException {
  96         if (controlLoop == null && callback != null) {
  97             callback.onError("controlLoop cannot be null");
  98         }
  99         if (controlLoop != null) {
 100             if (StringUtils.isEmpty(controlLoop.getControlLoopName()) && callback != null) {
 101                 callback.onError("Missing controlLoopName");
 102             }
 103             if ((!controlLoop.getVersion().contentEquals(ControlLoop.getCompilerVersion())) && callback != null) {
 104                 callback.onError("Unsupported version for this compiler");
 105             }
 106             if (StringUtils.isEmpty(controlLoop.getTrigger_policy())) {
 107                 throw new CompilerException("trigger_policy is not valid");
 108             }
 109         }
 110     }
 111
 112     private static void validatePolicies(ControlLoopPolicy policy,
 113                     ControlLoopCompilerCallback callback) throws CompilerException {
 114         if (policy == null) {
 115             throw new CompilerException("policy cannot be null");
 116         }
 117         if (policy.getPolicies() == null) {
 118             callback.onWarning("controlLoop is an open loop.");
 119         } else {
 120             //
 121             // For this version we can use a directed multigraph, in the future we may not be able to
 122             //
 123             DirectedGraph<NodeWrapper, LabeledEdge> graph =
 124                             new DirectedMultigraph<>(new ClassBasedEdgeFactory<NodeWrapper,
 125                                             LabeledEdge>(LabeledEdge.class));
 126             //
 127             // Check to see if the trigger Event is for OpenLoop, we do so by
 128             // attempting to create a FinalResult object from it. If its a policy id, this should
 129             // return null.
 130             //
 131             FinalResult triggerResult = FinalResult.toResult(policy.getControlLoop().getTrigger_policy());
 132             TriggerNodeWrapper triggerNode;
 133             //
 134             // Did this turn into a FinalResult object?
 135             //
 136             if (triggerResult != null) {
 137                 validateOpenLoopPolicy(policy, triggerResult, callback);
 138                 return;
 139                 //
 140             } else {
 141                 validatePoliciesContainTriggerPolicyAndCombinedTimeoutIsOk(policy, callback);
 142                 triggerNode = new TriggerNodeWrapper(policy.getControlLoop().getControlLoopName());
 143             }
 144             //
 145             // Add in the trigger node
 146             //
 147             graph.addVertex(triggerNode);
 148             //
 149             // Add in our Final Result nodes. All paths should end to these nodes.
 150             //
 151             FinalResultNodeWrapper finalSuccess = new FinalResultNodeWrapper(FinalResult.FINAL_SUCCESS);
 152             FinalResultNodeWrapper finalFailure = new FinalResultNodeWrapper(FinalResult.FINAL_FAILURE);
 153             FinalResultNodeWrapper finalFailureTimeout = new FinalResultNodeWrapper(FinalResult.FINAL_FAILURE_TIMEOUT);
 154             FinalResultNodeWrapper finalFailureRetries = new FinalResultNodeWrapper(FinalResult.FINAL_FAILURE_RETRIES);
 155             FinalResultNodeWrapper finalFailureException =
 156                             new FinalResultNodeWrapper(FinalResult.FINAL_FAILURE_EXCEPTION);
 157             FinalResultNodeWrapper finalFailureGuard = new FinalResultNodeWrapper(FinalResult.FINAL_FAILURE_GUARD);
 158             graph.addVertex(finalSuccess);
 159             graph.addVertex(finalFailure);
 160             graph.addVertex(finalFailureTimeout);
 161             graph.addVertex(finalFailureRetries);
 162             graph.addVertex(finalFailureException);
 163             graph.addVertex(finalFailureGuard);
 164             //
 165             // Work through the policies and add them in as nodes.
 166             //
 167             Map<Policy, PolicyNodeWrapper> mapNodes = addPoliciesAsNodes(policy, graph, triggerNode, callback);
 168             //
 169             // last sweep to connect remaining edges for policy results
 170             //
 171             for (Policy operPolicy : policy.getPolicies()) {
 172                 PolicyNodeWrapper node = mapNodes.get(operPolicy);
 173                 //
 174                 // Just ensure this has something
 175                 //
 176                 if (node == null) {
 177                     continue;
 178                 }
 179                 addEdge(graph, mapNodes, operPolicy.getId(), operPolicy.getSuccess(), finalSuccess,
 180                                 PolicyResult.SUCCESS, node);
 181                 addEdge(graph, mapNodes, operPolicy.getId(), operPolicy.getFailure(), finalFailure,
 182                                 PolicyResult.FAILURE, node);
 183                 addEdge(graph, mapNodes, operPolicy.getId(), operPolicy.getFailure_timeout(), finalFailureTimeout,
 184                                 PolicyResult.FAILURE_TIMEOUT, node);
 185                 addEdge(graph, mapNodes, operPolicy.getId(), operPolicy.getFailure_retries(), finalFailureRetries,
 186                                 PolicyResult.FAILURE_RETRIES, node);
 187                 addEdge(graph, mapNodes, operPolicy.getId(), operPolicy.getFailure_exception(), finalFailureException,
 188                                 PolicyResult.FAILURE_EXCEPTION, node);
 189                 addEdge(graph, mapNodes, operPolicy.getId(), operPolicy.getFailure_guard(), finalFailureGuard,
 190                                 PolicyResult.FAILURE_GUARD, node);
 191             }
 192             validateNodesAndEdges(graph, callback);
 193         }
 194     }
 195
 196     private static void validateOpenLoopPolicy(ControlLoopPolicy policy, FinalResult triggerResult,
 197                     ControlLoopCompilerCallback callback) throws CompilerException {
 198         //
 199         // Ensure they didn't use some other FinalResult code
 200         //
 201         if (triggerResult != FinalResult.FINAL_OPENLOOP) {
 202             throw new CompilerException("Unexpected Final Result for trigger_policy, should only be "
 203         + FinalResult.FINAL_OPENLOOP.toString() + " or a valid Policy ID");
 204         }
 205         //
 206         // They really shouldn't have any policies attached.
 207         //
 208         if ((policy.getPolicies() != null || policy.getPolicies().isEmpty()) && callback != null ) {
 209             callback.onWarning("Open Loop policy contains policies. The policies will never be invoked.");
 210         }
 211     }
 212
 213     private static void validatePoliciesContainTriggerPolicyAndCombinedTimeoutIsOk(ControlLoopPolicy policy,
 214                     ControlLoopCompilerCallback callback) throws CompilerException {
 215         int sum = 0;
 216         boolean triggerPolicyFound = false;
 217         for (Policy operPolicy : policy.getPolicies()) {
 218             sum += operPolicy.getTimeout().intValue();
 219             if (policy.getControlLoop().getTrigger_policy().equals(operPolicy.getId())) {
 220                 triggerPolicyFound = true;
 221             }
 222         }
 223         if (policy.getControlLoop().getTimeout().intValue() < sum && callback != null) {
 224             callback.onError("controlLoop overall timeout is less than the sum of operational policy timeouts.");
 225         }
 226
 227         if (!triggerPolicyFound) {
 228             throw new CompilerException("Unexpected value for trigger_policy, should only be "
 229         + FinalResult.FINAL_OPENLOOP.toString() + " or a valid Policy ID");
 230         }
 231     }
 232
 233     private static Map<Policy, PolicyNodeWrapper> addPoliciesAsNodes(ControlLoopPolicy policy,
 234             DirectedGraph<NodeWrapper, LabeledEdge> graph, TriggerNodeWrapper triggerNode,
 235             ControlLoopCompilerCallback callback) {
 236         Map<Policy, PolicyNodeWrapper> mapNodes = new HashMap<>();
 237         for (Policy operPolicy : policy.getPolicies()) {
 238             //
 239             // Is it still ok to add?
 240             //
 241             if (!okToAdd(operPolicy, callback)) {
 242                 //
 243                 // Do not add it in
 244                 //
 245                 continue;
 246             }
 247             //
 248             // Create wrapper policy node and save it into our map so we can
 249             // easily retrieve it.
 250             //
 251             PolicyNodeWrapper node = new PolicyNodeWrapper(operPolicy);
 252             mapNodes.put(operPolicy, node);
 253             graph.addVertex(node);
 254             //
 255             // Is this the trigger policy?
 256             //
 257             if (operPolicy.getId().equals(policy.getControlLoop().getTrigger_policy())) {
 258                 //
 259                 // Yes add an edge from our trigger event node to this policy
 260                 //
 261                 graph.addEdge(triggerNode, node, new LabeledEdge(triggerNode, node, new TriggerEdgeWrapper("ONSET")));
 262             }
 263         }
 264         return mapNodes;
 265     }
 266
 267     private static void addEdge(DirectedGraph<NodeWrapper, LabeledEdge> graph, Map<Policy, PolicyNodeWrapper> mapNodes,
 268                     String policyId, String connectedPolicy,
 269                     FinalResultNodeWrapper finalResultNodeWrapper,
 270                     PolicyResult policyResult, NodeWrapper node) throws CompilerException {
 271         FinalResult finalResult = FinalResult.toResult(finalResultNodeWrapper.getId());
 272         if (FinalResult.isResult(connectedPolicy, finalResult)) {
 273             graph.addEdge(node, finalResultNodeWrapper, new LabeledEdge(node, finalResultNodeWrapper,
 274                             new FinalResultEdgeWrapper(finalResult)));
 275         } else {
 276             PolicyNodeWrapper toNode = findPolicyNode(mapNodes, connectedPolicy);
 277             if (toNode == null) {
 278                 throw new CompilerException(OPERATION_POLICY + policyId + " is connected to unknown policy "
 279             + connectedPolicy);
 280             } else {
 281                 graph.addEdge(node, toNode, new LabeledEdge(node, toNode, new PolicyResultEdgeWrapper(policyResult)));
 282             }
 283         }
 284     }
 285
 286     private static void validateNodesAndEdges(DirectedGraph<NodeWrapper, LabeledEdge> graph,
 287                     ControlLoopCompilerCallback callback) throws CompilerException {
 288         for (NodeWrapper node : graph.vertexSet()) {
 289             if (node instanceof TriggerNodeWrapper) {
 290                 validateTriggerNodeWrapper(graph, node);
 291             } else if (node instanceof FinalResultNodeWrapper) {
 292                 validateFinalResultNodeWrapper(graph, node);
 293             } else if (node instanceof PolicyNodeWrapper) {
 294                 validatePolicyNodeWrapper(graph, node, callback);
 295             }
 296             for (LabeledEdge edge : graph.outgoingEdgesOf(node)) {
 297                 LOGGER.info("{} invokes {} upon {}", edge.from.getId(), edge.to.getId(), edge.edge.getId());
 298             }
 299         }
 300     }
 301
 302     private static void validateTriggerNodeWrapper(DirectedGraph<NodeWrapper, LabeledEdge> graph,
 303                     NodeWrapper node) throws CompilerException {
 304         if (LOGGER.isDebugEnabled()) {
 305             LOGGER.info("Trigger Node {}", node);
 306         }
 307         if (graph.inDegreeOf(node) > 0 ) {
 308             //
 309             // Really should NEVER get here unless someone messed up the code above.
 310             //
 311             throw new CompilerException("No inputs to event trigger");
 312         }
 313         //
 314         // Should always be 1, except in the future we may support multiple events
 315         //
 316         if (graph.outDegreeOf(node) > 1) {
 317             throw new CompilerException("The event trigger should only go to ONE node");
 318         }
 319     }
 320
 321     private static void validateFinalResultNodeWrapper(DirectedGraph<NodeWrapper, LabeledEdge> graph,
 322                     NodeWrapper node) throws CompilerException {
 323         if (LOGGER.isDebugEnabled()) {
 324             LOGGER.info("FinalResult Node {}", node);
 325         }
 326         //
 327         // FinalResult nodes should NEVER have an out edge
 328         //
 329         if (graph.outDegreeOf(node) > 0) {
 330             throw new CompilerException("FinalResult nodes should never have any out edges.");
 331         }
 332     }
 333
 334     private static void validatePolicyNodeWrapper(DirectedGraph<NodeWrapper, LabeledEdge> graph,
 335                     NodeWrapper node, ControlLoopCompilerCallback callback) throws CompilerException {
 336         if (LOGGER.isDebugEnabled()) {
 337             LOGGER.info("Policy Node {}", node);
 338         }
 339         //
 340         // All Policy Nodes should have the 5 out degrees defined.
 341         //
 342         if (graph.outDegreeOf(node) != 6) {
 343             throw new CompilerException("Policy node should ALWAYS have 6 out degrees.");
 344         }
 345         //
 346         // All Policy Nodes should have at least 1 in degrees
 347         //
 348         if (graph.inDegreeOf(node) == 0 && callback != null) {
 349             callback.onWarning("Policy " + node.getId() + " is not reachable.");
 350         }
 351     }
 352
 353     private static boolean okToAdd(Policy operPolicy, ControlLoopCompilerCallback callback) {
 354         boolean isOk = isPolicyIdOk(operPolicy, callback);
 355         if (! isActorOk(operPolicy, callback)) {
 356             isOk = false;
 357         }
 358         if (! isRecipeOk(operPolicy, callback)) {
 359             isOk = false;
 360         }
 361         if (! isTargetOk(operPolicy, callback) ) {
 362             isOk = false;
 363         }
 364         if (! arePolicyResultsOk(operPolicy, callback) ) {
 365             isOk = false;
 366         }
 367         return isOk;
 368     }
 369
 370     private static boolean isPolicyIdOk(Policy operPolicy, ControlLoopCompilerCallback callback) {
 371         boolean isOk = true;
 372         if (operPolicy.getId() == null || operPolicy.getId().length() < 1) {
 373             if (callback != null) {
 374                 callback.onError("Operational Policy has an bad ID");
 375             }
 376             isOk = false;
 377         } else {
 378             //
 379             // Check if they decided to make the ID a result object
 380             //
 381             if (PolicyResult.toResult(operPolicy.getId()) != null) {
 382                 if (callback != null) {
 383                     callback.onError("Policy id is set to a PolicyResult " + operPolicy.getId());
 384                 }
 385                 isOk = false;
 386             }
 387             if (FinalResult.toResult(operPolicy.getId()) != null) {
 388                 if (callback != null) {
 389                     callback.onError("Policy id is set to a FinalResult " + operPolicy.getId());
 390                 }
 391                 isOk = false;
 392             }
 393         }
 394         return isOk;
 395     }
 396
 397     private static boolean isActorOk(Policy operPolicy, ControlLoopCompilerCallback callback) {
 398         boolean isOk = true;
 399         if (operPolicy.getActor() == null) {
 400             if (callback != null) {
 401                 callback.onError("Policy actor is null");
 402             }
 403             isOk = false;
 404         }
 405         //
 406         // Construct a list for all valid actors
 407         //
 408         ImmutableList<String> actors = ImmutableList.of("APPC", "SDNC", "SDNR", "SO", "VFC");
 409         //
 410         if (operPolicy.getActor() != null && (!actors.contains(operPolicy.getActor())) ) {
 411             if (callback != null) {
 412                 callback.onError("Policy actor is invalid");
 413             }
 414             isOk = false;
 415         }
 416         return isOk;
 417     }
 418
 419     private static boolean isRecipeOk(Policy operPolicy, ControlLoopCompilerCallback callback) {
 420         boolean isOk = true;
 421         if (operPolicy.getRecipe() == null) {
 422             if (callback != null) {
 423                 callback.onError("Policy recipe is null");
 424             }
 425             isOk = false;
 426         }
 427         //
 428         // NOTE: We need a way to find the acceptable recipe values (either Enum or a database that has these)
 429         //
 430         ImmutableMap<String, List<String>> recipes = new ImmutableMap.Builder<String, List<String>>()
 431                 .put("APPC", ImmutableList.of("Restart", "Rebuild", "Migrate", "ModifyConfig"))
 432                 .put("SDNC", ImmutableList.of("Reroute"))
 433                 .put("SDNR", ImmutableList.of("ModifyConfig"))
 434                 .put("SO", ImmutableList.of("VF Module Create", "VF Module Delete"))
 435                 .put("VFC", ImmutableList.of("Restart"))
 436                 .build();
 437         //
 438         if (operPolicy.getRecipe() != null
 439                         && (!recipes.getOrDefault(operPolicy.getActor(),
 440                                         Collections.emptyList()).contains(operPolicy.getRecipe()))) {
 441             if (callback != null) {
 442                 callback.onError("Policy recipe is invalid");
 443             }
 444             isOk = false;
 445         }
 446         return isOk;
 447     }
 448
 449     private static boolean isTargetOk(Policy operPolicy, ControlLoopCompilerCallback callback) {
 450         boolean isOk = true;
 451         if (operPolicy.getTarget() == null) {
 452             if (callback != null) {
 453                 callback.onError("Policy target is null");
 454             }
 455             isOk = false;
 456         }
 457         if (operPolicy.getTarget() != null
 458                         && operPolicy.getTarget().getType() != TargetType.VM
 459                         && operPolicy.getTarget().getType() != TargetType.VFC
 460                         && operPolicy.getTarget().getType() != TargetType.PNF) {
 461             if (callback != null) {
 462                 callback.onError("Policy target is invalid");
 463             }
 464             isOk = false;
 465         }
 466         return isOk;
 467     }
 468
 469     private static boolean arePolicyResultsOk(Policy operPolicy, ControlLoopCompilerCallback callback) {
 470         //
 471         // Check that policy results are connected to either default final * or another policy
 472         //
 473         boolean isOk = isSuccessPolicyResultOk(operPolicy, callback);
 474         if (! isFailurePolicyResultOk(operPolicy, callback) ) {
 475             isOk = false;
 476         }
 477         if (! isFailureRetriesPolicyResultOk(operPolicy, callback) ) {
 478             isOk = false;
 479         }
 480         if (! isFailureTimeoutPolicyResultOk(operPolicy, callback) ) {
 481             isOk = false;
 482         }
 483         if (! isFailureExceptionPolicyResultOk(operPolicy, callback) ) {
 484             isOk = false;
 485         }
 486         if (! isFailureGuardPolicyResultOk(operPolicy, callback) ) {
 487             isOk = false;
 488         }
 489         return isOk;
 490     }
 491
 492     private static boolean isSuccessPolicyResultOk(Policy operPolicy, ControlLoopCompilerCallback callback) {
 493         boolean isOk = true;
 494         if (FinalResult.toResult(operPolicy.getSuccess()) != null
 495                         && !operPolicy.getSuccess().equals(FinalResult.FINAL_SUCCESS.toString())) {
 496             if (callback != null) {
 497                 callback.onError("Policy success is neither another policy nor FINAL_SUCCESS");
 498             }
 499             isOk = false;
 500         }
 501         return isOk;
 502     }
 503
 504     private static boolean isFailurePolicyResultOk(Policy operPolicy, ControlLoopCompilerCallback callback) {
 505         boolean isOk = true;
 506         if (FinalResult.toResult(operPolicy.getFailure()) != null
 507                         && !operPolicy.getFailure().equals(FinalResult.FINAL_FAILURE.toString())) {
 508             if (callback != null) {
 509                 callback.onError("Policy failure is neither another policy nor FINAL_FAILURE");
 510             }
 511             isOk = false;
 512         }
 513         return isOk;
 514     }
 515
 516     private static boolean isFailureRetriesPolicyResultOk(Policy operPolicy, ControlLoopCompilerCallback callback) {
 517         boolean isOk = true;
 518         if (FinalResult.toResult(operPolicy.getFailure_retries()) != null
 519                         && !operPolicy.getFailure_retries().equals(FinalResult.FINAL_FAILURE_RETRIES.toString())) {
 520             if (callback != null) {
 521                 callback.onError("Policy failure retries is neither another policy nor FINAL_FAILURE_RETRIES");
 522             }
 523             isOk = false;
 524         }
 525         return isOk;
 526     }
 527
 528     private static boolean isFailureTimeoutPolicyResultOk(Policy operPolicy, ControlLoopCompilerCallback callback) {
 529         boolean isOk = true;
 530         if (FinalResult.toResult(operPolicy.getFailure_timeout()) != null
 531                         && !operPolicy.getFailure_timeout().equals(FinalResult.FINAL_FAILURE_TIMEOUT.toString())) {
 532             if (callback != null) {
 533                 callback.onError("Policy failure timeout is neither another policy nor FINAL_FAILURE_TIMEOUT");
 534             }
 535             isOk = false;
 536         }
 537         return isOk;
 538     }
 539
 540     private static boolean isFailureExceptionPolicyResultOk(Policy operPolicy, ControlLoopCompilerCallback callback) {
 541         boolean isOk = true;
 542         if (FinalResult.toResult(operPolicy.getFailure_exception()) != null
 543                         && !operPolicy.getFailure_exception().equals(FinalResult.FINAL_FAILURE_EXCEPTION.toString())) {
 544             if (callback != null) {
 545                 callback.onError("Policy failure exception is neither another policy nor FINAL_FAILURE_EXCEPTION");
 546             }
 547             isOk = false;
 548         }
 549         return isOk;
 550     }
 551
 552     private static boolean isFailureGuardPolicyResultOk(Policy operPolicy, ControlLoopCompilerCallback callback) {
 553         boolean isOk = true;
 554         if (FinalResult.toResult(operPolicy.getFailure_guard()) != null
 555                         && !operPolicy.getFailure_guard().equals(FinalResult.FINAL_FAILURE_GUARD.toString())) {
 556             if (callback != null) {
 557                 callback.onError("Policy failure guard is neither another policy nor FINAL_FAILURE_GUARD");
 558             }
 559             isOk = false;
 560         }
 561         return isOk;
 562     }
 563
 564     private static PolicyNodeWrapper findPolicyNode(Map<Policy, PolicyNodeWrapper> mapNodes, String id) {
 565         for (Entry<Policy, PolicyNodeWrapper> entry : mapNodes.entrySet()) {
 566             if (entry.getKey().getId().equals(id)) {
 567                 return entry.getValue();
 568             }
 569         }
 570         return null;
 571     }
 572
 573     @FunctionalInterface
 574     private interface NodeWrapper extends Serializable {
 575         public String   getId();
 576     }
 577
 578     private static class TriggerNodeWrapper implements NodeWrapper {
 579         private static final long serialVersionUID = -187644087811478349L;
 580         private String closedLoopControlName;
 581
 582         public TriggerNodeWrapper(String closedLoopControlName) {
 583             this.closedLoopControlName = closedLoopControlName;
 584         }
 585
 586         @Override
 587         public String toString() {
 588             return "TriggerNodeWrapper [closedLoopControlName=" + closedLoopControlName + "]";
 589         }
 590
 591         @Override
 592         public String getId() {
 593             return closedLoopControlName;
 594         }
 595
 596     }
 597
 598     private static class FinalResultNodeWrapper implements NodeWrapper {
 599         private static final long serialVersionUID = 8540008796302474613L;
 600         private FinalResult result;
 601
 602         public FinalResultNodeWrapper(FinalResult result) {
 603             this.result = result;
 604         }
 605
 606         @Override
 607         public String toString() {
 608             return "FinalResultNodeWrapper [result=" + result + "]";
 609         }
 610
 611         @Override
 612         public String getId() {
 613             return result.toString();
 614         }
 615     }
 616
 617     private static class PolicyNodeWrapper implements NodeWrapper {
 618         private static final long serialVersionUID = 8170162175653823082L;
 619         private transient Policy policy;
 620
 621         public PolicyNodeWrapper(Policy operPolicy) {
 622             this.policy = operPolicy;
 623         }
 624
 625         @Override
 626         public String toString() {
 627             return "PolicyNodeWrapper [policy=" + policy + "]";
 628         }
 629
 630         @Override
 631         public String getId() {
 632             return policy.getId();
 633         }
 634     }
 635
 636     @FunctionalInterface
 637     private interface EdgeWrapper extends Serializable {
 638         public String getId();
 639
 640     }
 641
 642     private static class TriggerEdgeWrapper implements EdgeWrapper {
 643         private static final long serialVersionUID = 2678151552623278863L;
 644         private String trigger;
 645
 646         public TriggerEdgeWrapper(String trigger) {
 647             this.trigger = trigger;
 648         }
 649
 650         @Override
 651         public String getId() {
 652             return trigger;
 653         }
 654
 655         @Override
 656         public String toString() {
 657             return "TriggerEdgeWrapper [trigger=" + trigger + "]";
 658         }
 659
 660     }
 661
 662     private static class PolicyResultEdgeWrapper implements EdgeWrapper {
 663         private static final long serialVersionUID = 6078569477021558310L;
 664         private PolicyResult policyResult;
 665
 666         public PolicyResultEdgeWrapper(PolicyResult policyResult) {
 667             super();
 668             this.policyResult = policyResult;
 669         }
 670
 671         @Override
 672         public String toString() {
 673             return "PolicyResultEdgeWrapper [policyResult=" + policyResult + "]";
 674         }
 675
 676         @Override
 677         public String getId() {
 678             return policyResult.toString();
 679         }
 680
 681
 682     }
 683
 684     private static class FinalResultEdgeWrapper implements EdgeWrapper {
 685         private static final long serialVersionUID = -1486381946896779840L;
 686         private FinalResult finalResult;
 687
 688         public FinalResultEdgeWrapper(FinalResult result) {
 689             this.finalResult = result;
 690         }
 691
 692         @Override
 693         public String toString() {
 694             return "FinalResultEdgeWrapper [finalResult=" + finalResult + "]";
 695         }
 696
 697         @Override
 698         public String getId() {
 699             return finalResult.toString();
 700         }
 701     }
 702
 703
 704     private static class LabeledEdge extends DefaultEdge {
 705         private static final long serialVersionUID = 579384429573385524L;
 706
 707         private NodeWrapper from;
 708         private NodeWrapper to;
 709         private EdgeWrapper edge;
 710
 711         public LabeledEdge(NodeWrapper from, NodeWrapper to, EdgeWrapper edge) {
 712             this.from = from;
 713             this.to = to;
 714             this.edge = edge;
 715         }
 716
 717         @SuppressWarnings("unused")
 718         public NodeWrapper from() {
 719             return from;
 720         }
 721
 722         @SuppressWarnings("unused")
 723         public NodeWrapper to() {
 724             return to;
 725         }
 726
 727         @SuppressWarnings("unused")
 728         public EdgeWrapper edge() {
 729             return edge;
 730         }
 731
 732         @Override
 733         public String toString() {
 734             return "LabeledEdge [from=" + from + ", to=" + to + ", edge=" + edge + "]";
 735         }
 736     }
 737
 738 }