2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2019 AT&T Intellectual Property. All rights
7 * Modifications Copyright (C) 2020 Huawei Technologies Co., Ltd.
8 * ================================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 * ============LICENSE_END============================================
21 * ===================================================================
25 package org.onap.clamp.policy.operational;
27 import com.att.eelf.configuration.EELFLogger;
28 import com.att.eelf.configuration.EELFManager;
29 import com.google.gson.Gson;
30 import com.google.gson.GsonBuilder;
31 import com.google.gson.JsonArray;
32 import com.google.gson.JsonElement;
33 import com.google.gson.JsonObject;
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.ManyToOne;
48 import javax.persistence.Table;
49 import javax.persistence.Transient;
50 import org.apache.commons.lang3.RandomStringUtils;
51 import org.hibernate.annotations.TypeDef;
52 import org.hibernate.annotations.TypeDefs;
53 import org.onap.clamp.clds.config.LegacyOperationalPolicyController;
54 import org.onap.clamp.clds.tosca.update.ToscaConverterWithDictionarySupport;
55 import org.onap.clamp.dao.model.jsontype.StringJsonUserType;
56 import org.onap.clamp.loop.Loop;
57 import org.onap.clamp.loop.service.Service;
58 import org.onap.clamp.loop.template.LoopElementModel;
59 import org.onap.clamp.loop.template.PolicyModel;
60 import org.onap.clamp.policy.Policy;
61 import org.yaml.snakeyaml.DumperOptions;
62 import org.yaml.snakeyaml.Yaml;
65 @Table(name = "operational_policies")
66 @TypeDefs({@TypeDef(name = "json", typeClass = StringJsonUserType.class)})
67 public class OperationalPolicy extends Policy implements Serializable {
69 * The serial version ID.
71 private static final long serialVersionUID = 6117076450841538255L;
74 private static final EELFLogger logger = EELFManager.getInstance().getLogger(OperationalPolicy.class);
78 @Column(nullable = false, name = "name", unique = true)
81 @ManyToOne(fetch = FetchType.LAZY)
82 @JoinColumn(name = "loop_id", nullable = false)
86 * Constructor for serialization.
88 public OperationalPolicy() {
94 * @param name The name of the operational policy
95 * @param configurationsJson The operational policy property in the format of
97 * @param jsonRepresentation The jsonObject defining the json schema
98 * @param policyModel The policy model associated if any, can be null
99 * @param loopElementModel The loop element from which this instance is supposed to be created
100 * @param pdpGroup The Pdp Group info
101 * @param pdpSubgroup The Pdp Subgroup info
103 public OperationalPolicy(String name, JsonObject configurationsJson,
104 JsonObject jsonRepresentation, PolicyModel policyModel,
105 LoopElementModel loopElementModel, String pdpGroup, String pdpSubgroup) {
107 this.setPolicyModel(policyModel);
108 this.setConfigurationsJson(configurationsJson);
109 this.setPdpGroup(pdpGroup);
110 this.setPdpSubgroup(pdpSubgroup);
111 this.setLoopElementModel(loopElementModel);
112 this.setJsonRepresentation(jsonRepresentation);
117 * Create an operational policy from a loop element model.
119 * @param loop The parent loop
120 * @param service The loop service
121 * @param loopElementModel The loop element model
122 * @param toscaConverter The tosca converter that must be used to create the Json representation
124 public OperationalPolicy(Loop loop, Service service, LoopElementModel loopElementModel,
125 ToscaConverterWithDictionarySupport toscaConverter) {
126 this(Policy.generatePolicyName("OPERATIONAL", service.getName(), service.getVersion(),
127 loopElementModel.getPolicyModels().first().getPolicyAcronym() + '_'
128 + loopElementModel.getPolicyModels().first().getVersion(),
129 RandomStringUtils.randomAlphanumeric(3)), new JsonObject(),
130 new JsonObject(), loopElementModel.getPolicyModels().first(), loopElementModel, null, null);
132 this.updateJsonRepresentation(toscaConverter, service);
136 * Create an operational policy from a policy model.
138 * @param loop The parent loop
139 * @param service The loop service
140 * @param policyModel The policy model
141 * @param toscaConverter The tosca converter that must be used to create the Json representation
142 * @throws IOException In case of issues with the legacy files (generated from resource files
144 public OperationalPolicy(Loop loop, Service service, PolicyModel policyModel,
145 ToscaConverterWithDictionarySupport toscaConverter) throws IOException {
146 this(Policy.generatePolicyName("OPERATIONAL", service.getName(), service.getVersion(),
147 policyModel.getPolicyAcronym() + '_' + policyModel.getVersion(),
148 RandomStringUtils.randomAlphanumeric(3)),
150 new JsonObject(), policyModel, null, null, null);
152 this.updateJsonRepresentation(toscaConverter, service);
155 public void setLoop(Loop loopName) {
156 this.loop = loopName;
159 public Loop getLoop() {
164 public String getName() {
171 * @param name the name to set
174 public void setName(String name) {
179 public void updateJsonRepresentation(ToscaConverterWithDictionarySupport toscaConverter, Service serviceModel) {
181 this.setJsonRepresentation(new JsonObject());
182 if (this.getPolicyModel() == null) {
185 if (this.isLegacy()) {
186 // Op policy Legacy case
187 LegacyOperationalPolicy.preloadConfiguration(this.getConfigurationsJson(), this.loop);
188 this.setJsonRepresentation(OperationalPolicyRepresentationBuilder
189 .generateOperationalPolicySchema(this.loop.getModelService()));
193 this.setJsonRepresentation(toscaConverter.convertToscaToJsonSchemaObject(
194 this.getPolicyModel().getPolicyModelTosca(),
195 this.getPolicyModel().getPolicyModelType(), serviceModel));
201 public int hashCode() {
202 final int prime = 31;
204 result = prime * result + ((name == null) ? 0 : name.hashCode());
209 public boolean equals(Object obj) {
216 if (getClass() != obj.getClass()) {
219 OperationalPolicy other = (OperationalPolicy) obj;
221 if (other.name != null) {
225 else if (!name.equals(other.name)) {
231 public Boolean isLegacy() {
232 return (this.getPolicyModel() != null) && this.getPolicyModel().getPolicyModelType().contains(
233 LegacyOperationalPolicyController.OPERATIONAL_POLICY_LEGACY);
237 * Create policy Yaml from json defined here.
239 * @return A string containing Yaml
241 public String createPolicyPayloadYaml() {
242 JsonObject policyPayloadResult = new JsonObject();
244 policyPayloadResult.addProperty("tosca_definitions_version", "tosca_simple_yaml_1_0_0");
246 JsonObject topologyTemplateNode = new JsonObject();
247 policyPayloadResult.add("topology_template", topologyTemplateNode);
249 JsonArray policiesArray = new JsonArray();
250 topologyTemplateNode.add("policies", policiesArray);
252 JsonObject operationalPolicy = new JsonObject();
253 policiesArray.add(operationalPolicy);
255 JsonObject operationalPolicyDetails = new JsonObject();
256 operationalPolicy.add(this.name, operationalPolicyDetails);
257 operationalPolicyDetails.addProperty("type", "onap.policies.controlloop.Operational");
258 operationalPolicyDetails.addProperty("version", "1.0.0");
260 JsonObject metadata = new JsonObject();
261 operationalPolicyDetails.add("metadata", metadata);
262 metadata.addProperty("policy-id", this.name);
264 operationalPolicyDetails.add("properties", LegacyOperationalPolicy
265 .reworkActorAttributes(this.getConfigurationsJson().get("operational_policy").deepCopy()));
267 DumperOptions options = new DumperOptions();
268 options.setIndent(2);
269 options.setPrettyFlow(true);
270 options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
271 Gson gson = new GsonBuilder().create();
273 return (new Yaml(options)).dump(gson.fromJson(gson.toJson(policyPayloadResult), Map.class));
277 public String createPolicyPayload() throws UnsupportedEncodingException {
279 // Now using the legacy payload fo Dublin
280 JsonObject payload = new JsonObject();
281 payload.addProperty("policy-id", this.getName());
282 payload.addProperty("content",
284 LegacyOperationalPolicy
285 .createPolicyPayloadYamlLegacy(
286 this.getConfigurationsJson().get("operational_policy")),
287 StandardCharsets.UTF_8.toString()));
288 String opPayload = new GsonBuilder().setPrettyPrinting().create().toJson(payload);
289 logger.info("Operational policy payload: " + opPayload);
293 return super.createPolicyPayload();
298 * Return a map containing all Guard policies indexed by Guard policy Name.
300 * @return The Guards map
302 public Map<String, String> createGuardPolicyPayloads() {
303 Map<String, String> result = new HashMap<>();
305 if (this.getConfigurationsJson() != null) {
306 JsonElement guardsList = this.getConfigurationsJson().get("guard_policies");
307 if (guardsList != null) {
308 for (JsonElement guardElem : guardsList.getAsJsonArray()) {
309 result.put(guardElem.getAsJsonObject().get("policy-id").getAsString(),
310 new GsonBuilder().create().toJson(guardElem));
314 logger.info("Guard policy payload: " + result);