src/main/java/org/onap/clamp/policy/operational/OperationalPolicy.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.policy.operational;
  25
  26 import com.att.eelf.configuration.EELFLogger;
  27 import com.att.eelf.configuration.EELFManager;
  28 import com.google.gson.Gson;
  29 import com.google.gson.GsonBuilder;
  30 import com.google.gson.JsonArray;
  31 import com.google.gson.JsonElement;
  32 import com.google.gson.JsonObject;
  33 import com.google.gson.JsonSyntaxException;
  34 import com.google.gson.annotations.Expose;
  35
  36 import java.io.IOException;
  37 import java.io.Serializable;
  38 import java.io.UnsupportedEncodingException;
  39 import java.net.URLEncoder;
  40 import java.nio.charset.StandardCharsets;
  41 import java.util.HashMap;
  42 import java.util.Map;
  43
  44 import javax.persistence.Column;
  45 import javax.persistence.Entity;
  46 import javax.persistence.FetchType;
  47 import javax.persistence.Id;
  48 import javax.persistence.JoinColumn;
  49 import javax.persistence.JoinColumns;
  50 import javax.persistence.ManyToOne;
  51 import javax.persistence.Table;
  52 import javax.persistence.Transient;
  53
  54 import org.hibernate.annotations.TypeDef;
  55 import org.hibernate.annotations.TypeDefs;
  56 import org.onap.clamp.dao.model.jsontype.StringJsonUserType;
  57 import org.onap.clamp.loop.Loop;
  58 import org.onap.clamp.loop.template.PolicyModel;
  59 import org.onap.clamp.policy.Policy;
  60 import org.yaml.snakeyaml.DumperOptions;
  61 import org.yaml.snakeyaml.Yaml;
  62
  63 @Entity
  64 @Table(name = "operational_policies")
  65 @TypeDefs({@TypeDef(name = "json", typeClass = StringJsonUserType.class)})
  66 public class OperationalPolicy extends Policy implements Serializable {
  67     /**
  68      * The serial version ID.
  69      */
  70     private static final long serialVersionUID = 6117076450841538255L;
  71
  72     @Transient
  73     private static final EELFLogger logger = EELFManager.getInstance().getLogger(OperationalPolicy.class);
  74
  75     @Id
  76     @Expose
  77     @Column(nullable = false, name = "name", unique = true)
  78     private String name;
  79
  80     @ManyToOne(fetch = FetchType.LAZY)
  81     @JoinColumn(name = "loop_id", nullable = false)
  82     private Loop loop;
  83
  84     @Expose
  85     @ManyToOne(fetch = FetchType.EAGER)
  86     @JoinColumns({@JoinColumn(name = "policy_model_type", referencedColumnName = "policy_model_type"),
  87             @JoinColumn(name = "policy_model_version", referencedColumnName = "version")})
  88     private PolicyModel policyModel;
  89
  90     public OperationalPolicy() {
  91         // Serialization
  92     }
  93
  94     /**
  95      * The constructor.
  96      *
  97      * @param name               The name of the operational policy
  98      * @param loop               The loop that uses this operational policy
  99      * @param configurationsJson The operational policy property in the format of
 100      *                           json
 101      * @param policyModel        The policy model associated if any, can be null
 102      */
 103     public OperationalPolicy(String name, Loop loop, JsonObject configurationsJson, PolicyModel policyModel) {
 104         this.name = name;
 105         this.loop = loop;
 106         this.setPolicyModel(policyModel);
 107         this.setConfigurationsJson(configurationsJson);
 108         LegacyOperationalPolicy.preloadConfiguration(configurationsJson, loop);
 109         try {
 110             this.setJsonRepresentation(
 111                     OperationalPolicyRepresentationBuilder.generateOperationalPolicySchema(loop.getModelService()));
 112         } catch (JsonSyntaxException | IOException | NullPointerException e) {
 113             logger.error("Unable to generate the operational policy Schema ... ", e);
 114             this.setJsonRepresentation(new JsonObject());
 115         }
 116     }
 117
 118     public void setLoop(Loop loopName) {
 119         this.loop = loopName;
 120     }
 121
 122     public Loop getLoop() {
 123         return loop;
 124     }
 125
 126     @Override
 127     public String getName() {
 128         return name;
 129     }
 130
 131     /**
 132      * name setter.
 133      *
 134      * @param name the name to set
 135      */
 136     @Override
 137     public void setName(String name) {
 138         this.name = name;
 139     }
 140
 141     /**
 142      * policyModel getter.
 143      *
 144      * @return the policyModel
 145      */
 146     public PolicyModel getPolicyModel() {
 147         return policyModel;
 148     }
 149
 150     /**
 151      * policyModel setter.
 152      *
 153      * @param policyModel the policyModel to set
 154      */
 155     public void setPolicyModel(PolicyModel policyModel) {
 156         this.policyModel = policyModel;
 157     }
 158
 159     @Override
 160     public int hashCode() {
 161         final int prime = 31;
 162         int result = 1;
 163         result = prime * result + ((name == null) ? 0 : name.hashCode());
 164         return result;
 165     }
 166
 167     @Override
 168     public boolean equals(Object obj) {
 169         if (this == obj) {
 170             return true;
 171         }
 172         if (obj == null) {
 173             return false;
 174         }
 175         if (getClass() != obj.getClass()) {
 176             return false;
 177         }
 178         OperationalPolicy other = (OperationalPolicy) obj;
 179         if (name == null) {
 180             if (other.name != null) {
 181                 return false;
 182             }
 183         } else if (!name.equals(other.name)) {
 184             return false;
 185         }
 186         return true;
 187     }
 188
 189     /**
 190      * Create policy Yaml from json defined here.
 191      *
 192      * @return A string containing Yaml
 193      */
 194     public String createPolicyPayloadYaml() {
 195         JsonObject policyPayloadResult = new JsonObject();
 196
 197         policyPayloadResult.addProperty("tosca_definitions_version", "tosca_simple_yaml_1_0_0");
 198
 199         JsonObject topologyTemplateNode = new JsonObject();
 200         policyPayloadResult.add("topology_template", topologyTemplateNode);
 201
 202         JsonArray policiesArray = new JsonArray();
 203         topologyTemplateNode.add("policies", policiesArray);
 204
 205         JsonObject operationalPolicy = new JsonObject();
 206         policiesArray.add(operationalPolicy);
 207
 208         JsonObject operationalPolicyDetails = new JsonObject();
 209         operationalPolicy.add(this.name, operationalPolicyDetails);
 210         operationalPolicyDetails.addProperty("type", "onap.policies.controlloop.Operational");
 211         operationalPolicyDetails.addProperty("version", "1.0.0");
 212
 213         JsonObject metadata = new JsonObject();
 214         operationalPolicyDetails.add("metadata", metadata);
 215         metadata.addProperty("policy-id", this.name);
 216
 217         operationalPolicyDetails.add("properties", LegacyOperationalPolicy
 218                 .reworkPayloadAttributes(this.getConfigurationsJson().get("operational_policy").deepCopy()));
 219
 220         DumperOptions options = new DumperOptions();
 221         options.setIndent(2);
 222         options.setPrettyFlow(true);
 223         options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
 224         Gson gson = new GsonBuilder().create();
 225
 226         return (new Yaml(options)).dump(gson.fromJson(gson.toJson(policyPayloadResult), Map.class));
 227     }
 228
 229     @Override
 230     public String createPolicyPayload() throws UnsupportedEncodingException {
 231         // Now using the legacy payload fo Dublin
 232         JsonObject payload = new JsonObject();
 233         payload.addProperty("policy-id", this.getName());
 234         payload.addProperty("content",
 235                 URLEncoder.encode(
 236                         LegacyOperationalPolicy
 237                                 .createPolicyPayloadYamlLegacy(this.getConfigurationsJson().get("operational_policy")),
 238                         StandardCharsets.UTF_8.toString()));
 239         String opPayload = new GsonBuilder().setPrettyPrinting().create().toJson(payload);
 240         logger.info("Operational policy payload: " + opPayload);
 241         return opPayload;
 242     }
 243
 244     /**
 245      * Return a map containing all Guard policies indexed by Guard policy Name.
 246      *
 247      * @return The Guards map
 248      */
 249     public Map<String, String> createGuardPolicyPayloads() {
 250         Map<String, String> result = new HashMap<>();
 251
 252         JsonElement guardsList = this.getConfigurationsJson().get("guard_policies");
 253         if (guardsList != null) {
 254             for (JsonElement guardElem : guardsList.getAsJsonArray()) {
 255                 result.put(guardElem.getAsJsonObject().get("policy-id").getAsString(),
 256                         new GsonBuilder().create().toJson(guardElem));
 257             }
 258         }
 259         logger.info("Guard policy payload: " + result);
 260         return result;
 261     }
 262
 263     /**
 264      * Regenerate the Operational Policy Json Representation.
 265      */
 266     public void updateJsonRepresentation() {
 267         try {
 268             this.setJsonRepresentation(
 269                     OperationalPolicyRepresentationBuilder.generateOperationalPolicySchema(loop.getModelService()));
 270         } catch (JsonSyntaxException | IOException | NullPointerException e) {
 271             logger.error("Unable to generate the operational policy Schema ... ", e);
 272             this.setJsonRepresentation(new JsonObject());
 273         }
 274     }
 275 }