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.annotations.Expose;
  30
  31 import java.io.Serializable;
  32 import java.util.HashMap;
  33 import java.util.HashSet;
  34 import java.util.Map;
  35 import java.util.Set;
  36 import java.util.SortedSet;
  37 import java.util.TreeSet;
  38
  39 import javax.persistence.CascadeType;
  40 import javax.persistence.Column;
  41 import javax.persistence.Entity;
  42 import javax.persistence.EnumType;
  43 import javax.persistence.Enumerated;
  44 import javax.persistence.FetchType;
  45 import javax.persistence.Id;
  46 import javax.persistence.JoinColumn;
  47 import javax.persistence.JoinTable;
  48 import javax.persistence.ManyToMany;
  49 import javax.persistence.ManyToOne;
  50 import javax.persistence.OneToMany;
  51 import javax.persistence.Table;
  52 import javax.persistence.Transient;
  53
  54 import org.hibernate.annotations.SortNatural;
  55 import org.hibernate.annotations.Type;
  56 import org.hibernate.annotations.TypeDef;
  57 import org.hibernate.annotations.TypeDefs;
  58 import org.onap.clamp.dao.model.jsontype.StringJsonUserType;
  59 import org.onap.clamp.loop.common.AuditEntity;
  60 import org.onap.clamp.loop.components.external.DcaeComponent;
  61 import org.onap.clamp.loop.components.external.ExternalComponent;
  62 import org.onap.clamp.loop.components.external.PolicyComponent;
  63 import org.onap.clamp.loop.log.LoopLog;
  64 import org.onap.clamp.loop.service.Service;
  65 import org.onap.clamp.loop.template.LoopTemplate;
  66 import org.onap.clamp.policy.microservice.MicroServicePolicy;
  67 import org.onap.clamp.policy.operational.OperationalPolicy;
  68
  69 @Entity
  70 @Table(name = "loops")
  71 @TypeDefs({ @TypeDef(name = "json", typeClass = StringJsonUserType.class) })
  72 public class Loop extends AuditEntity implements Serializable {
  73
  74     /**
  75      * The serial version id.
  76      */
  77     private static final long serialVersionUID = -286522707701388642L;
  78
  79     @Transient
  80     private static final EELFLogger logger = EELFManager.getInstance().getLogger(Loop.class);
  81
  82     @Id
  83     @Expose
  84     @Column(nullable = false, name = "name", unique = true)
  85     private String name;
  86
  87     @Expose
  88     @Column(name = "dcae_deployment_id")
  89     private String dcaeDeploymentId;
  90
  91     @Expose
  92     @Column(name = "dcae_deployment_status_url")
  93     private String dcaeDeploymentStatusUrl;
  94
  95     @Expose
  96     @Column(name = "dcae_blueprint_id")
  97     private String dcaeBlueprintId;
  98
  99     @Column(columnDefinition = "MEDIUMTEXT", name = "svg_representation")
 100     private String svgRepresentation;
 101
 102     @Expose
 103     @Type(type = "json")
 104     @Column(columnDefinition = "json", name = "global_properties_json")
 105     private JsonObject globalPropertiesJson;
 106
 107     @Expose
 108     @ManyToOne(fetch = FetchType.EAGER, cascade = { CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH })
 109     @JoinColumn(name = "service_uuid")
 110     private Service modelService;
 111
 112     @Column(columnDefinition = "MEDIUMTEXT", nullable = false, name = "blueprint_yaml")
 113     private String blueprint;
 114
 115     @Expose
 116     @Column(nullable = false, name = "last_computed_state")
 117     @Enumerated(EnumType.STRING)
 118     private LoopState lastComputedState;
 119
 120     @Expose
 121     @Transient
 122     private final Map<String, ExternalComponent> components = new HashMap<>();
 123
 124     @Expose
 125     @OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER, mappedBy = "loop", orphanRemoval = true)
 126     private Set<OperationalPolicy> operationalPolicies = new HashSet<>();
 127
 128     @Expose
 129     @ManyToMany(cascade = { CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH }, fetch = FetchType.EAGER)
 130     @JoinTable(name = "loops_microservicepolicies", joinColumns = @JoinColumn(name = "loop_id"),
 131             inverseJoinColumns = @JoinColumn(name = "microservicepolicy_id"))
 132     private Set<MicroServicePolicy> microServicePolicies = new HashSet<>();
 133
 134     @Expose
 135     @OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER, mappedBy = "loop", orphanRemoval = true)
 136     @SortNatural
 137     private SortedSet<LoopLog> loopLogs = new TreeSet<>();
 138
 139     @Expose
 140     @ManyToOne(cascade = { CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH }, fetch = FetchType.EAGER)
 141     @JoinColumn(name = "loop_template_name")
 142     private LoopTemplate loopTemplate;
 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     }
 278
 279     public Map<String, ExternalComponent> getComponents() {
 280         return components;
 281     }
 282
 283     public ExternalComponent getComponent(String componentName) {
 284         return this.components.get(componentName);
 285     }
 286
 287     public void addComponent(ExternalComponent component) {
 288         this.components.put(component.getComponentName(), component);
 289     }
 290
 291     public LoopTemplate getLoopTemplate() {
 292         return loopTemplate;
 293     }
 294
 295     public void setLoopTemplate(LoopTemplate loopTemplate) {
 296         this.loopTemplate = loopTemplate;
 297     }
 298
 299     /**
 300      * Generate the loop name.
 301      *
 302      * @param serviceName       The service name
 303      * @param serviceVersion    The service version
 304      * @param resourceName      The resource name
 305      * @param blueprintFileName The blueprint file name
 306      * @return The generated loop name
 307      */
 308     static String generateLoopName(String serviceName, String serviceVersion, String resourceName,
 309             String blueprintFilename) {
 310         StringBuilder buffer = new StringBuilder("LOOP_").append(serviceName).append("_v").append(serviceVersion)
 311                 .append("_").append(resourceName).append("_").append(blueprintFilename.replaceAll(".yaml", ""));
 312         return buffer.toString().replace('.', '_').replaceAll(" ", "");
 313     }
 314
 315     @Override
 316     public int hashCode() {
 317         final int prime = 31;
 318         int result = 1;
 319         result = prime * result + ((name == null) ? 0 : name.hashCode());
 320         return result;
 321     }
 322
 323     @Override
 324     public boolean equals(Object obj) {
 325         if (this == obj) {
 326             return true;
 327         }
 328         if (obj == null) {
 329             return false;
 330         }
 331         if (getClass() != obj.getClass()) {
 332             return false;
 333         }
 334         Loop other = (Loop) obj;
 335         if (name == null) {
 336             if (other.name != null) {
 337                 return false;
 338             }
 339         } else if (!name.equals(other.name)) {
 340             return false;
 341         }
 342         return true;
 343     }
 344
 345 }