src/main/java/org/onap/clamp/loop/Loop.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;
  25
  26 import com.att.eelf.configuration.EELFLogger;
  27 import com.att.eelf.configuration.EELFManager;
  28 import com.google.gson.JsonObject;
  29 import com.google.gson.JsonSyntaxException;
  30 import com.google.gson.annotations.Expose;
  31
  32 import java.io.IOException;
  33 import java.io.Serializable;
  34 import java.util.HashMap;
  35 import java.util.HashSet;
  36 import java.util.Map;
  37 import java.util.Set;
  38 import java.util.SortedSet;
  39 import java.util.TreeSet;
  40
  41 import javax.persistence.CascadeType;
  42 import javax.persistence.Column;
  43 import javax.persistence.Entity;
  44 import javax.persistence.EnumType;
  45 import javax.persistence.Enumerated;
  46 import javax.persistence.FetchType;
  47 import javax.persistence.Id;
  48 import javax.persistence.JoinColumn;
  49 import javax.persistence.JoinTable;
  50 import javax.persistence.ManyToMany;
  51 import javax.persistence.ManyToOne;
  52 import javax.persistence.OneToMany;
  53 import javax.persistence.Table;
  54 import javax.persistence.Transient;
  55
  56 import org.hibernate.annotations.SortNatural;
  57 import org.hibernate.annotations.Type;
  58 import org.hibernate.annotations.TypeDef;
  59 import org.hibernate.annotations.TypeDefs;
  60 import org.onap.clamp.dao.model.jsontype.StringJsonUserType;
  61 import org.onap.clamp.loop.components.external.DcaeComponent;
  62 import org.onap.clamp.loop.components.external.ExternalComponent;
  63 import org.onap.clamp.loop.components.external.PolicyComponent;
  64 import org.onap.clamp.loop.log.LoopLog;
  65 import org.onap.clamp.loop.service.Service;
  66 import org.onap.clamp.policy.microservice.MicroServicePolicy;
  67 import org.onap.clamp.policy.operational.OperationalPolicy;
  68 import org.onap.clamp.policy.operational.OperationalPolicyRepresentationBuilder;
  69
  70 @Entity
  71 @Table(name = "loops")
  72 @TypeDefs({ @TypeDef(name = "json", typeClass = StringJsonUserType.class) })
  73 public class Loop implements Serializable {
  74
  75     /**
  76      * The serial version id.
  77      */
  78     private static final long serialVersionUID = -286522707701388642L;
  79
  80     @Transient
  81     private static final EELFLogger logger = EELFManager.getInstance().getLogger(Loop.class);
  82
  83     @Id
  84     @Expose
  85     @Column(nullable = false, name = "name", unique = true)
  86     private String name;
  87
  88     @Expose
  89     @Column(name = "dcae_deployment_id")
  90     private String dcaeDeploymentId;
  91
  92     @Expose
  93     @Column(name = "dcae_deployment_status_url")
  94     private String dcaeDeploymentStatusUrl;
  95
  96     @Expose
  97     @Column(name = "dcae_blueprint_id")
  98     private String dcaeBlueprintId;
  99
 100     @Column(columnDefinition = "MEDIUMTEXT", name = "svg_representation")
 101     private String svgRepresentation;
 102
 103     @Expose
 104     @Type(type = "json")
 105     @Column(columnDefinition = "json", name = "operational_policy_schema")
 106     private JsonObject operationalPolicySchema;
 107
 108     @Expose
 109     @Type(type = "json")
 110     @Column(columnDefinition = "json", name = "global_properties_json")
 111     private JsonObject globalPropertiesJson;
 112
 113     @Expose
 114     @ManyToOne(fetch = FetchType.EAGER)
 115     @JoinColumn(name = "service_uuid")
 116     private Service modelService;
 117
 118     @Column(columnDefinition = "MEDIUMTEXT", nullable = false, name = "blueprint_yaml")
 119     private String blueprint;
 120
 121     @Expose
 122     @Column(nullable = false, name = "last_computed_state")
 123     @Enumerated(EnumType.STRING)
 124     private LoopState lastComputedState;
 125
 126     @Expose
 127     @Transient
 128     private final Map<String, ExternalComponent> components = new HashMap<>();
 129
 130     @Expose
 131     @OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER, mappedBy = "loop")
 132     private Set<OperationalPolicy> operationalPolicies = new HashSet<>();
 133
 134     @Expose
 135     @ManyToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER)
 136     @JoinTable(name = "loops_microservicepolicies", joinColumns = @JoinColumn(name = "loop_id"), inverseJoinColumns = @JoinColumn(name = "microservicepolicy_id"))
 137     private Set<MicroServicePolicy> microServicePolicies = new HashSet<>();
 138
 139     @Expose
 140     @OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER, mappedBy = "loop")
 141     @SortNatural
 142     private SortedSet<LoopLog> loopLogs = new TreeSet<>();
 143
 144     private void initializeExternalComponents() {
 145         this.addComponent(new PolicyComponent());
 146         this.addComponent(new DcaeComponent());
 147     }
 148
 149     /**
 150      * Public constructor.
 151      */
 152     public Loop() {
 153         initializeExternalComponents();
 154     }
 155
 156     /**
 157      * Constructor.
 158      */
 159     public Loop(String name, String blueprint, String svgRepresentation) {
 160         this.name = name;
 161         this.svgRepresentation = svgRepresentation;
 162         this.blueprint = blueprint;
 163         this.lastComputedState = LoopState.DESIGN;
 164         this.globalPropertiesJson = new JsonObject();
 165         initializeExternalComponents();
 166     }
 167
 168     public String getName() {
 169         return name;
 170     }
 171
 172     void setName(String name) {
 173         this.name = name;
 174     }
 175
 176     public String getDcaeDeploymentId() {
 177         return dcaeDeploymentId;
 178     }
 179
 180     void setDcaeDeploymentId(String dcaeDeploymentId) {
 181         this.dcaeDeploymentId = dcaeDeploymentId;
 182     }
 183
 184     public String getDcaeDeploymentStatusUrl() {
 185         return dcaeDeploymentStatusUrl;
 186     }
 187
 188     void setDcaeDeploymentStatusUrl(String dcaeDeploymentStatusUrl) {
 189         this.dcaeDeploymentStatusUrl = dcaeDeploymentStatusUrl;
 190     }
 191
 192     public String getSvgRepresentation() {
 193         return svgRepresentation;
 194     }
 195
 196     void setSvgRepresentation(String svgRepresentation) {
 197         this.svgRepresentation = svgRepresentation;
 198     }
 199
 200     public String getBlueprint() {
 201         return blueprint;
 202     }
 203
 204     void setBlueprint(String blueprint) {
 205         this.blueprint = blueprint;
 206     }
 207
 208     public LoopState getLastComputedState() {
 209         return lastComputedState;
 210     }
 211
 212     void setLastComputedState(LoopState lastComputedState) {
 213         this.lastComputedState = lastComputedState;
 214     }
 215
 216     public Set<OperationalPolicy> getOperationalPolicies() {
 217         return operationalPolicies;
 218     }
 219
 220     void setOperationalPolicies(Set<OperationalPolicy> operationalPolicies) {
 221         this.operationalPolicies = operationalPolicies;
 222     }
 223
 224     public Set<MicroServicePolicy> getMicroServicePolicies() {
 225         return microServicePolicies;
 226     }
 227
 228     void setMicroServicePolicies(Set<MicroServicePolicy> microServicePolicies) {
 229         this.microServicePolicies = microServicePolicies;
 230     }
 231
 232     public JsonObject getGlobalPropertiesJson() {
 233         return globalPropertiesJson;
 234     }
 235
 236     void setGlobalPropertiesJson(JsonObject globalPropertiesJson) {
 237         this.globalPropertiesJson = globalPropertiesJson;
 238     }
 239
 240     public Set<LoopLog> getLoopLogs() {
 241         return loopLogs;
 242     }
 243
 244     void setLoopLogs(SortedSet<LoopLog> loopLogs) {
 245         this.loopLogs = loopLogs;
 246     }
 247
 248     void addOperationalPolicy(OperationalPolicy opPolicy) {
 249         operationalPolicies.add(opPolicy);
 250         opPolicy.setLoop(this);
 251     }
 252
 253     void addMicroServicePolicy(MicroServicePolicy microServicePolicy) {
 254         microServicePolicies.add(microServicePolicy);
 255         microServicePolicy.getUsedByLoops().add(this);
 256     }
 257
 258     public void addLog(LoopLog log) {
 259         log.setLoop(this);
 260         this.loopLogs.add(log);
 261     }
 262
 263     public String getDcaeBlueprintId() {
 264         return dcaeBlueprintId;
 265     }
 266
 267     void setDcaeBlueprintId(String dcaeBlueprintId) {
 268         this.dcaeBlueprintId = dcaeBlueprintId;
 269     }
 270
 271     public Service getModelService() {
 272         return modelService;
 273     }
 274
 275     void setModelService(Service modelService) {
 276         this.modelService = modelService;
 277         try {
 278             this.operationalPolicySchema = OperationalPolicyRepresentationBuilder
 279                     .generateOperationalPolicySchema(this.getModelService());
 280         } catch (JsonSyntaxException | IOException | NullPointerException e) {
 281             logger.error("Unable to generate the operational policy Schema ... ", e);
 282             this.operationalPolicySchema = new JsonObject();
 283         }
 284     }
 285
 286     public Map<String, ExternalComponent> getComponents() {
 287         return components;
 288     }
 289
 290     public ExternalComponent getComponent(String componentName) {
 291         return this.components.get(componentName);
 292     }
 293
 294     public void addComponent(ExternalComponent component) {
 295         this.components.put(component.getComponentName(), component);
 296     }
 297
 298     /**
 299      * Generate the loop name.
 300      *
 301      * @param serviceName       The service name
 302      * @param serviceVersion    The service version
 303      * @param resourceName      The resource name
 304      * @param blueprintFileName The blueprint file name
 305      * @return The generated loop name
 306      */
 307     static String generateLoopName(String serviceName, String serviceVersion, String resourceName,
 308             String blueprintFilename) {
 309         StringBuilder buffer = new StringBuilder("LOOP_").append(serviceName).append("_v").append(serviceVersion)
 310                 .append("_").append(resourceName).append("_").append(blueprintFilename.replaceAll(".yaml", ""));
 311         return buffer.toString().replace('.', '_').replaceAll(" ", "");
 312     }
 313
 314     @Override
 315     public int hashCode() {
 316         final int prime = 31;
 317         int result = 1;
 318         result = prime * result + ((name == null) ? 0 : name.hashCode());
 319         return result;
 320     }
 321
 322     @Override
 323     public boolean equals(Object obj) {
 324         if (this == obj) {
 325             return true;
 326         }
 327         if (obj == null) {
 328             return false;
 329         }
 330         if (getClass() != obj.getClass()) {
 331             return false;
 332         }
 333         Loop other = (Loop) obj;
 334         if (name == null) {
 335             if (other.name != null) {
 336                 return false;
 337             }
 338         } else if (!name.equals(other.name)) {
 339             return false;
 340         }
 341         return true;
 342     }
 343
 344 }