src/main/java/org/onap/clamp/loop/components/external/PolicyComponent.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP CLAMP
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights
   6  *                             reserved.
   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  */
  23
  24 package org.onap.clamp.loop.components.external;
  25
  26 import com.att.eelf.configuration.EELFLogger;
  27 import com.att.eelf.configuration.EELFManager;
  28 import com.google.gson.GsonBuilder;
  29 import com.google.gson.JsonArray;
  30 import com.google.gson.JsonObject;
  31
  32 import java.util.ArrayList;
  33 import java.util.List;
  34
  35 import javax.persistence.Transient;
  36
  37 import org.apache.camel.Exchange;
  38 import org.onap.clamp.loop.Loop;
  39 import org.onap.clamp.policy.microservice.MicroServicePolicy;
  40 import org.onap.clamp.policy.operational.OperationalPolicy;
  41
  42 public class PolicyComponent extends ExternalComponent {
  43
  44     @Transient
  45     private static final EELFLogger logger = EELFManager.getInstance().getLogger(PolicyComponent.class);
  46
  47     public static final ExternalComponentState IN_ERROR = new ExternalComponentState("IN_ERROR",
  48             "There was an error during the sending to policy, the policy engine may be corrupted or inconsistent", 100);
  49     public static final ExternalComponentState NOT_SENT = new ExternalComponentState("NOT_SENT",
  50             "The policies defined have NOT yet been created on the policy engine", 90);
  51     public static final ExternalComponentState SENT = new ExternalComponentState("SENT",
  52             "The policies defined have been created but NOT deployed on the policy engine", 50);
  53     public static final ExternalComponentState SENT_AND_DEPLOYED = new ExternalComponentState("SENT_AND_DEPLOYED",
  54             "The policies defined have been created and deployed on the policy engine", 10);
  55     public static final ExternalComponentState UNKNOWN = new ExternalComponentState("UNKNOWN",
  56             "The current status is not clear. Need to regresh the status to get the current status.", 0);
  57
  58     /**
  59      * Default constructor.
  60      */
  61     public PolicyComponent() {
  62         /*
  63          * We assume it's good by default as we will receive the state for each policy
  64          * on by one, each time we increase the level we can't decrease it anymore.
  65          * That's why it starts with the lowest one SENT_AND_DEPLOYED.
  66          */
  67         super(UNKNOWN);
  68     }
  69
  70     @Override
  71     public String getComponentName() {
  72         return "POLICY";
  73     }
  74
  75     /**
  76      * Generates the Json that must be sent to policy to add all policies to Active
  77      * PDP group.
  78      *
  79      * @return The json, payload to send
  80      */
  81     public static String createPoliciesPayloadPdpGroup(Loop loop) {
  82         JsonObject jsonObject = new JsonObject();
  83         JsonArray jsonArray = new JsonArray();
  84         jsonObject.add("policies", jsonArray);
  85
  86         for (String policyName : PolicyComponent.listPolicyNamesPdpGroup(loop)) {
  87             JsonObject policyNode = new JsonObject();
  88             jsonArray.add(policyNode);
  89             policyNode.addProperty("policy-id", policyName);
  90         }
  91         String payload = new GsonBuilder().setPrettyPrinting().create().toJson(jsonObject);
  92         logger.info("PdpGroup policy payload: " + payload);
  93         return new GsonBuilder().setPrettyPrinting().create().toJson(jsonObject);
  94     }
  95
  96     /**
  97      * Generates the list of policy names that must be send/remove to/from active
  98      * PDP group.
  99      *
 100      * @return A list of policy names
 101      */
 102     public static List<String> listPolicyNamesPdpGroup(Loop loop) {
 103         List<String> policyNamesList = new ArrayList<>();
 104         for (OperationalPolicy opPolicy : loop.getOperationalPolicies()) {
 105             policyNamesList.add(opPolicy.getName());
 106             for (String guardName : opPolicy.createGuardPolicyPayloads().keySet()) {
 107                 policyNamesList.add(guardName);
 108             }
 109         }
 110         for (MicroServicePolicy microServicePolicy : loop.getMicroServicePolicies()) {
 111             policyNamesList.add(microServicePolicy.getName());
 112         }
 113         return policyNamesList;
 114     }
 115
 116     private static ExternalComponentState findNewState(boolean found, boolean deployed) {
 117
 118         ExternalComponentState newState = NOT_SENT;
 119         if (found && deployed) {
 120             newState = SENT_AND_DEPLOYED;
 121         } else if (found) {
 122             newState = SENT;
 123         } else if (deployed) {
 124             newState = IN_ERROR;
 125         }
 126         return newState;
 127     }
 128
 129     private static ExternalComponentState mergeStates(ExternalComponentState oldState,
 130             ExternalComponentState newState) {
 131         return (oldState.compareTo(newState) < 0) ? newState : oldState;
 132     }
 133
 134     /**
 135      * This is a method that expect the results of the queries getPolicy and
 136      * getPolicyDeployed for a unique policy (op,guard, config, etc ...). It
 137      * re-computes the global policy state for each policy results given. Therefore
 138      * this method is called multiple times from the camel route and must be reset
 139      * for a new global policy state retrieval. The state to compute the global
 140      * policy state is stored in this class.
 141      *
 142      */
 143     @Override
 144     public ExternalComponentState computeState(Exchange camelExchange) {
 145         this.setState(mergeStates(this.getState(),
 146                 findNewState((boolean) camelExchange.getIn().getExchange().getProperty("policyFound"),
 147                         (boolean) camelExchange.getIn().getExchange().getProperty("policyDeployed"))));
 148         return this.getState();
 149     }
 150 }