path: root/models-interactions/model-impl/aai/src/main/java/org/onap/policy/aai/AaiCqResponse.java

/*-
 * ============LICENSE_START=======================================================
 *
 * ================================================================================
 * Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
 * Modifications Copyright (C) 2023 Nordix Foundation.
 * ================================================================================
 * 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.policy.aai;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.annotations.SerializedName;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
import org.json.JSONArray;
import org.json.JSONObject;
import org.onap.aai.domain.yang.CloudRegion;
import org.onap.aai.domain.yang.GenericVnf;
import org.onap.aai.domain.yang.ModelVer;
import org.onap.aai.domain.yang.Relationship;
import org.onap.aai.domain.yang.RelationshipData;
import org.onap.aai.domain.yang.ServiceInstance;
import org.onap.aai.domain.yang.Tenant;
import org.onap.aai.domain.yang.VfModule;
import org.onap.aai.domain.yang.Vserver;

public class AaiCqResponse implements Serializable {
    private static final long serialVersionUID = 1L;
    public static final String CONTEXT_KEY = AaiConstants.CONTEXT_PREFIX + "AaiCqResponse";
    public static final String OPERATION = "CustomQuery";
    private static final String GENERIC_VNF = "generic-vnf";
    private static final String VF_MODULE = "vf-module";

    @SerializedName("results")
    private List<Serializable> inventoryResponseItems = new LinkedList<>();

    private final Gson gson;

    /**
     * Constructor creates a custom query response from a valid json string.
     *
     * @param jsonString A&AI Custom Query response JSON string
     */
    public AaiCqResponse(String jsonString) {
        gson = new GsonBuilder()
            .setFieldNamingStrategy(new XmlElementFieldNamingStrategy())
            .create();

        // Read JSON String and add all AaiObjects
        var responseObj = new JSONObject(jsonString);
        var resultsArray = new JSONArray();
        if (responseObj.has("results")) {
            resultsArray = (JSONArray) responseObj.get("results");
        }
        for (var i = 0; i < resultsArray.length(); i++) {
            final var resultObject = resultsArray.getJSONObject(i);

            extractVserver(resultObject);
            extractGenericVnf(resultObject);
            extractServiceInstance(resultObject);
            extractVfModule(resultObject);
            extractCloudRegion(resultObject);
            extractTenant(resultObject);
            extractModelVer(resultObject);
        }
    }

    private void extractVserver(final JSONObject resultObject) {
        if (resultObject.has("vserver")) {

            // Create the StreamSource by creating StringReader using the
            // JSON input
            var json = resultObject.getJSONObject("vserver").toString();

            // Getting the vserver pojo again from the json
            var vserver = gson.fromJson(json, Vserver.class);
            this.inventoryResponseItems.add(vserver);
        }
    }

    private void extractGenericVnf(final JSONObject resultObject) {
        if (resultObject.has(GENERIC_VNF)) {
            // Create the StreamSource by creating StringReader using the
            // JSON input
            var json = resultObject.getJSONObject(GENERIC_VNF).toString();

            // Getting the generic vnf pojo again from the json
            var genericVnf = gson.fromJson(json, GenericVnf.class);
            this.inventoryResponseItems.add(genericVnf);
        }
    }

    private void extractServiceInstance(final JSONObject resultObject) {
        if (resultObject.has("service-instance")) {

            // Create the StreamSource by creating StringReader using the
            // JSON input
            var json = resultObject.getJSONObject("service-instance").toString();

            // Getting the employee pojo again from the json
            var serviceInstance = gson.fromJson(json, ServiceInstance.class);
            this.inventoryResponseItems.add(serviceInstance);
        }
    }

    private void extractVfModule(final JSONObject resultObject) {
        if (resultObject.has(VF_MODULE)) {
            // Create the StreamSource by creating StringReader using the
            // JSON input
            var json = resultObject.getJSONObject(VF_MODULE).toString();

            // Getting the vf module pojo again from the json
            var vfModule = gson.fromJson(json, VfModule.class);
            this.inventoryResponseItems.add(vfModule);
        }
    }

    private void extractCloudRegion(final JSONObject resultObject) {
        if (resultObject.has("cloud-region")) {
            // Create the StreamSource by creating StringReader using the
            // JSON input
            var json = resultObject.getJSONObject("cloud-region").toString();

            // Getting the cloud region pojo again from the json
            var cloudRegion = gson.fromJson(json, CloudRegion.class);
            this.inventoryResponseItems.add(cloudRegion);
        }
    }

    private void extractTenant(final JSONObject resultObject) {
        if (resultObject.has("tenant")) {
            // Create the StreamSource by creating StringReader using the
            // JSON input
            var json = resultObject.getJSONObject("tenant").toString();

            // Getting the tenant pojo again from the json
            var tenant = gson.fromJson(json, Tenant.class);
            this.inventoryResponseItems.add(tenant);
        }
    }

    private void extractModelVer(final JSONObject resultObject) {
        if (resultObject.has("model-ver")) {
            // Create the StreamSource by creating StringReader using the
            // JSON input
            var json = resultObject.getJSONObject("model-ver").toString();

            // Getting the ModelVer pojo again from the json
            var modelVer = gson.fromJson(json, ModelVer.class);
            this.inventoryResponseItems.add(modelVer);
        }
    }

    public List<Serializable> getInventoryResponseItems() {
        return inventoryResponseItems;
    }

    public void setInventoryResponseItems(List<Serializable> inventoryResponseItems) {
        this.inventoryResponseItems = inventoryResponseItems;
    }

    /**
     * Get list of A&AI objects in the custom query.
     *
     * @param classOfResponse Class of the type of A&AI objects to be returned
     * @return List A&AI objects matching the class
     */
    @SuppressWarnings("unchecked")
    public <T> List<T> getItemListByType(Class<T> classOfResponse) {
        List<T> returnItemList = new ArrayList<>();
        for (Serializable i : this.inventoryResponseItems) {
            if (i.getClass() == classOfResponse) {
                returnItemList.add((T) i);
            }
        }
        return returnItemList;

    }

    /**
     * Get Service Instance.
     *
     * @return Service Instance
     */
    public ServiceInstance getServiceInstance() {
        ServiceInstance serviceInstance = null;
        for (Serializable i : this.inventoryResponseItems) {
            if (i.getClass() == ServiceInstance.class) {
                serviceInstance = (ServiceInstance) i;
            }
        }
        return serviceInstance;

    }

    /**
     * Get Tenant.
     *
     * @return Tenant
     */
    public Tenant getDefaultTenant() {
        Tenant tenant = null;
        for (Serializable i : this.inventoryResponseItems) {
            if (i.getClass() == Tenant.class) {
                tenant = (Tenant) i;
            }
        }
        return tenant;

    }

    /**
     * Get Cloud Region.
     *
     * @return Cloud Region
     */
    public CloudRegion getDefaultCloudRegion() {
        CloudRegion cloudRegion = null;
        for (Serializable i : this.inventoryResponseItems) {
            if (i.getClass() == CloudRegion.class) {
                cloudRegion = (CloudRegion) i;
            }
        }
        return cloudRegion;

    }

    /**
     * Get Generic Vnfs in the custom query.
     *
     * @return List of generic Vnf
     */
    public List<GenericVnf> getGenericVnfs() {
        List<GenericVnf> genericVnfList = new ArrayList<>();
        for (Serializable i : this.inventoryResponseItems) {
            if (i.getClass() == GenericVnf.class) {
                genericVnfList.add((GenericVnf) i);
            }
        }
        return genericVnfList;

    }

    /**
     * Returns a generic Vnf matching vnf name.
     *
     * @param vnfName Name of the vnf to match
     * @return generic Vnf
     */
    public GenericVnf getGenericVnfByVnfName(String vnfName) {
        List<GenericVnf> genericVnfList = new ArrayList<>();
        GenericVnf genericVnf = null;
        for (Serializable i : this.inventoryResponseItems) {
            if (i.getClass() == GenericVnf.class) {
                genericVnfList.add((GenericVnf) i);
            }
        }

        for (GenericVnf genVnf : genericVnfList) {
            if (vnfName.equals(genVnf.getVnfName())) {
                genericVnf = genVnf;
            }

        }
        return genericVnf;

    }

    /**
     * Returns a generic Vnf matching model invariant ID.
     *
     * @param modelInvariantId Name of the vnf to match
     * @return generic Vnf
     */
    public GenericVnf getGenericVnfByModelInvariantId(String modelInvariantId) {
        List<GenericVnf> genericVnfList = new ArrayList<>();
        GenericVnf genericVnf = null;
        for (Serializable i : this.inventoryResponseItems) {
            if (i.getClass() == GenericVnf.class) {
                genericVnfList.add((GenericVnf) i);
            }
        }

        for (GenericVnf genVnf : genericVnfList) {
            if (modelInvariantId.equals(genVnf.getModelInvariantId())) {
                genericVnf = genVnf;
            }

        }
        return genericVnf;

    }

    /**
     * Returns a generic Vnf of a given VF Module ID.
     *
     * @param vfModuleModelInvariantId of the vf module for which vnf is to be returned
     * @return generic Vnf
     */
    public GenericVnf getGenericVnfByVfModuleModelInvariantId(String vfModuleModelInvariantId) {
        List<GenericVnf> genericVnfList = this.getGenericVnfs();

        for (GenericVnf genVnf : genericVnfList) {
            // Iterate through all the vfModules of that generic Vnf
            for (VfModule vfMod : genVnf.getVfModules().getVfModule()) {
                if (vfMod.getModelInvariantId() != null
                    && vfMod.getModelInvariantId().equals(vfModuleModelInvariantId)) {
                    return genVnf;
                }
            }
        }
        return null;
    }

    /**
     * Returns the VNF given the vnf-id.
     *
     * @param vnfId The vnf-id
     * @return generic Vnf
     */
    public GenericVnf getGenericVnfByVnfId(String vnfId) {
        List<GenericVnf> genericVnfList = this.getGenericVnfs();

        for (GenericVnf genVnf : genericVnfList) {
            if (vnfId.equals(genVnf.getVnfId())) {
                return genVnf;
            }
        }

        return null;
    }

    /**
     * Get the generic vnf associated with the vserver in the custom query.
     *
     * @return Generic VNF
     */
    public GenericVnf getDefaultGenericVnf() {
        GenericVnf genericVnf = null;

        // Get the vserver associated with the query
        var vserver = this.getVserver();

        // Get the relationships of the vserver
        List<Relationship> relations = vserver.getRelationshipList().getRelationship();

        // Find the relationship of the genericVNF
        var genericVnfId = "";
        List<RelationshipData> relationshipData = null;

        // Iterate through the list of relationships and get generic vnf
        // relationship data
        for (Relationship r : relations) {
            // Get the name of generic-vnf related to this server
            if (GENERIC_VNF.equals(r.getRelatedTo())) {
                relationshipData = r.getRelationshipData();
            }
        }

        // Iterate through relationship data, and get vnf-id
        for (RelationshipData rd : relationshipData) {
            // Get the id of the generic-vnf
            if ("generic-vnf.vnf-id".equals(rd.getRelationshipKey())) {
                genericVnfId = rd.getRelationshipValue();
            }
        }

        // Get the list of generic vnfs
        List<GenericVnf> genericVnfList = this.getGenericVnfs();

        for (GenericVnf genVnf : genericVnfList) {
            if (genericVnfId.equals(genVnf.getVnfId())) {
                genericVnf = genVnf;
            }
        }

        return genericVnf;
    }

    /**
     * Get Vf Module associated with the vserver in the custom query.
     *
     * @return Vf Module
     */
    public VfModule getDefaultVfModule() {
        GenericVnf genericVnf = null;
        VfModule vfModule = null;

        // Get the vserver associated with the query
        var vserver = this.getVserver();

        // Get the relationships of the vserver
        List<Relationship> relations = vserver.getRelationshipList().getRelationship();

        // Find the relationship of VfModule
        var vfModuleId = "";
        List<RelationshipData> relationshipData = null;

        // Iterate through the list of relationships and get vf module
        // relationship data
        for (Relationship r : relations) {
            // Get relationship data of vfmodule related to this server
            if (VF_MODULE.equals(r.getRelatedTo())) {
                relationshipData = r.getRelationshipData();
            }
        }

        // Iterate through relationship data, and get vf-module-id
        for (RelationshipData rd : relationshipData) {
            // Get the id of the vf-module
            if ("vf-module.vf-module-id".equals(rd.getRelationshipKey())) {
                vfModuleId = rd.getRelationshipValue();
            }
        }

        // Get the generic VNF associated with this vserver query
        genericVnf = this.getDefaultGenericVnf();

        // Get the list of VFmodules associated with this generic Vnf
        List<VfModule> vfModuleList = genericVnf.getVfModules().getVfModule();

        for (VfModule vfMod : vfModuleList) {
            if (vfModuleId.equals(vfMod.getVfModuleId())) {
                vfModule = vfMod;
            }
        }

        return vfModule;
    }

    /**
     * Get vf modules in the custom query.
     *
     * @return List of VfModule
     */
    public List<VfModule> getAllVfModules() {
        List<VfModule> vfModuleList = new ArrayList<>();

        for (GenericVnf genVnf : this.getGenericVnfs()) {
            vfModuleList.addAll(genVnf.getVfModules().getVfModule());
        }
        return vfModuleList;

    }

    /**
     * Get Vf Module matching a specific VF module name.
     *
     * @return VfModule
     */
    public VfModule getVfModuleByVfModuleName(String vfModuleName) {
        VfModule vfModule = null;

        for (VfModule vfMod : this.getAllVfModules()) {
            if (vfModuleName.equals(vfMod.getVfModuleName())) {
                vfModule = vfMod;
            }

        }
        return vfModule;
    }

    /**
     * Get Vf Module matching a specific VF model invariant ID.
     *
     * @return VfModule
     */
    public VfModule getVfModuleByVfModelInvariantId(String vfModelInvariantId) {
        VfModule vfModule = null;

        for (VfModule vfMod : this.getAllVfModules()) {
            if (vfMod.getModelInvariantId() != null && vfModelInvariantId.equals(vfMod.getModelInvariantId())) {
                vfModule = vfMod;
            }

        }
        return vfModule;
    }

    /**
     * Get verver in the custom query.
     *
     * @return Vserver
     */
    public Vserver getVserver() {
        Vserver vserver = null;
        var index = 0;
        while (this.inventoryResponseItems.get(index).getClass() != Vserver.class) {
            index = index + 1;
        }
        vserver = (Vserver) this.inventoryResponseItems.get(index);
        return vserver;

    }

    /**
     * Get Model Versions in the custom query.
     *
     * @return List of model Versions
     */
    public List<ModelVer> getAllModelVer() {
        List<ModelVer> modelVerList = new ArrayList<>();
        for (Serializable i : this.inventoryResponseItems) {
            if (i.getClass() == ModelVer.class) {
                modelVerList.add((ModelVer) i);
            }
        }
        return modelVerList;
    }

    /**
     * Get ModelVer matching a specific version id.
     *
     * @return VfModule
     */
    public ModelVer getModelVerByVersionId(String versionId) {
        ModelVer modelVer = null;

        for (ModelVer modVersion : this.getAllModelVer()) {
            if (versionId.equals(modVersion.getModelVersionId())) {
                modelVer = modVersion;
            }

        }
        return modelVer;
    }

    /**
     * Get the count of vfModules matching customizationId, InvariantId and VersionId.
     *
     * @param custId ModelCustomizationId
     * @param invId ModelInvariantId
     * @param verId ModelVersionId
     * @return Returns the count of vf modules
     */
    public int getVfModuleCount(String custId, String invId, String verId) {
        List<VfModule> vfModuleList = this.getAllVfModules();
        var count = 0;
        for (VfModule vfModule : vfModuleList) {
            if (vfModule.getModelCustomizationId() == null || vfModule.getModelInvariantId() == null
                || vfModule.getModelVersionId() == null) {
                continue;
            }

            if (vfModule.getModelCustomizationId().equals(custId) && vfModule.getModelInvariantId().equals(invId)
                && vfModule.getModelVersionId().equals(verId)) {
                count = count + 1;
            }
        }
        return count;
    }

}