2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2019 AT&T Intellectual Property. All rights
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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 * ===================================================================
24 package org.onap.clamp.policy.operational;
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 import java.io.IOException;
36 import java.io.Serializable;
37 import java.io.UnsupportedEncodingException;
38 import java.net.URLEncoder;
39 import java.nio.charset.StandardCharsets;
40 import java.util.HashMap;
42 import javax.persistence.Column;
43 import javax.persistence.Entity;
44 import javax.persistence.FetchType;
45 import javax.persistence.Id;
46 import javax.persistence.JoinColumn;
47 import javax.persistence.JoinColumns;
48 import javax.persistence.ManyToOne;
49 import javax.persistence.Table;
50 import javax.persistence.Transient;
51 import org.hibernate.annotations.TypeDef;
52 import org.hibernate.annotations.TypeDefs;
53 import org.onap.clamp.dao.model.jsontype.StringJsonUserType;
54 import org.onap.clamp.loop.Loop;
55 import org.onap.clamp.loop.template.LoopElementModel;
56 import org.onap.clamp.loop.template.PolicyModel;
57 import org.onap.clamp.policy.Policy;
58 import org.yaml.snakeyaml.DumperOptions;
59 import org.yaml.snakeyaml.Yaml;
62 @Table(name = "operational_policies")
63 @TypeDefs({@TypeDef(name = "json", typeClass = StringJsonUserType.class)})
64 public class OperationalPolicy extends Policy implements Serializable {
66 * The serial version ID.
68 private static final long serialVersionUID = 6117076450841538255L;
71 private static final EELFLogger logger = EELFManager.getInstance().getLogger(OperationalPolicy.class);
75 @Column(nullable = false, name = "name", unique = true)
78 @ManyToOne(fetch = FetchType.LAZY)
79 @JoinColumn(name = "loop_id", nullable = false)
83 @ManyToOne(fetch = FetchType.EAGER)
84 @JoinColumns({@JoinColumn(name = "policy_model_type", referencedColumnName = "policy_model_type"),
85 @JoinColumn(name = "policy_model_version", referencedColumnName = "version")})
86 private PolicyModel policyModel;
88 public OperationalPolicy() {
95 * @param name The name of the operational policy
96 * @param loop The loop that uses this operational policy
97 * @param configurationsJson The operational policy property in the format of
99 * @param policyModel The policy model associated if any, can be null
100 * @param loopElementModel The loop element from which this instance is supposed to be created
102 public OperationalPolicy(String name, Loop loop, JsonObject configurationsJson, PolicyModel policyModel,
103 LoopElementModel loopElementModel) {
106 this.setPolicyModel(policyModel);
107 this.setConfigurationsJson(configurationsJson);
108 this.setLoopElementModel(loopElementModel);
109 if (policyModel != null && policyModel.getPolicyModelType().contains("legacy")) {
110 LegacyOperationalPolicy.preloadConfiguration(configurationsJson, loop);
113 this.setJsonRepresentation(
114 OperationalPolicyRepresentationBuilder.generateOperationalPolicySchema(loop.getModelService()));
115 } catch (JsonSyntaxException | IOException | NullPointerException e) {
116 logger.error("Unable to generate the operational policy Schema ... ", e);
117 this.setJsonRepresentation(new JsonObject());
121 public void setLoop(Loop loopName) {
122 this.loop = loopName;
125 public Loop getLoop() {
130 public String getName() {
137 * @param name the name to set
140 public void setName(String name) {
145 * policyModel getter.
147 * @return the policyModel
149 public PolicyModel getPolicyModel() {
154 * policyModel setter.
156 * @param policyModel the policyModel to set
158 public void setPolicyModel(PolicyModel policyModel) {
159 this.policyModel = policyModel;
163 public int hashCode() {
164 final int prime = 31;
166 result = prime * result + ((name == null) ? 0 : name.hashCode());
171 public boolean equals(Object obj) {
178 if (getClass() != obj.getClass()) {
181 OperationalPolicy other = (OperationalPolicy) obj;
183 if (other.name != null) {
186 } else if (!name.equals(other.name)) {
193 * Create policy Yaml from json defined here.
195 * @return A string containing Yaml
197 public String createPolicyPayloadYaml() {
198 JsonObject policyPayloadResult = new JsonObject();
200 policyPayloadResult.addProperty("tosca_definitions_version", "tosca_simple_yaml_1_0_0");
202 JsonObject topologyTemplateNode = new JsonObject();
203 policyPayloadResult.add("topology_template", topologyTemplateNode);
205 JsonArray policiesArray = new JsonArray();
206 topologyTemplateNode.add("policies", policiesArray);
208 JsonObject operationalPolicy = new JsonObject();
209 policiesArray.add(operationalPolicy);
211 JsonObject operationalPolicyDetails = new JsonObject();
212 operationalPolicy.add(this.name, operationalPolicyDetails);
213 operationalPolicyDetails.addProperty("type", "onap.policies.controlloop.Operational");
214 operationalPolicyDetails.addProperty("version", "1.0.0");
216 JsonObject metadata = new JsonObject();
217 operationalPolicyDetails.add("metadata", metadata);
218 metadata.addProperty("policy-id", this.name);
220 operationalPolicyDetails.add("properties", LegacyOperationalPolicy
221 .reworkPayloadAttributes(this.getConfigurationsJson().get("operational_policy").deepCopy()));
223 DumperOptions options = new DumperOptions();
224 options.setIndent(2);
225 options.setPrettyFlow(true);
226 options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
227 Gson gson = new GsonBuilder().create();
229 return (new Yaml(options)).dump(gson.fromJson(gson.toJson(policyPayloadResult), Map.class));
233 public String createPolicyPayload() throws UnsupportedEncodingException {
234 // Now using the legacy payload fo Dublin
235 JsonObject payload = new JsonObject();
236 payload.addProperty("policy-id", this.getName());
237 payload.addProperty("content",
239 LegacyOperationalPolicy
240 .createPolicyPayloadYamlLegacy(this.getConfigurationsJson().get("operational_policy")),
241 StandardCharsets.UTF_8.toString()));
242 String opPayload = new GsonBuilder().setPrettyPrinting().create().toJson(payload);
243 logger.info("Operational policy payload: " + opPayload);
248 * Return a map containing all Guard policies indexed by Guard policy Name.
250 * @return The Guards map
252 public Map<String, String> createGuardPolicyPayloads() {
253 Map<String, String> result = new HashMap<>();
255 JsonElement guardsList = this.getConfigurationsJson().get("guard_policies");
256 if (guardsList != null) {
257 for (JsonElement guardElem : guardsList.getAsJsonArray()) {
258 result.put(guardElem.getAsJsonObject().get("policy-id").getAsString(),
259 new GsonBuilder().create().toJson(guardElem));
262 logger.info("Guard policy payload: " + result);
267 * Regenerate the Operational Policy Json Representation.
269 public void updateJsonRepresentation() {
271 this.setJsonRepresentation(
272 OperationalPolicyRepresentationBuilder.generateOperationalPolicySchema(loop.getModelService()));
273 } catch (JsonSyntaxException | IOException | NullPointerException e) {
274 logger.error("Unable to generate the operational policy Schema ... ", e);
275 this.setJsonRepresentation(new JsonObject());