Rework the policy refresh
[clamp.git] / src / main / java / org / onap / clamp / loop / Loop.java
index 910c5aa..605e42f 100644 (file)
@@ -25,11 +25,13 @@ package org.onap.clamp.loop;
 
 import com.google.gson.JsonObject;
 import com.google.gson.annotations.Expose;
-
 import java.io.Serializable;
+import java.util.HashMap;
 import java.util.HashSet;
+import java.util.Map;
 import java.util.Set;
-
+import java.util.SortedSet;
+import java.util.TreeSet;
 import javax.persistence.CascadeType;
 import javax.persistence.Column;
 import javax.persistence.Entity;
@@ -40,24 +42,35 @@ import javax.persistence.Id;
 import javax.persistence.JoinColumn;
 import javax.persistence.JoinTable;
 import javax.persistence.ManyToMany;
+import javax.persistence.ManyToOne;
 import javax.persistence.OneToMany;
 import javax.persistence.Table;
-
+import javax.persistence.Transient;
+import org.hibernate.annotations.SortNatural;
 import org.hibernate.annotations.Type;
 import org.hibernate.annotations.TypeDef;
 import org.hibernate.annotations.TypeDefs;
+import org.onap.clamp.clds.tosca.update.ToscaConverterWithDictionarySupport;
+import org.onap.clamp.clds.util.drawing.SvgLoopGenerator;
+import org.onap.clamp.dao.model.jsontype.StringJsonUserType;
+import org.onap.clamp.loop.common.AuditEntity;
+import org.onap.clamp.loop.components.external.DcaeComponent;
+import org.onap.clamp.loop.components.external.ExternalComponent;
+import org.onap.clamp.loop.components.external.PolicyComponent;
 import org.onap.clamp.loop.log.LoopLog;
+import org.onap.clamp.loop.service.Service;
+import org.onap.clamp.loop.template.LoopElementModel;
+import org.onap.clamp.loop.template.LoopTemplate;
 import org.onap.clamp.policy.microservice.MicroServicePolicy;
 import org.onap.clamp.policy.operational.OperationalPolicy;
-import org.onap.clamp.dao.model.jsontype.StringJsonUserType;
 
 @Entity
 @Table(name = "loops")
-@TypeDefs({ @TypeDef(name = "json", typeClass = StringJsonUserType.class) })
-public class Loop implements Serializable {
+@TypeDefs({@TypeDef(name = "json", typeClass = StringJsonUserType.class)})
+public class Loop extends AuditEntity implements Serializable {
 
     /**
-     *
+     * The serial version id.
      */
     private static final long serialVersionUID = -286522707701388642L;
 
@@ -74,11 +87,7 @@ public class Loop implements Serializable {
     @Column(name = "dcae_deployment_status_url")
     private String dcaeDeploymentStatusUrl;
 
-    @Expose
-    @Column(name = "dcae_blueprint_id")
-    private String dcaeBlueprintId;
-
-    @Column(name = "svg_representation")
+    @Column(columnDefinition = "MEDIUMTEXT", name = "svg_representation")
     private String svgRepresentation;
 
     @Expose
@@ -86,8 +95,10 @@ public class Loop implements Serializable {
     @Column(columnDefinition = "json", name = "global_properties_json")
     private JsonObject globalPropertiesJson;
 
-    @Column(nullable = false, name = "blueprint_yaml")
-    private String blueprint;
+    @Expose
+    @ManyToOne(fetch = FetchType.EAGER, cascade = {CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH})
+    @JoinColumn(name = "service_uuid")
+    private Service modelService;
 
     @Expose
     @Column(nullable = false, name = "last_computed_state")
@@ -95,27 +106,73 @@ public class Loop implements Serializable {
     private LoopState lastComputedState;
 
     @Expose
-    @OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER, mappedBy = "loop")
+    @Transient
+    private final Map<String, ExternalComponent> components = new HashMap<>();
+
+    @Expose
+    @OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER, mappedBy = "loop", orphanRemoval = true)
     private Set<OperationalPolicy> operationalPolicies = new HashSet<>();
 
     @Expose
-    @ManyToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER)
-    @JoinTable(name = "loops_microservicepolicies", joinColumns = @JoinColumn(name = "loop_id"), inverseJoinColumns = @JoinColumn(name = "microservicepolicy_id"))
+    @ManyToMany(cascade = {CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH}, fetch = FetchType.EAGER)
+    @JoinTable(name = "loops_to_microservicepolicies", joinColumns = @JoinColumn(name = "loop_name"),
+            inverseJoinColumns = @JoinColumn(name = "microservicepolicy_name"))
     private Set<MicroServicePolicy> microServicePolicies = new HashSet<>();
 
     @Expose
-    @OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER, mappedBy = "loop")
-    private Set<LoopLog> loopLogs = new HashSet<>();
+    @OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER, mappedBy = "loop", orphanRemoval = true)
+    @SortNatural
+    private SortedSet<LoopLog> loopLogs = new TreeSet<>();
+
+    @Expose
+    @ManyToOne(cascade = {CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH}, fetch = FetchType.EAGER)
+    @JoinColumn(name = "loop_template_name", nullable = false)
+    private LoopTemplate loopTemplate;
+
+    private void initializeExternalComponents() {
+        this.addComponent(new PolicyComponent());
+        this.addComponent(new DcaeComponent());
+    }
 
+    /**
+     * Public constructor.
+     */
     public Loop() {
+        initializeExternalComponents();
     }
 
-    public Loop(String name, String blueprint, String svgRepresentation) {
+    /**
+     * Constructor.
+     */
+    public Loop(String name, String svgRepresentation) {
         this.name = name;
         this.svgRepresentation = svgRepresentation;
-        this.blueprint = blueprint;
         this.lastComputedState = LoopState.DESIGN;
         this.globalPropertiesJson = new JsonObject();
+        initializeExternalComponents();
+    }
+
+    /**
+     * This constructor creates a loop from a loop template.
+     *
+     * @param name         The loop name
+     * @param loopTemplate The loop template from which a new loop instance must be created
+     */
+    public Loop(String name, LoopTemplate loopTemplate, ToscaConverterWithDictionarySupport toscaConverter) {
+        this(name, "");
+        this.setLoopTemplate(loopTemplate);
+        this.setModelService(loopTemplate.getModelService());
+        loopTemplate.getLoopElementModelsUsed().forEach(element -> {
+            if (LoopElementModel.MICRO_SERVICE_TYPE.equals(element.getLoopElementModel().getLoopElementType())) {
+                this.addMicroServicePolicy((MicroServicePolicy) element.getLoopElementModel()
+                        .createPolicyInstance(this, toscaConverter));
+            }
+            else if (LoopElementModel.OPERATIONAL_POLICY_TYPE
+                    .equals(element.getLoopElementModel().getLoopElementType())) {
+                this.addOperationalPolicy((OperationalPolicy) element.getLoopElementModel()
+                        .createPolicyInstance(this, toscaConverter));
+            }
+        });
     }
 
     public String getName() {
@@ -150,15 +207,7 @@ public class Loop implements Serializable {
         this.svgRepresentation = svgRepresentation;
     }
 
-    public String getBlueprint() {
-        return blueprint;
-    }
-
-    void setBlueprint(String blueprint) {
-        this.blueprint = blueprint;
-    }
-
-    LoopState getLastComputedState() {
+    public LoopState getLastComputedState() {
         return lastComputedState;
     }
 
@@ -166,7 +215,7 @@ public class Loop implements Serializable {
         this.lastComputedState = lastComputedState;
     }
 
-    Set<OperationalPolicy> getOperationalPolicies() {
+    public Set<OperationalPolicy> getOperationalPolicies() {
         return operationalPolicies;
     }
 
@@ -174,7 +223,7 @@ public class Loop implements Serializable {
         this.operationalPolicies = operationalPolicies;
     }
 
-    Set<MicroServicePolicy> getMicroServicePolicies() {
+    public Set<MicroServicePolicy> getMicroServicePolicies() {
         return microServicePolicies;
     }
 
@@ -182,7 +231,7 @@ public class Loop implements Serializable {
         this.microServicePolicies = microServicePolicies;
     }
 
-    JsonObject getGlobalPropertiesJson() {
+    public JsonObject getGlobalPropertiesJson() {
         return globalPropertiesJson;
     }
 
@@ -190,35 +239,109 @@ public class Loop implements Serializable {
         this.globalPropertiesJson = globalPropertiesJson;
     }
 
-    Set<LoopLog> getLoopLogs() {
+    public Set<LoopLog> getLoopLogs() {
         return loopLogs;
     }
 
-    void setLoopLogs(Set<LoopLog> loopLogs) {
+    void setLoopLogs(SortedSet<LoopLog> loopLogs) {
         this.loopLogs = loopLogs;
     }
 
-    void addOperationalPolicy(OperationalPolicy opPolicy) {
+    /**
+     * This method adds an operational policy to the loop.
+     * It re-computes the Svg as well.
+     *
+     * @param opPolicy the operationalPolicy to add
+     */
+    public void addOperationalPolicy(OperationalPolicy opPolicy) {
         operationalPolicies.add(opPolicy);
         opPolicy.setLoop(this);
+        this.setSvgRepresentation(SvgLoopGenerator.getSvgImage(this));
+    }
+
+    /**
+     * This method removes an operational policy to the loop.
+     * It re-computes the Svg as well.
+     *
+     * @param opPolicy the operationalPolicy to add
+     */
+    public void removeOperationalPolicy(OperationalPolicy opPolicy) {
+        operationalPolicies.remove(opPolicy);
+        this.setSvgRepresentation(SvgLoopGenerator.getSvgImage(this));
     }
 
-    void addMicroServicePolicy(MicroServicePolicy microServicePolicy) {
+    /**
+     * This method adds an micro service policy to the loop.
+     * It re-computes the Svg as well.
+     *
+     * @param microServicePolicy the micro service to add
+     */
+    public void addMicroServicePolicy(MicroServicePolicy microServicePolicy) {
         microServicePolicies.add(microServicePolicy);
         microServicePolicy.getUsedByLoops().add(this);
+        this.setSvgRepresentation(SvgLoopGenerator.getSvgImage(this));
     }
 
-    void addLog(LoopLog log) {
-        loopLogs.add(log);
+    public void addLog(LoopLog log) {
         log.setLoop(this);
+        this.loopLogs.add(log);
+    }
+
+    public Service getModelService() {
+        return modelService;
+    }
+
+    void setModelService(Service modelService) {
+        this.modelService = modelService;
+    }
+
+    public Map<String, ExternalComponent> getComponents() {
+        refreshDcaeComponents();
+        return components;
+    }
+
+    public ExternalComponent getComponent(String componentName) {
+        refreshDcaeComponents();
+        return this.components.get(componentName);
+    }
+
+    public void addComponent(ExternalComponent component) {
+        this.components.put(component.getComponentName(), component);
     }
 
-    public String getDcaeBlueprintId() {
-        return dcaeBlueprintId;
+    public LoopTemplate getLoopTemplate() {
+        return loopTemplate;
     }
 
-    public void setDcaeBlueprintId(String dcaeBlueprintId) {
-        this.dcaeBlueprintId = dcaeBlueprintId;
+    public void setLoopTemplate(LoopTemplate loopTemplate) {
+        this.loopTemplate = loopTemplate;
+    }
+
+    private void refreshDcaeComponents() {
+        if (!this.loopTemplate.getUniqueBlueprint()) {
+            this.components.remove("DCAE");
+            for (MicroServicePolicy policy : this.microServicePolicies) {
+                if (!this.components.containsKey("DCAE_" + policy.getName())) {
+                    this.addComponent(new DcaeComponent(policy.getName()));
+                }
+            }
+        }
+    }
+
+    /**
+     * Generate the loop name.
+     *
+     * @param serviceName       The service name
+     * @param serviceVersion    The service version
+     * @param resourceName      The resource name
+     * @param blueprintFileName The blueprint file name
+     * @return The generated loop name
+     */
+    public static String generateLoopName(String serviceName, String serviceVersion, String resourceName,
+                                          String blueprintFileName) {
+        StringBuilder buffer = new StringBuilder("LOOP_").append(serviceName).append("_v").append(serviceVersion)
+                .append("_").append(resourceName).append("_").append(blueprintFileName.replaceAll(".yaml", ""));
+        return buffer.toString().replace('.', '_').replaceAll(" ", "");
     }
 
     @Override
@@ -231,18 +354,24 @@ public class Loop implements Serializable {
 
     @Override
     public boolean equals(Object obj) {
-        if (this == obj)
+        if (this == obj) {
             return true;
-        if (obj == null)
+        }
+        if (obj == null) {
             return false;
-        if (getClass() != obj.getClass())
+        }
+        if (getClass() != obj.getClass()) {
             return false;
+        }
         Loop other = (Loop) obj;
         if (name == null) {
-            if (other.name != null)
+            if (other.name != null) {
                 return false;
-        } else if (!name.equals(other.name))
+            }
+        }
+        else if (!name.equals(other.name)) {
             return false;
+        }
         return true;
     }