pass VF count to guard for scale-out

Also updated license dates.
Fixed new checkstyle errors.

Change-Id: Ia6153814c4333724185918f76be560aba5a52f96
Issue-ID: POLICY-1084
Signed-off-by: Jim Hahn <jrh3@att.com>

3 files changed, 86 insertions, 17 deletions

diff --git a/controlloop/common/guard/src/main/java/org/onap/policy/guard/CallGuardTask.java b/controlloop/common/guard/src/main/java/org/onap/policy/guard/CallGuardTask.java
index 4ac22600b..146f42170 100644
--- a/controlloop/common/guard/src/main/java/org/onap/policy/guard/CallGuardTask.java
+++ b/controlloop/common/guard/src/main/java/org/onap/policy/guard/CallGuardTask.java
@@ -20,45 +20,99 @@
 
 package org.onap.policy.guard;
 
-import com.att.research.xacml.api.DataTypeException;
-import com.att.research.xacml.std.annotations.RequestParser;
-
+import java.util.HashSet;
+import java.util.Set;
 import java.util.UUID;
-
+import java.util.function.Supplier;
 import org.drools.core.WorkingMemory;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import com.att.research.xacml.api.DataTypeException;
+import com.att.research.xacml.std.annotations.RequestParser;
 
 public class CallGuardTask implements Runnable {
 
     private static final Logger logger = LoggerFactory.getLogger(CallGuardTask.class);
-    WorkingMemory workingMemory;
-    String restfulPdpUrl;
-    String clname;
-    String actor;
-    String recipe;
-    String target;
-    String requestId;
+
+    /**
+     * Actor/recipe pairs whose guard requests need a VF Module count. Each element is of
+     * the form "<actor>:<recipe>".
+     */
+    private static final Set<String> NEEDS_VF_COUNT = new HashSet<>();
+
+    /**
+     * Actor/recipe pairs whose guard requests need the VF Module count to be incremented
+     * (i.e., because a module is being added). Each element is of the form
+     * "<actor>:<recipe>".
+     */
+    private static final Set<String> INCR_VF_COUNT = new HashSet<>();
+
+    static {
+        INCR_VF_COUNT.add("SO:VF Module Create");
+        NEEDS_VF_COUNT.addAll(INCR_VF_COUNT);
+    }
+
+    private WorkingMemory workingMemory;
+    private String clname;
+    private String actor;
+    private String recipe;
+    private String target;
+    private String requestId;
+    private Integer vfCount;
+
+    /**
+     * Populated once the response has been determined, which may happen during the
+     * constructor or later, during {@link #run()}.
+     */
+    private PolicyGuardResponse guardResponse;
 
     /**
      * Guard url is grabbed from PolicyEngine.manager properties
      */
-    public CallGuardTask(WorkingMemory wm, String cl, String act, String rec, String tar, String reqId) {
+    public CallGuardTask(WorkingMemory wm, String cl, String act, String rec, String tar, String reqId, Supplier<Integer> vfcnt) {
         workingMemory = wm;
         clname = cl;
         actor = act;
         recipe = rec;
         requestId = reqId;
         target = tar;
+
+        vfCount = null;
+
+        String key = act + ":" + rec;
+
+        if (NEEDS_VF_COUNT.contains(key)) {
+            // this actor/recipe needs the count - get it
+            if ((vfCount = vfcnt.get()) == null) {
+                /*
+                 * The count is missing - create an artificial Deny, which will be
+                 * inserted into working memory when "run()" is called.
+                 */
+                guardResponse = new PolicyGuardResponse(Util.DENY, UUID.fromString(requestId), recipe);
+                logger.error("CallGuardTask.run missing VF Module count; requestId={}", requestId);
+                return;
+            }
+
+            if (INCR_VF_COUNT.contains(key)) {
+                // this actor/recipe needs the count to be incremented
+                ++vfCount;
+            }
+        }
     }
 
     @Override
     public void run() {
+        if (guardResponse != null) {
+            // already have a response - just insert it
+            workingMemory.insert(guardResponse);
+            return;
+        }
+        
         final long startTime = System.nanoTime();
         com.att.research.xacml.api.Request request = null;
 
         PolicyGuardXacmlRequestAttributes xacmlReq =
-                new PolicyGuardXacmlRequestAttributes(clname, actor, recipe, target, requestId);
+                        new PolicyGuardXacmlRequestAttributes(clname, actor, recipe, target, requestId, vfCount);
 
         try {
             request = RequestParser.parseRequest(xacmlReq);
@@ -90,8 +144,7 @@ public class CallGuardTask implements Runnable {
             guardDecision = Util.INDETERMINATE;
         }
 
-        PolicyGuardResponse guardResponse =
-                new PolicyGuardResponse(guardDecision, UUID.fromString(this.requestId), this.recipe);
+        guardResponse = new PolicyGuardResponse(guardDecision, UUID.fromString(this.requestId), this.recipe);
 
 
         //
diff --git a/controlloop/common/guard/src/main/java/org/onap/policy/guard/PolicyGuardXacmlHelper.java b/controlloop/common/guard/src/main/java/org/onap/policy/guard/PolicyGuardXacmlHelper.java
index 321d80ce2..53ba6075e 100644
--- a/controlloop/common/guard/src/main/java/org/onap/policy/guard/PolicyGuardXacmlHelper.java
+++ b/controlloop/common/guard/src/main/java/org/onap/policy/guard/PolicyGuardXacmlHelper.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * guard
  * ================================================================================
- * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2017-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.
@@ -100,6 +100,9 @@ public class PolicyGuardXacmlHelper {
         if (xacmlReq.getClnameID() != null) {
             attributes.put("clname", xacmlReq.getClnameID());
         }
+        if (xacmlReq.getVfCount() != null) {
+            attributes.put("vfCount", xacmlReq.getVfCount());
+        }
         JSONObject jsonReq = new JSONObject();
         jsonReq.put("decisionAttributes", attributes);
         jsonReq.put("onapName", "PDPD");
diff --git a/controlloop/common/guard/src/main/java/org/onap/policy/guard/PolicyGuardXacmlRequestAttributes.java b/controlloop/common/guard/src/main/java/org/onap/policy/guard/PolicyGuardXacmlRequestAttributes.java
index ab1d04efa..6b17af804 100644
--- a/controlloop/common/guard/src/main/java/org/onap/policy/guard/PolicyGuardXacmlRequestAttributes.java
+++ b/controlloop/common/guard/src/main/java/org/onap/policy/guard/PolicyGuardXacmlRequestAttributes.java
@@ -36,15 +36,17 @@ public class PolicyGuardXacmlRequestAttributes {
      * @param operationId the operation Id
      * @param targetId the target Id
      * @param requestId the request Id
+     * @param vfCount the new number of VF Modules
      */
     public PolicyGuardXacmlRequestAttributes(String clnameId, String actorId, String operationId, String targetId,
-            String requestId) {
+            String requestId, Integer vfCount) {
         super();
         this.clnameID = clnameId;
         this.actorID = actorId;
         this.operationID = operationId;
         this.targetID = targetId;
         this.requestID = requestId;
+        this.vfCount = vfCount;
     }
 
     @Override
@@ -68,6 +70,9 @@ public class PolicyGuardXacmlRequestAttributes {
     @XACMLResource(includeInResults = true, attributeId = "urn:oasis:names:tc:xacml:1.0:request:request-id")
     String requestID;
 
+    @XACMLResource(includeInResults = true, attributeId = "urn:oasis:names:tc:xacml:1.0:request:vf-count")
+    Integer vfCount;
+
     public String getActorID() {
         return actorID;
     }
@@ -107,4 +112,12 @@ public class PolicyGuardXacmlRequestAttributes {
     public void setClnameID(String clnameID) {
         this.clnameID = clnameID;
     }
+
+    public Integer getVfCount() {
+        return vfCount;
+    }
+
+    public void setVfCount(Integer vfCount) {
+        this.vfCount = vfCount;
+    }
 }