path: root/src/main/java/org/onap/clamp/loop/template/LoopElementModel.java

/*-
 * ============LICENSE_START=======================================================
 * ONAP CLAMP
 * ================================================================================
 * Copyright (C) 2018 AT&T Intellectual Property. All rights
 *                             reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END============================================
 * ===================================================================
 *
 */

package org.onap.clamp.loop.template;

import com.google.gson.annotations.Expose;
import java.io.Serializable;
import java.util.HashSet;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.JoinTable;
import javax.persistence.ManyToMany;
import javax.persistence.OneToMany;
import javax.persistence.Table;
import org.hibernate.annotations.SortNatural;
import org.onap.clamp.clds.tosca.update.ToscaConverterWithDictionarySupport;
import org.onap.clamp.loop.Loop;
import org.onap.clamp.loop.common.AuditEntity;
import org.onap.clamp.policy.Policy;
import org.onap.clamp.policy.microservice.MicroServicePolicy;
import org.onap.clamp.policy.operational.OperationalPolicy;

/**
 * This class represents a micro service/operational/... model for a loop template.
 * So it's an element in the flow (a box shown in the loop).
 */

@Entity
@Table(name = "loop_element_models")
public class LoopElementModel extends AuditEntity implements Serializable {
    /**
     * The serial version id.
     */
    private static final long serialVersionUID = -286522707701376645L;

    @Id
    @Expose
    @Column(nullable = false, name = "name", unique = true)
    private String name;

    @Expose
    @Column(name = "dcae_blueprint_id")
    private String dcaeBlueprintId;

    /**
     * Here we store the blueprint coming from DCAE, it can be null if this is not a micro service model.
     */
    @Column(columnDefinition = "MEDIUMTEXT", name = "blueprint_yaml")
    private String blueprint;

    public static final String MICRO_SERVICE_TYPE = "MICRO_SERVICE_TYPE";
    public static final String OPERATIONAL_POLICY_TYPE = "OPERATIONAL_POLICY_TYPE";
    /**
     * The type of element.
     */
    @Column(nullable = false, name = "loop_element_type")
    private String loopElementType;

    /**
     * This variable is used to display the micro-service name in the SVG.
     */
    @Expose
    @Column(name = "short_name")
    private String shortName;

    /**
     * This variable is used to store the type mentioned in the micro-service
     * blueprint.
     */
    @Expose
    @ManyToMany(
            fetch = FetchType.EAGER,
            cascade = {CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH})
    @JoinTable(
            name = "loopelementmodels_to_policymodels",
            joinColumns = @JoinColumn(name = "loop_element_name", referencedColumnName = "name"),
            inverseJoinColumns = {
                    @JoinColumn(name = "policy_model_type", referencedColumnName = "policy_model_type"),
                    @JoinColumn(name = "policy_model_version", referencedColumnName = "version")})
    @SortNatural
    private SortedSet<PolicyModel> policyModels = new TreeSet<>();

    @OneToMany(fetch = FetchType.LAZY, mappedBy = "loopElementModel", orphanRemoval = true)
    private Set<LoopTemplateLoopElementModel> usedByLoopTemplates = new HashSet<>();

    /**
     * policyModels getter.
     *
     * @return the policyModel
     */
    public SortedSet<PolicyModel> getPolicyModels() {
        return policyModels;
    }

    /**
     * Method to add a new policyModel to the list.
     *
     * @param policyModel The policy model
     */
    public void addPolicyModel(PolicyModel policyModel) {
        policyModels.add(policyModel);
        policyModel.getUsedByElementModels().add(this);
    }

    /**
     * name getter.
     *
     * @return the name
     */
    public String getName() {
        return name;
    }

    /**
     * name setter.
     *
     * @param name the name to set
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * blueprint getter.
     *
     * @return the blueprint
     */
    public String getBlueprint() {
        return blueprint;
    }

    /**
     * blueprint setter.
     *
     * @param blueprint the blueprint to set
     */
    public void setBlueprint(String blueprint) {
        this.blueprint = blueprint;
    }

    /**
     * dcaeBlueprintId getter.
     *
     * @return the dcaeBlueprintId
     */
    public String getDcaeBlueprintId() {
        return dcaeBlueprintId;
    }

    /**
     * dcaeBlueprintId setter.
     *
     * @param dcaeBlueprintId the dcaeBlueprintId to set
     */
    public void setDcaeBlueprintId(String dcaeBlueprintId) {
        this.dcaeBlueprintId = dcaeBlueprintId;
    }

    /**
     * loopElementType getter.
     *
     * @return the loopElementType
     */
    public String getLoopElementType() {
        return loopElementType;
    }

    /**
     * loopElementType setter.
     *
     * @param loopElementType the loopElementType to set
     */
    public void setLoopElementType(String loopElementType) {
        this.loopElementType = loopElementType;
    }

    /**
     * shortName getter.
     *
     * @return the shortName
     */
    public String getShortName() {
        return shortName;
    }

    /**
     * @param shortName the shortName to set.
     */
    public void setShortName(String shortName) {
        this.shortName = shortName;
    }

    /**
     * usedByLoopTemplates getter.
     *
     * @return the usedByLoopTemplates
     */
    public Set<LoopTemplateLoopElementModel> getUsedByLoopTemplates() {
        return usedByLoopTemplates;
    }

    /**
     * Default constructor for serialization.
     */
    public LoopElementModel() {
    }

    /**
     * Constructor.
     *
     * @param name            The name id
     * @param loopElementType The type of loop element
     * @param blueprint       The blueprint defined for dcae that contains the
     *                        policy type to use
     */
    public LoopElementModel(String name, String loopElementType, String blueprint) {
        this.name = name;
        this.loopElementType = loopElementType;
        this.blueprint = blueprint;
    }

    /**
     * Create a policy instance from the current loop element model.
     *
     * @return A Policy object.
     */
    public Policy createPolicyInstance(Loop loop, ToscaConverterWithDictionarySupport toscaConverter) {
        if (LoopElementModel.MICRO_SERVICE_TYPE.equals(this.getLoopElementType())) {
            return new MicroServicePolicy(loop, loop.getModelService(), this, toscaConverter);
        }
        else if (LoopElementModel.OPERATIONAL_POLICY_TYPE.equals(this.getLoopElementType())) {
            return new OperationalPolicy(loop, loop.getModelService(), this, toscaConverter);
        }
        else {
            return null;
        }
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((name == null) ? 0 : name.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        LoopElementModel other = (LoopElementModel) obj;
        if (name == null) {
            if (other.name != null) {
                return false;
            }
        }
        else if (!name.equals(other.name)) {
            return false;
        }
        return true;
    }

}