/**
* Copyright 2018-2023 ZTE Corporation.
*
* 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.
*/
package org.onap.holmes.common.aai;
import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
import jakarta.ws.rs.client.Entity;
import org.onap.holmes.common.aai.config.AaiConfig;
import org.onap.holmes.common.config.MicroServiceConfig;
import org.onap.holmes.common.utils.JerseyClient;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.HashMap;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class AaiQuery4Ccvpn {
private final Logger log = LoggerFactory.getLogger(AaiQuery4Ccvpn.class);
private Map headers;
public static AaiQuery4Ccvpn newInstance() {
return new AaiQuery4Ccvpn();
}
private static final String EMPTY_STR = "";
private static final JsonObject EMPTY_JSON = new JsonObject();
private AaiQuery4Ccvpn() {
headers = new HashMap<>();
headers.put("X-TransactionId", AaiConfig.X_TRANSACTION_ID);
headers.put("X-FromAppId", AaiConfig.X_FROMAPP_ID);
headers.put("Authorization", AaiConfig.getAuthenticationCredentials());
headers.put("Accept", "application/json");
headers.put("Content-Type", "application/json");
}
/**
* Query the logic link information for AAI. This method is based on the API:
* https://:/aai/v14/network/network-resources/network-resource/{networkId}/pnfs/pnf/{pnfName}/p-interfaces?interface-name={ifName}&operational-status={status}
* provided by AAI.
*
* @param networkId
* @param pnfName
* @param ifName
* @param status
* @return the ID of the logic link
*/
public String getLogicLink(String networkId, String pnfName, String ifName, String status) {
Map params = new HashMap<>();
params.put("networkId", networkId);
params.put("pnfName", pnfName);
params.put("ifName", ifName);
String response = get(getPath(AaiConfig.AaiConsts.AAI_LINK_QUERY, params)
+ (status == null ? "" : String.format("&operational-status=%s", status)));
JsonObject linkInfo = getInfo(response, "p-interface", "logical-link");
if (linkInfo == null) {
log.warn(String.format("Link information is missing from AAI. Method: [getLogicLink], " +
"params: [networkId - %s, pnfName - %s, ifName - %s].", networkId, pnfName, ifName));
return EMPTY_STR;
}
return extractValueFromJsonArray(linkInfo.get("relationship-data").getAsJsonArray(), "logical-link.link-name");
}
/**
* Query the service instances related to a terminal point. This method is mainly based on the API:
* https://:/aai/v14/network/connectivities?connectivity-id={connectivityId}
* and
* https://:/aai/v14/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}
* provided by AAI. The path for getting the required instance information is: p-interface → vpn-vpnbinding → connectivity → service instance
*
* @param networkId
* @param pnfName
* @param ifName
* @param status
* @return service instances in JSONObject format
*/
public JsonObject getServiceInstance(String networkId, String pnfName, String ifName, String status) {
JsonObject vpnBindingInfo = getVpnBindingInfo(networkId, pnfName, ifName, status);
if (vpnBindingInfo == null) {
log.warn(String.format("VPN binding information is missing from AAI. " +
"Method: [getServiceInstance], params: [networkId - %s, pnfName - %s, " +
"ifName - %s, status - %s].", networkId, pnfName, ifName, status));
return EMPTY_JSON;
}
String vpnBindingId = extractValueFromJsonArray(vpnBindingInfo.get("relationship-data").getAsJsonArray(),
"vpn-binding.vpn-id");
JsonObject connectivityInfo = getConnectivityInfo(vpnBindingId);
if (connectivityInfo == null) {
log.warn(String.format("Connectivity information is missing from AAI. " +
"Method: [getServiceInstance], params: [networkId - %s, pnfName - %s, " +
"ifName - %s, status - %s].", networkId, pnfName, ifName, status));
return EMPTY_JSON;
}
String connectivityId = extractValueFromJsonArray(connectivityInfo.get("relationship-data").getAsJsonArray(),
"connectivity.connectivity-id");
JsonObject serviceInstanceInfo = getServiceInstanceByConn(connectivityId);
if (serviceInstanceInfo == null) {
log.warn(String.format("Service instance information is missing from AAI. " +
"Method: [getServiceInstance], params: [networkId - %s, pnfName - %s, " +
"ifName - %s, status - %s].", networkId, pnfName, ifName, status));
return EMPTY_JSON;
}
String serviceInstancePath = serviceInstanceInfo.get("related-link").getAsString();
String response = get(serviceInstancePath);
JsonObject instance = JsonParser.parseString(response).getAsJsonObject();
String[] params = new String[2];
Pattern pattern = Pattern.compile("/aai/v\\d+/business/customers/customer/(.+)" +
"/service-subscriptions/service-subscription/(.+)" +
"/service-instances/service-instance/(.+)");
Matcher matcher = pattern.matcher(serviceInstancePath);
if (matcher.find()) {
params[0] = matcher.group(1);
params[1] = matcher.group(2);
}
instance.addProperty("globalSubscriberId", params[0]);
instance.addProperty("serviceType", params[1]);
return instance;
}
public void updateTerminalPointStatus(String networkId, String pnfName, String ifName,
Map body) {
Map params = new HashMap<>();
params.put("networkId", networkId);
params.put("pnfName", pnfName);
params.put("ifName", ifName);
String r = get(getPath(AaiConfig.AaiConsts.AAI_TP_UPDATE, params));
JsonObject jsonObject = JsonParser.parseString(r).getAsJsonObject();
body.put("resource-version", jsonObject.get("resource-version").toString());
put(getPath(AaiConfig.AaiConsts.AAI_TP_UPDATE, params), body);
}
public void updateLogicLinkStatus(String linkName, Map body) {
String r = get(getPath(AaiConfig.AaiConsts.AAI_LINK_UPDATE, "linkName", linkName));
JsonObject jsonObject = JsonParser.parseString(r).getAsJsonObject();
body.put("resource-version", jsonObject.get("resource-version").toString());
body.put("link-type", jsonObject.get("link-type").toString());
put(getPath(AaiConfig.AaiConsts.AAI_LINK_UPDATE, "linkName", linkName), body);
}
private JsonObject getVpnBindingInfo(String networkId, String pnfName,
String ifName, String status) {
Map params = new HashMap();
params.put("networkId", networkId);
params.put("pnfName", pnfName);
params.put("ifName", ifName);
params.put("status", status);
String response = get(getPath(AaiConfig.AaiConsts.AAI_VPN_ADDR, params));
return getInfo(response, "p-interface", "vpn-binding");
}
private JsonObject getConnectivityInfo(String vpnId) {
String response = get(getPath(AaiConfig.AaiConsts.AAI_CONN_ADDR, "vpnId", vpnId));
return getInfo(response, "vpn-binding", "connectivity");
}
private JsonObject getServiceInstanceByConn(String connectivityId) {
String response = get(getPath(AaiConfig.AaiConsts.AAI_SERVICE_INSTANCE_ADDR_4_CCVPN,
"connectivityId", connectivityId));
return getInfo(response, "connectivity", "service-instance");
}
private String getPath(String urlTemplate, Map pathParams) {
String url = urlTemplate;
for (Map.Entry entry : pathParams.entrySet()) {
url = url.replaceAll("\\{" + entry.getKey() + "\\}", entry.getValue());
}
return url;
}
private String getPath(String urlTemplate, String paramName, String paramValue) {
return urlTemplate.replaceAll("\\{" + paramName + "\\}", paramValue);
}
private String getPath(String serviceInstancePath) {
Pattern pattern = Pattern.compile("/aai/(v\\d+)/([A-Za-z0-9\\-]+[^/])(/*.*)");
Matcher matcher = pattern.matcher(serviceInstancePath);
String ret = "/api";
if (matcher.find()) {
ret += "/aai-" + matcher.group(2) + "/" + matcher.group(1) + matcher.group(3);
}
return ret;
}
private JsonObject getInfo(String response, String pField, String field) {
JsonObject jObject = JsonParser.parseString(response).getAsJsonObject();
JsonObject pInterface = extractJsonObject(jObject, pField);
if (pInterface == null) {
pInterface = jObject;
}
JsonObject relationshipList = extractJsonObject(pInterface, "relationship-list");
JsonArray relationShip = extractJsonArray(relationshipList, "relationship");
if (relationShip != null) {
for (int i = 0; i < relationShip.size(); ++i) {
final JsonObject object = relationShip.get(i).getAsJsonObject();
if (object.get("related-to").getAsString().equals(field)) {
return object;
}
}
}
return null;
}
private JsonObject extractJsonObject(JsonObject obj, String key) {
if (obj != null && key != null && obj.has(key)) {
return obj.get(key).getAsJsonObject();
}
return null;
}
private JsonArray extractJsonArray(JsonObject obj, String key) {
if (obj != null && key != null && obj.has(key)) {
return obj.get(key).getAsJsonArray();
}
return null;
}
private String extractValueFromJsonArray(JsonArray relationshipData, String keyName) {
if (relationshipData != null) {
for (int i = 0; i < relationshipData.size(); ++i) {
JsonObject item = relationshipData.get(i).getAsJsonObject();
if (item.get("relationship-key").getAsString().equals(keyName)) {
return item.get("relationship-value").getAsString();
}
}
}
return null;
}
private String get(String path) {
return JerseyClient.newInstance().path(path).headers(headers).get(MicroServiceConfig.getAaiAddr());
}
private String put(String path, Map body) {
return JerseyClient.newInstance().path(path).headers(headers).put(MicroServiceConfig.getAaiAddr(), Entity.json(body));
}
}