path: root/bpmn/MSOCoreBPMN/src/main/java/org/onap/so/bpmn/core/domain/VnfResource.java

/*-
 * ============LICENSE_START=======================================================
 * ONAP - SO
 * ================================================================================
 * Copyright (C) 2017 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.so.bpmn.core.domain;

import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonRootName;

/**
 * Encapsulates VNF resource data set
 *
 */
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonRootName("vnfResource")
public class VnfResource extends Resource {

    private static final long serialVersionUID = 1L;

    /*
     * set resourceType for this object
     */
    public VnfResource() {
        resourceType = ResourceType.VNF;
        setResourceId(UUID.randomUUID().toString());
    }

    /*
     * fields specific to VNF resource type
     */
    @JsonProperty("vfModules")
    private List<ModuleResource> vfModules;

    @JsonProperty("groups")
    private List<GroupResource> groups;

    @JsonProperty("group-order")
    private String groupOrder;

    private String vnfHostname;
    private String vnfType;
    private String nfFunction;
    private String nfType;
    private String nfRole;
    private String nfNamingCode;
    private String multiStageDesign;
    private String orchestrationStatus;

    @JsonProperty("resourceInput")
    private String resourceInput;

    /*
     * GET and SET
     */
    public List<ModuleResource> getVfModules() {
        return vfModules;
    }

    public void setModules(List<ModuleResource> moduleResources) {
        this.vfModules = moduleResources;
    }

    public String getVnfHostname() {
        return vnfHostname;
    }

    public void setVnfHostname(String vnfHostname) {
        this.vnfHostname = vnfHostname;
    }

    @Deprecated
    public void setVnfType(String vnfType) {
        this.vnfType = vnfType;
    }

    public String getVnfType() {
        return vnfType;
    }

    public String getNfFunction() {
        return nfFunction;
    }

    public void setNfFunction(String nfFunction) {
        this.nfFunction = nfFunction;
    }

    public String getNfType() {
        return nfType;
    }

    public void setNfType(String nfType) {
        this.nfType = nfType;
    }

    public String getNfRole() {
        return nfRole;
    }

    public void setNfRole(String nfRole) {
        this.nfRole = nfRole;
    }

    public String getNfNamingCode() {
        return nfNamingCode;
    }

    public void setNfNamingCode(String nfNamingCode) {
        this.nfNamingCode = nfNamingCode;
    }

    public String getMultiStageDesign() {
        return multiStageDesign;
    }

    public void setMultiStageDesign(String multiStageDesign) {
        this.multiStageDesign = multiStageDesign;
    }
    /*
     * GET accessors per design requirements
     */


    public String getOrchestrationStatus() {
        return orchestrationStatus;
    }

    public void setOrchestrationStatus(String orchestrationStatus) {
        this.orchestrationStatus = orchestrationStatus;
    }

    public String getResourceInput() {
        return resourceInput;
    }

    public void setResourceInput(String resourceInput) {
        this.resourceInput = resourceInput;
    }

    public List<GroupResource> getGroups() {
        return groups;
    }

    public void setGroups(List<GroupResource> groups) {
        this.groups = groups;
    }

    public String getGroupOrder() {
        return groupOrder;
    }

    public void setGroupOrder(String groupOrder) {
        this.groupOrder = groupOrder;
    }

    /**
     * Returns a list of all VfModule objects. Base module is first entry in the list
     * 
     * @return ordered list of ModuleResources objects
     */
    @JsonIgnore
    public List<ModuleResource> getAllVfModuleObjects() {
        if (vfModules == null) {
            return null;
        }

        for (int i = 0; i < vfModules.size(); i++) {
            ModuleResource moduleResource = vfModules.get(i);
            if (moduleResource.getIsBase()) {
                vfModules.remove(moduleResource);
                vfModules.add(0, moduleResource);
            }
        }
        return vfModules;
    }

    /**
     *
     * @return Returns JSON list of all VfModule structures.
     */
    @JsonIgnore
    public String getAllVfModulesJson() {

        return listToJson(vfModules);
    }

    // methods to add to the list
    public void addVfModule(ModuleResource moduleResource) {
        if (vfModules == null) {
            vfModules = new ArrayList<>();
        }
        this.vfModules.add(moduleResource);
    }


    /**
     * Utility method to allow construction of the filed in the form of
     * <serviceResources.modelInfo.modelName>/<serviceVnfs.modelInfo.modelInstanceName>
     *
     * default setter for this field deprecated
     * 
     * @param modelName << serviceResources.modelInfo.modelName
     */
    public void constructVnfType(String modelName) {
        this.vnfType = modelName.concat("/").concat(this.modelInfo.getModelInstanceName());
    }
}