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

/*-
 * ============LICENSE_START=======================================================
 * aai
 * ================================================================================
 * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
 * Modifications Copyright (C) 2019 Nordix Foundation.
 * Modifications Copyright (C) 2019 Samsung Electronics Co., Ltd.
 * ================================================================================
 * 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.JsonSyntaxException;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
import org.json.JSONArray;
import org.json.JSONObject;
import org.onap.policy.aai.util.Serialization;
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
import org.onap.policy.rest.RestManager;
import org.onap.policy.rest.RestManager.Pair;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This class handles communication towards and responses from A&AI for this module.
 */
public final class AaiManager {

    /** The Constant logger. */
    private static final Logger logger = LoggerFactory.getLogger(AaiManager.class);

    /** The rest manager. */
    // The REST manager used for processing REST calls for this AAI manager
    private final RestManager restManager;

    /** custom query URLs. */
    private static final String CQ_URL = "/aai/v16/query?format=resource";
    private static final String TENANT_URL =
            "/aai/v16/search/nodes-query?search-node-type=vserver&filter=vserver-name:EQUALS:";
    private static final String PREFIX = "/aai/v16";


    /**
     * Constructor, create the AAI manager with the specified REST manager.
     *
     * @param restManager the rest manager to use for REST calls
     */
    public AaiManager(final RestManager restManager) {
        this.restManager = restManager;
    }

    /**
     * Creates the custom query payload from a tenant query response.
     *
     * @param getResponse response from the tenant query
     * @return String Payload
     */
    private String createCustomQueryPayload(String getResponse) {

        if (getResponse == null) {
            return null;
        } else {
            JSONObject responseObj = new JSONObject(getResponse);
            JSONArray resultsArray = new JSONArray();
            if (responseObj.has("result-data")) {
                resultsArray = (JSONArray) responseObj.get("result-data");
            } else {
                return null;
            }
            String resourceLink = resultsArray.getJSONObject(0).getString("resource-link");
            String start = resourceLink.replace(PREFIX, "");
            String query = "query/closed-loop";
            JSONObject payload = new JSONObject();
            payload.put("start", start);
            payload.put("query", query);
            return payload.toString();

        }
    }


    /**
     * This method is used to get the information for custom query.
     *
     * @param url url of the get method
     * @param username Aai username
     * @param password Aai password
     * @param requestId request ID
     * @param vserver Id of the vserver
     * @return String
     */
    private String getCustomQueryRequestPayload(String url, String username, String password, UUID requestId,
            String vserver) {

        String urlGet = url + TENANT_URL;

        String getResponse = getStringQuery(urlGet, username, password, requestId, vserver);
        return createCustomQueryPayload(getResponse);
    }



    /**
     * Calls Aai and returns a custom query response for a vserver.
     *
     * @param url Aai url
     * @param username Aai Username
     * @param password Aai Password
     * @param requestId request ID
     * @param vserver Vserver
     * @return AaiCqResponse response from Aai for custom query
     */
    public AaiCqResponse getCustomQueryResponse(String url, String username, String password, UUID requestId,
            String vserver) {

        final Map<String, String> headers = createHeaders(requestId);

        logger.debug("RestManager.put before");
        String requestJson = getCustomQueryRequestPayload(url, username, password, requestId, vserver);
        NetLoggerUtil.log(EventType.OUT, CommInfrastructure.REST, url, requestJson);

        url = url + CQ_URL;

        Pair<Integer, String> httpDetails =
                this.restManager.put(url, username, password, headers, "application/json", requestJson);
        logger.debug("RestManager.put after");

        if (httpDetails == null) {
            logger.info("AAI POST Null Response to {}", url);
            return null;
        }

        int httpResponseCode = httpDetails.first;

        logger.info(url);
        logger.info("{}", httpResponseCode);
        logger.info(httpDetails.second);

        if (httpDetails.second != null) {
            String resp = httpDetails.second;
            return new AaiCqResponse(resp);
        }
        return null;
    }



    /**
     * Returns the string response of a get query.
     *
     * @param url Aai URL
     * @param username Aai Username
     * @param password Aai Password
     * @param requestId AaiRequestId
     * @param key Aai Key
     * @return String returns the string from the get query
     */
    private String getStringQuery(final String url, final String username, final String password, final UUID requestId,
            final String key) {

        Map<String, String> headers = createHeaders(requestId);

        String urlGet = url + key;

        int attemptsLeft = 3;

        while (attemptsLeft-- > 0) {
            NetLoggerUtil.getNetworkLogger().info("[OUT|{}|{}|]", CommInfrastructure.REST, urlGet);
            Pair<Integer, String> httpDetailsGet = restManager.get(urlGet, username, password, headers);
            if (httpDetailsGet == null) {
                logger.info("AAI GET Null Response to {}", urlGet);
                return null;
            }

            int httpResponseCode = httpDetailsGet.first;

            logger.info(urlGet);
            logger.info("{}", httpResponseCode);
            logger.info(httpDetailsGet.second);

            if (httpResponseCode == 200) {
                String responseGet = httpDetailsGet.second;
                if (responseGet != null) {
                    return responseGet;
                }
            }
            try {
                Thread.sleep(1000);
            } catch (InterruptedException e) {
                Thread.currentThread().interrupt();
            }

        }

        return null;
    }


    /**
     * Post a query to A&AI.
     *
     * @param url the A&AI URL
     * @param username the user name for authentication
     * @param password the password for authentication
     * @param request the request to issue towards A&AI
     * @param requestId the UUID of the request
     * @return the response from A&AI
     */
    public AaiNqResponse postQuery(String url, String username, String password, AaiNqRequest request, UUID requestId) {

        final Map<String, String> headers = createHeaders(requestId);

        url = url + "/aai/search/named-query";

        logger.debug("RestManager.post before");
        String requestJson = Serialization.gsonPretty.toJson(request);
        NetLoggerUtil.log(EventType.OUT, CommInfrastructure.REST, url, requestJson);
        Pair<Integer, String> httpDetails =
                restManager.post(url, username, password, headers, "application/json", requestJson);
        logger.debug("RestManager.post after");

        if (httpDetails == null) {
            logger.info("AAI POST Null Response to {}", url);
            return null;
        }

        int httpResponseCode = httpDetails.first;

        logger.info(url);
        logger.info("{}", httpResponseCode);
        logger.info(httpDetails.second);

        if (httpDetails.second != null) {
            return composeResponse(httpDetails, url, AaiNqResponse.class);
        }
        return null;
    }

    /**
     * Perform a GET request for a particular virtual server towards A&AI.
     *
     * @param urlGet the A&AI URL
     * @param username the user name for authentication
     * @param password the password for authentication
     * @param requestId the UUID of the request
     * @param key the key of the virtual server
     * @return the response for the virtual server from A&AI
     */
    public AaiGetVserverResponse getQueryByVserverName(String urlGet, String username, String password, UUID requestId,
            String key) {
        return getQuery(urlGet, username, password, requestId, key, AaiGetVserverResponse.class);
    }

    /**
     * Perform a GET request for a particular VNF by VNF ID towards A&AI.
     *
     * @param urlGet the A&AI URL
     * @param username the user name for authentication
     * @param password the password for authentication
     * @param requestId the UUID of the request
     * @param key the ID of the VNF
     * @return the response for the virtual server from A&AI
     */
    public AaiGetVnfResponse getQueryByVnfId(String urlGet, String username, String password, UUID requestId,
            String key) {
        return getQuery(urlGet, username, password, requestId, key, AaiGetVnfResponse.class);
    }

    /**
     * Perform a GET request for a particular VNF by VNF name towards A&AI.
     *
     * @param urlGet the A&AI URL
     * @param username the user name for authentication
     * @param password the password for authentication
     * @param requestId the UUID of the request
     * @param key the name of the VNF
     * @return the response for the virtual server from A&AI
     */
    public AaiGetVnfResponse getQueryByVnfName(String urlGet, String username, String password, UUID requestId,
            String key) {
        return getQuery(urlGet, username, password, requestId, key, AaiGetVnfResponse.class);
    }

    /**
     * Perform a GET query for a particular entity towards A&AI.
     *
     * @param <T> the generic type for the response
     * @param urlGet the A&AI URL
     * @param username the user name for authentication
     * @param password the password for authentication
     * @param requestId the UUID of the request
     * @param key the name of the VNF
     * @param classOfT the class of the response to return
     * @return the response for the virtual server from A&AI
     */
    private <T> T getQuery(final String url, final String username, final String password, final UUID requestId,
            final String key, final Class<T> classOfResponse) {

        Map<String, String> headers = createHeaders(requestId);

        String urlGet = url + key;

        int attemptsLeft = 3;

        while (attemptsLeft-- > 0) {
            NetLoggerUtil.getNetworkLogger().info("[OUT|{}|{}|]", CommInfrastructure.REST, urlGet);
            Pair<Integer, String> httpDetailsGet = restManager.get(urlGet, username, password, headers);
            if (httpDetailsGet == null) {
                logger.info("AAI GET Null Response to {}", urlGet);
                return null;
            }

            int httpResponseCode = httpDetailsGet.first;

            logger.info(urlGet);
            logger.info("{}", httpResponseCode);
            logger.info(httpDetailsGet.second);

            if (httpResponseCode == 200) {
                T responseGet = composeResponse(httpDetailsGet, urlGet, classOfResponse);
                if (responseGet != null) {
                    return responseGet;
                }
            }
            try {
                Thread.sleep(1000);
            } catch (InterruptedException e) {
                Thread.currentThread().interrupt();
            }

        }

        return null;
    }

    /**
     * Create the headers for the HTTP request.
     *
     * @param requestId the request ID to insert in the headers
     * @return the HTTP headers
     */
    private Map<String, String> createHeaders(final UUID requestId) {
        Map<String, String> headers = new HashMap<>();

        headers.put("X-FromAppId", "POLICY");
        headers.put("X-TransactionId", requestId.toString());
        headers.put("Accept", "application/json");

        return headers;
    }


    /**
     * This method uses Google's GSON to create a response object from a JSON string.
     *
     * @param <T> the generic type
     * @param httpDetails the HTTP response
     * @param url the URL from which the response came
     * @param classOfResponse The response class
     * @return an instance of the response class
     * @throws JsonSyntaxException on GSON errors instantiating the response
     */
    private <T> T composeResponse(final Pair<Integer, String> httpDetails, final String url,
            final Class<T> classOfResponse) {
        try {
            T response = Serialization.gsonPretty.fromJson(httpDetails.second, classOfResponse);
            NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, url, httpDetails.second);
            return response;
        } catch (JsonSyntaxException e) {
            logger.error("postQuery threw: ", e);
            return null;
        }
    }
}