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("groups", jsonArray);
  85
  86         for (OperationalPolicy opPolicy : loop.getOperationalPolicies()) {
  87             jsonArray.add(createPdpDeploymentPayload(opPolicy.getPdpGroup(), opPolicy.getPdpSubgroup(),
  88                     opPolicy.getPolicyModel().getPolicyModelType(), opPolicy.getPolicyModel().getVersion()));
  89         }
  90
  91         for (MicroServicePolicy msPolicy : loop.getMicroServicePolicies()) {
  92             jsonArray.add(createPdpDeploymentPayload(msPolicy.getPdpGroup(), msPolicy.getPdpSubgroup(),
  93                     msPolicy.getPolicyModel().getPolicyModelType(), msPolicy.getPolicyModel().getVersion()));
  94         }
  95
  96         String payload = new GsonBuilder().setPrettyPrinting().create().toJson(jsonObject);
  97         logger.info("PdpGroup policy payload: " + payload);
  98         return payload;
  99     }
 100
 101     private static JsonObject createPdpDeploymentPayload(String pdpGroup, String pdpSubGroup,
 102             String policyType, String version) {
 103         JsonObject pdpGroupNode = new JsonObject();
 104         JsonArray subPdpArray = new JsonArray();
 105         pdpGroupNode.addProperty("name", pdpGroup);
 106         pdpGroupNode.add("deploymentSubgroups", subPdpArray);
 107
 108         JsonObject pdpSubGroupNode = new JsonObject();
 109         subPdpArray.add(pdpSubGroupNode);
 110         pdpSubGroupNode.addProperty("pdpType", pdpSubGroup);
 111         pdpSubGroupNode.addProperty("action", "POST");
 112
 113         JsonArray policyArray = new JsonArray();
 114         pdpSubGroupNode.add("policies", policyArray);
 115         JsonObject policyNode = new JsonObject();
 116         policyNode.addProperty("name", policyType);
 117         policyNode.addProperty("version", version);
 118         policyArray.add(policyNode);
 119         return pdpGroupNode;
 120     }
 121
 122     /**
 123      * Generates the list of policy names that must be send/remove to/from active
 124      * PDP group.
 125      *
 126      * @return A list of policy names
 127      */
 128     public static List<String> listPolicyNamesPdpGroup(Loop loop) {
 129         List<String> policyNamesList = new ArrayList<>();
 130         for (OperationalPolicy opPolicy : loop.getOperationalPolicies()) {
 131             policyNamesList.add(opPolicy.getName());
 132             for (String guardName : opPolicy.createGuardPolicyPayloads().keySet()) {
 133                 policyNamesList.add(guardName);
 134             }
 135         }
 136         for (MicroServicePolicy microServicePolicy : loop.getMicroServicePolicies()) {
 137             policyNamesList.add(microServicePolicy.getName());
 138         }
 139         return policyNamesList;
 140     }
 141
 142     private static ExternalComponentState findNewState(boolean found, boolean deployed) {
 143
 144         ExternalComponentState newState = NOT_SENT;
 145         if (found && deployed) {
 146             newState = SENT_AND_DEPLOYED;
 147         } else if (found) {
 148             newState = SENT;
 149         } else if (deployed) {
 150             newState = IN_ERROR;
 151         }
 152         return newState;
 153     }
 154
 155     private static ExternalComponentState mergeStates(ExternalComponentState oldState,
 156             ExternalComponentState newState) {
 157         return (oldState.compareTo(newState) < 0) ? newState : oldState;
 158     }
 159
 160     /**
 161      * This is a method that expect the results of the queries getPolicy and
 162      * getPolicyDeployed for a unique policy (op,guard, config, etc ...). It
 163      * re-computes the global policy state for each policy results given. Therefore
 164      * this method is called multiple times from the camel route and must be reset
 165      * for a new global policy state retrieval. The state to compute the global
 166      * policy state is stored in this class.
 167      *
 168      */
 169     @Override
 170     public ExternalComponentState computeState(Exchange camelExchange) {
 171         this.setState(mergeStates(this.getState(),
 172                 findNewState((boolean) camelExchange.getIn().getExchange().getProperty("policyFound"),
 173                         (boolean) camelExchange.getIn().getExchange().getProperty("policyDeployed"))));
 174         return this.getState();
 175     }
 176 }