Add API - AWS API mapping, add gateway feature catalog to the publisher settings api

Author: dakshina99

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/APIConstants.java

@@ -3203,8 +3203,10 @@ public enum ConfigType {
 
 
     public static final String WSO2_GATEWAY_ENVIRONMENT = "wso2";
+    public static final String EXTERNAL_GATEWAY_VENDOR = "external";
     public static final String WSO2_APK_GATEWAY = "wso2/apk";
     public static final String WSO2_SYNAPSE_GATEWAY = "wso2/synapse";
+    public static final String AWS_GATEWAY = "AWS";
 
     public static final String PERMISSION_ALLOW = "ALLOW";
     public static final String PERMISSION_DENY = "DENY";

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/dao/ApiMgtDAO.java

@@ -15388,6 +15388,46 @@ public Environment updateEnvironment(Environment environment) throws APIManageme
         return environment;
     }
 
+    /**
+     * Add API - AWS API mapping
+     *
+     * @param apiId API ID
+     * @param aWSApiId AWS API ID
+     * @param environmentId Gateway environment ID
+     * @throws APIManagementException if failed to add the mapping
+     */
+    public void addApiAWSApiMapping(String apiId, String aWSApiId, String environmentId)
+            throws APIManagementException {
+        Connection connection = null;
+        PreparedStatement prepStmt = null;
+        String query = SQLConstants.ADD_API_AWS_API_MAPPING;
+
+        try {
+            connection = APIMgtDBUtil.getConnection();
+            connection.setAutoCommit(false);
+
+            prepStmt = connection.prepareStatement(query);
+            prepStmt.setString(1, apiId);
+            prepStmt.setString(2, aWSApiId);
+            prepStmt.setString(3, environmentId);
+            prepStmt.execute();
+
+            connection.commit();
+        } catch (SQLException e) {
+            try {
+                if (connection != null) {
+                    connection.rollback();
+                }
+            } catch (SQLException ex) {
+                log.error("Failed to rollback the add API - AWS API Mapping: API ID: "
+                        + apiId + " AWS API ID: " + aWSApiId, ex);
+            }
+            handleException("Error while adding mapping between API ID: " + apiId + " and AWS API ID: " + aWSApiId, e);
+        } finally {
+            APIMgtDBUtil.closeAllConnections(prepStmt, connection, null);
+        }
+    }
+
     private boolean isEmptyValuesInApplicationAttributesEnabled() {
         return Boolean.parseBoolean(ServiceReferenceHolder.getInstance().getAPIManagerConfigurationService().
                 getAPIManagerConfiguration().getFirstProperty(APIConstants.ApplicationAttributes.

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/dao/constants/SQLConstants.java

@@ -2761,6 +2761,9 @@ public class SQLConstants {
             "SET DISPLAY_NAME = ?, DESCRIPTION = ?, CONFIGURATION = ?" +
             "WHERE UUID = ?";
 
+    public static final String ADD_API_AWS_API_MAPPING = "INSERT INTO AM_API_AWS_API_MAPPING " +
+            "(API_ID, AWS_API_ID, GATEWAY_ENV_ID) VALUES (?, ?, ?)";
+
     public static final String ADD_GATEWAY_VISIBILITY_PERMISSION_SQL =
             " INSERT INTO" +
                     " AM_GATEWAY_PERMISSIONS (GATEWAY_UUID, PERMISSIONS_TYPE, ROLE)" +

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/deployer/ExternalGatewayDeployer.java

@@ -35,7 +35,7 @@ public interface ExternalGatewayDeployer {
      * @param environment Environment to be deployed
      * @throws DeployerException if error occurs when deploying APIs to in the external gateway
      */
-    public boolean deploy(API api, Environment environment) throws DeployerException;
+    public String deploy(API api, Environment environment) throws DeployerException;
 
     /**
      * Undeploy API artifact from provided environment

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/notifier/ExternalGatewayNotifier.java

@@ -43,7 +43,7 @@ public class ExternalGatewayNotifier extends DeployAPIInGatewayNotifier {
 
     @Override
     public boolean publishEvent(Event event) throws NotifierException {
-        if (APIUtil.isAnyExternalGateWayProviderExists()) {
+        if (APIUtil.isAnyExternalGateWayProviderExists(event.getTenantDomain())) {
             apiMgtDAO = ApiMgtDAO.getInstance();
             process(event);
         }
@@ -75,7 +75,7 @@ private void process(Event event) throws NotifierException {
      */
     private void deployApi(DeployAPIInGatewayEvent deployAPIInGatewayEvent) throws NotifierException {
 
-        boolean deployed;
+        String deployedID;
         Set<String> gateways = deployAPIInGatewayEvent.getGatewayLabels();
         String apiId = deployAPIInGatewayEvent.getUuid();
 
@@ -91,13 +91,18 @@ private void deployApi(DeployAPIInGatewayEvent deployAPIInGatewayEvent) throws N
                             (environments.get(deploymentEnv).getProvider());
                     if (deployer != null) {
                         try {
-                            deployed = deployer.deploy(api, environments.get(deploymentEnv));
-                            if (!deployed) {
-                                throw new APIManagementException("Error while deploying API product to Solace broker");
+                            Environment gatewayEnvironment = environments.get(deploymentEnv);
+                            deployedID = deployer.deploy(api, gatewayEnvironment);
+                            if (deployedID == null) {
+                                throw new APIManagementException("Error while deploying API to the external gateway");
+                            }
+                            if (deployer.getType().equals(APIConstants.AWS_GATEWAY)) {
+                                APIUtil.addApiAWSApiMapping(apiId, deployedID, gatewayEnvironment.getUuid());
                             }
                         } catch (DeployerException e) {
                             throw new APIManagementException(e.getMessage());
                         }
+
                     }
                 }
             }

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/utils/APIUtil.java

@@ -355,6 +355,112 @@ public final class APIUtil {
     private static final String contextRegex = "^[a-zA-Z0-9_${}/.;()-]+$";
     private static String hashingAlgorithm = SHA_256;
 
+    private static final String SYNAPSE_GATEWAY_FEATURES = "{\n" +
+            "            \"runtime\": [\n" +
+            "                \"cors\",\n" +
+            "                \"schemaValidation\",\n" +
+            "                \"queryAnalysis\",\n" +
+            "                \"responseCaching\",\n" +
+            "                \"transportsHTTP\",\n" +
+            "                \"transportsHTTPS\",\n" +
+            "                \"transportsMutualSSL\",\n" +
+            "                \"oauth2\",\n" +
+            "                \"apikey\",\n" +
+            "                \"basicAuth\",\n" +
+            "                \"audienceValidation\",\n" +
+            "                \"backendThroughput\",\n" +
+            "                \"keyManagerConfig\"\n" +
+            "            ],\n" +
+            "            \"resources\": [\n" +
+            "                \"apiLevelRateLimiting\",\n" +
+            "                \"operationLevelRateLimiting\",\n" +
+            "                \"operationSecurity\"\n" +
+            "            ],\n" +
+            "            \"localScopes\": [\n" +
+            "                \"operationScopes\"\n" +
+            "            ],\n" +
+            "            \"monetization\": [\n" +
+            "                \"monetization\"\n" +
+            "            ],\n" +
+            "            \"subscriptions\": [\n" +
+            "                \"subscriptions\"\n" +
+            "            ],\n" +
+            "            \"endpoints\": [\n" +
+            "                \"http\",\n" +
+            "                \"service\",\n" +
+            "                \"address\",\n" +
+            "                \"default\",\n" +
+            "                \"INLINE\",\n" +
+            "                \"dynamic\",\n" +
+            "                \"awslambda\",\n" +
+            "                \"sequence_backend\",\n" +
+            "                \"advancedConfigurations\",\n" +
+            "                \"loadBalanceAndFailoverConfigurations\",\n" +
+            "                \"endpointSecurity\"\n" +
+            "            ]\n" +
+            "        }";
+    private static final String APK_GATEWAY_FEATURES = "{\n" +
+            "            \"runtime\": [\n" +
+            "                \"cors\",\n" +
+            "                \"transportsHTTP\",\n" +
+            "                \"transportsHTTPS\",\n" +
+            "                \"transportsMutualSSL\",\n" +
+            "                \"oauth2\",\n" +
+            "                \"apikey\",\n" +
+            "                \"basicAuth\",\n" +
+            "                \"audienceValidation\"\n" +
+            "            ],\n" +
+            "            \"resources\": [\n" +
+            "                \"apiLevelRateLimiting\",\n" +
+            "                \"operationLevelRateLimiting\"\n" +
+            "            ],\n" +
+            "            \"localScopes\": [\n" +
+            "                \"operationScopes\"\n" +
+            "            ],\n" +
+            "            \"monetization\": [\n" +
+            "                \"monetization\"\n" +
+            "            ],\n" +
+            "            \"subscriptions\": [\n" +
+            "                \"subscriptions\"\n" +
+            "            ],\n" +
+            "            \"endpoints\": [\n" +
+            "                \"http\"\n" +
+            "            ]\n" +
+            "        }";
+    private static final String API_DATA = "{\n" +
+            "        \"rest\": [\n" +
+            "            \"wso2/synapse\",\n" +
+            "            \"wso2/apk\",\n" +
+            "            \"AWS\"\n" +
+            "        ],\n" +
+            "        \"soap\": [\n" +
+            "            \"wso2/synapse\",\n" +
+            "            \"wso2/apk\"\n" +
+            "        ],\n" +
+            "        \"graphql\": [\n" +
+            "            \"wso2/synapse\",\n" +
+            "            \"wso2/apk\"\n" +
+            "        ],\n" +
+            "        \"ws\": [\n" +
+            "            \"wso2/synapse\",\n" +
+            "            \"wso2/apk\",\n" +
+            "            \"AWS\"\n" +
+            "            ],\n" +
+            "        \"wh\": [\n" +
+            "            \"wso2/synapse\",\n" +
+            "            \"wso2/apk\"\n" +
+            "        ],\n" +
+            "        \"sse\": [\n" +
+            "            \"wso2/synapse\",\n" +
+            "            \"wso2/apk\"\n" +
+            "        ],\n" +
+            "        \"ai\": [\n" +
+            "            \"wso2/synapse\",\n" +
+            "            \"wso2/apk\",\n" +
+            "            \"AWS\"\n" +
+            "        ]\n" +
+            "    }";
+
     private APIUtil() {
 
     }
@@ -389,6 +495,7 @@ private APIUtil() {
     private static double retryProgressionFactor;
     private static String gatewayTypes;
     private static int maxRetryCount;
+    private static Gson gatewayFeatureCatalog;
 
     //constants for getting masked token
     private static final int MAX_LEN = 36;
@@ -3334,11 +3441,84 @@ public static List<String> getGatewayTypes () {
         // Get the gateway types from the deployment.toml
         List<String> gatewayTypesList = new ArrayList<>();
         if (gatewayTypes != null && !gatewayTypes.isEmpty()) {
-            gatewayTypesList = Arrays.asList(gatewayTypes.split(","));
+            gatewayTypesList = Arrays.asList(gatewayTypes.replace(" ", "").split(","));
         }
         return gatewayTypesList;
     }
 
+    public static String getGatewayFeatureCatalog() {
+        Gson gson = new Gson();
+
+        JsonObject synapseJSON = gson.fromJson(SYNAPSE_GATEWAY_FEATURES, JsonObject.class);
+        JsonObject apkJSON = gson.fromJson(APK_GATEWAY_FEATURES, JsonObject.class);
+        JsonObject apiData = gson.fromJson(API_DATA, JsonObject.class);
+
+        JsonObject gatewayFeatures = new JsonObject();
+        gatewayFeatures.add(APIConstants.WSO2_SYNAPSE_GATEWAY, synapseJSON);
+        gatewayFeatures.add(APIConstants.WSO2_APK_GATEWAY, apkJSON);
+
+        // Loop this part for each federated gateway type
+        String awsConfigs = "{\n" +
+                "    \"AWS\":{\n" +
+                "        \"apiTypes\":[\n" +
+                "            \"rest\",\n" +
+                "            \"ws\",\n" +
+                "            \"ai\"\n" +
+                "        ],\n" +
+                "        \"gatewayFeatures\":{\n" +
+                "            \"runtime\":[\n" +
+                "                \"cors\",\n" +
+                "                \"transportsHTTP\",\n" +
+                "                \"transportsHTTPS\",\n" +
+                "                \"transportsMutualSSL\",\n" +
+                "                \"oauth2\",\n" +
+                "                \"apikey\",\n" +
+                "                \"basicAuth\",\n" +
+                "                \"audienceValidation\"\n" +
+                "            ],\n" +
+                "            \"resources\":[\n" +
+                "                \"apiLevelRateLimiting\"\n" +
+                "            ],\n" +
+                "            \"localScopes\":[\n" +
+                "                \"operationScopes\"\n" +
+                "            ],\n" +
+                "            \"monetization\":[\n" +
+                "                \"monetization\"\n" +
+                "            ],\n" +
+                "            \"subscriptions\":[\n" +
+                "                \"subscriptions\"\n" +
+                "            ],\n" +
+                "            \"endpoints\":[\n" +
+                "                \"http\"\n" +
+                "            ]\n" +
+                "        }\n" +
+                "    }\n" +
+                "}"; // comes from API call
+        JsonObject awsConfigsJSON = gson.fromJson(awsConfigs, JsonObject.class);
+        Set<String> keys = awsConfigsJSON.keySet();
+        String gatewayType = keys.iterator().next();
+
+        JsonObject awsConfigsJSONValue = awsConfigsJSON.getAsJsonObject(gatewayType);
+
+        JsonObject awsGatewayFeatures = awsConfigsJSONValue.getAsJsonObject("gatewayFeatures");
+        gatewayFeatures.add(gatewayType, awsGatewayFeatures);
+
+        JsonArray awsApiTypes = awsConfigsJSONValue.getAsJsonArray("apiTypes");
+        for (int i = 0; i < awsApiTypes.size(); i++) {
+            String apiType = awsApiTypes.get(i).getAsString();
+            if (apiData.has(apiType)) {
+                JsonArray existingGateways = apiData.getAsJsonArray(apiType);
+                existingGateways.add(gatewayType);
+            }
+        }
+
+        JsonObject result = new JsonObject();
+        result.add("gatewayFeatures", gatewayFeatures);
+        result.add("apiTypes", apiData);
+
+        return result.toString();
+    }
+
     /**
      * Returns whether API Publisher Access Control is enabled or not
      *
@@ -8156,6 +8336,12 @@ public static Map<String, Environment> getEnvironments(String organization) thro
         return allEnvironments;
     }
 
+    public static void addApiAWSApiMapping(String apiId, String aWSApiId, String environmentId)
+            throws APIManagementException {
+
+        ApiMgtDAO.getInstance().addApiAWSApiMapping(apiId, aWSApiId, environmentId);
+    }
+
     /**
      * Get gateway environments defined in the configuration: api-manager.xml
      * @return map of configured environments against environment name
@@ -10181,13 +10367,16 @@ public static Map<String, org.wso2.carbon.apimgt.api.APIDefinition> getApiDefini
     /**
      * Check whether there are external environments registered
      */
-    public static boolean isAnyExternalGateWayProviderExists() {
-
-        Map<String, Environment> gatewayEnvironments = APIUtil.getReadOnlyGatewayEnvironments();
-        for (Environment environment : gatewayEnvironments.values()) {
-            if (!APIConstants.WSO2_GATEWAY_ENVIRONMENT.equals(environment.getProvider())) {
-                return true;
+    public static boolean isAnyExternalGateWayProviderExists(String tenantDomain) {
+        try {
+            Map<String, Environment> environments = getEnvironments(tenantDomain);
+            for (Environment environment : environments.values()) {
+                if (!APIConstants.WSO2_GATEWAY_ENVIRONMENT.equals(environment.getProvider())) {
+                    return true;
+                }
             }
+        } catch (APIManagementException e) {
+            throw new RuntimeException(e);
         }
         return false;
     }
@@ -10600,10 +10789,8 @@ public static String setSubscriptionValidationStatusBeforeInsert(Set<Tier> tiers
      * @return gateway vendor for the API
      */
     public static String setGatewayVendorBeforeInsertion(String gatewayVendorType, String gatewayType) {
-        if (gatewayType != null && APIConstants.WSO2_APK_GATEWAY.equals(gatewayType)) {
-            gatewayVendorType =  APIConstants.WSO2_APK_GATEWAY;
-        }
-        return gatewayVendorType;
+
+        return !APIConstants.WSO2_SYNAPSE_GATEWAY.equals(gatewayType) ? gatewayType: gatewayVendorType;
     }
 
     /**
@@ -10616,8 +10803,8 @@ public static String getGatewayType(String gatewayVendor) {
         String gatewayType = null;
         if (APIConstants.WSO2_GATEWAY_ENVIRONMENT.equals(gatewayVendor)) {
             gatewayType = APIConstants.WSO2_SYNAPSE_GATEWAY;
-        } else if (APIConstants.WSO2_APK_GATEWAY.equals(gatewayVendor)) {
-            gatewayType = APIConstants.WSO2_APK_GATEWAY;
+        } else {
+            return gatewayVendor;
         }
         return gatewayType;
     }
@@ -10629,10 +10816,12 @@ public static String getGatewayType(String gatewayVendor) {
      * @return wso2 gateway vendor type
      */
     public static String handleGatewayVendorRetrieval(String gatewayVendor) {
-        if (APIConstants.WSO2_APK_GATEWAY.equals(gatewayVendor)) {
-            gatewayVendor = APIConstants.WSO2_GATEWAY_ENVIRONMENT;
+        if (APIConstants.WSO2_APK_GATEWAY.equals(gatewayVendor) ||
+                APIConstants.WSO2_GATEWAY_ENVIRONMENT.equals(gatewayVendor)) {
+            return APIConstants.WSO2_GATEWAY_ENVIRONMENT;
+        } else {
+            return APIConstants.EXTERNAL_GATEWAY_VENDOR;
         }
-        return  gatewayVendor;
     }
 
     /**