Add: Support Custom Sequence as a Backend of an API

components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/APIProvider.java

@@ -33,6 +33,7 @@
 import org.wso2.carbon.apimgt.api.model.policy.SubscriptionPolicy;
 
 import java.io.ByteArrayInputStream;
+import java.io.InputStream;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
@@ -65,6 +66,31 @@ public interface APIProvider extends APIManager {
     Comment getComment(ApiTypeWrapper apiTypeWrapper, String commentId, Integer replyLimit, Integer replyOffset) throws
             APIManagementException;
 
+    /**
+     * This method is to delete Sequence Backend by type
+     *
+     * @param apiUUID API Id
+     * @param type    Key type
+     * @throws APIManagementException If failed to delete Sequence Backend
+     */
+    void deleteCustomBackendByID(String apiUUID, String type) throws APIManagementException;
+
+    /**
+     * This method is to delete all Sequence Backends by APIID
+     *
+     * @param apiUUID API ID
+     * @throws APIManagementException If failed to delete Sequence Backend
+     */
+    void deleteCustomBackendByAPIID(String apiUUID) throws APIManagementException;
+
+    /**
+     * This method is to delete Sequence Backends of a specific revision
+     * @param apiUUID API Id
+     * @param revisionId Revision Id
+     * @throws APIManagementException If failed to delete Sequence Backend
+     */
+    void deleteSequenceBackendByRevision(String apiUUID, String revisionId) throws APIManagementException;
+
     /**
      * @param apiTypeWrapper  Api type wrapper
      * @param parentCommentID
@@ -315,6 +341,39 @@ List<SubscribedAPI> getSubscriptionsOfAPI(String apiName, String apiVersion, Str
      */
     API updateAPI(API api, API existingAPI) throws APIManagementException, FaultGatewaysException;
 
+    /**
+     * This method is to update Sequence Backend
+     *
+     * @param api               API
+     * @param type              Key Type
+     * @param sequence          Sequence Content
+     * @param seqName           Sequence Name
+     * @param customBackendUUID Sequence Id
+     * @throws APIManagementException If not updated
+     */
+    void updateCustomBackend(String api, String type, String sequence, String seqName, String customBackendUUID)
+            throws APIManagementException;
+
+    /**
+     * THis method is to retrieve Sequence Backend data
+     *
+     * @param apiUUID API Id
+     * @param type    Key Type
+     * @return SequenceBackendData object
+     * @throws APIManagementException If data is not properly retrieved
+     */
+    SequenceBackendData getCustomBackendByAPIUUID(String apiUUID, String type) throws APIManagementException;
+
+    /**
+     * This method is to retrieve all Sequence Backends of an API
+     *
+     * @param apiUUID API Id
+     * @return List of Sequence Backends
+     * @throws APIManagementException If not found
+     */
+
+    List<SequenceBackendData> getAllSequenceBackendsByAPIUUID(String apiUUID) throws APIManagementException;
+
     /**
      * Create a new version of the <code>api</code>, with version <code>newVersion</code>
      *

components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/ExceptionCodes.java

@@ -482,6 +482,9 @@ public enum ExceptionCodes implements ErrorHandler {
     // API import/export related codes
     ERROR_READING_META_DATA(900907, "Error while reading meta information from the definition", 400,
             "Error while reading meta information from the definition"),
+
+    ERROR_READING_CUSTOM_SEQUENCE(900908, "Error while reading Custom Sequence from the API Endpoint Configuration",
+            400, "Error while reading Custom Sequence from the API Endpoint Configuration"),
     ERROR_READING_PARAMS_FILE(900908, "Error while reading meta information from the params file", 400,
             "Error while reading meta information from the params file"),
     ERROR_FETCHING_DEFINITION_FILE(900909, "Cannot find the definition file of the project", 400,
@@ -531,6 +534,8 @@ public enum ExceptionCodes implements ErrorHandler {
             "Required attributes(s) %s for api policy specification %s are either missing or empty"),
     OPERATION_POLICY_NOT_FOUND(902010, "API Policy Not Found", 404,
             "Requested api policy with id '%s' not found"),
+    CUSTOM_BACKEND_NOT_FOUND(903250, "Sequence Backend not found",
+            404, "Requested Sequence Backend of API '%s' not found"),
 
     OPERATION_POLICY_ALREADY_EXISTS(903001, "The API Policy already exists.", 409, "An Operation Policy with name '%s' and version '%s' already exists"),
 

components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/model/API.java

@@ -86,6 +86,7 @@ public class API implements Serializable {
     private boolean apiResourcePatternsChanged;
 
     private String status;
+    private String sequence;
 
     private String technicalOwner;
     private String technicalOwnerEmail;
@@ -786,6 +787,14 @@ public void setRating(float rating) {
         this.rating = rating;
     }
 
+    public void setSequence(String sequence) {
+        this.sequence = sequence;
+    }
+
+    public String getSequence() {
+        return sequence;
+    }
+
     public void setLatest(boolean latest) {
         isLatest = latest;
     }

components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/model/SequenceBackendData.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright (c) 2024, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+ *
+ * WSO2 Inc. licenses this file to you 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.wso2.carbon.apimgt.api.model;
+
+public class SequenceBackendData {
+    private String Id;
+    private String sequence;
+    private String type;
+    private String name;
+    private String apiUUID;
+    private String revisionUUID;
+
+    public String getSequence() {
+        return sequence;
+    }
+
+    public void setSequence(String sequence) {
+        this.sequence = sequence;
+    }
+
+    public String getId() {
+        return Id;
+    }
+
+    public void setId(String id) {
+        Id = id;
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    public void setType(String type) {
+        this.type = type;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getApiUUID() {
+        return apiUUID;
+    }
+
+    public void setApiUUID(String apiUUID) {
+        this.apiUUID = apiUUID;
+    }
+
+    public String getRevisionUUID() {
+        return revisionUUID;
+    }
+
+    public void setRevisionUUID(String revisionUUID) {
+        this.revisionUUID = revisionUUID;
+    }
+}

components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/InMemoryAPIDeployer.java

@@ -33,7 +33,6 @@
 import org.apache.synapse.transport.dynamicconfigurations.DynamicProfileReloaderHolder;
 import org.wso2.carbon.apimgt.api.APIManagementException;
 import org.wso2.carbon.apimgt.api.ExceptionCodes;
-import org.wso2.carbon.apimgt.api.APIManagementException;
 import org.wso2.carbon.apimgt.api.gateway.GatewayAPIDTO;
 import org.wso2.carbon.apimgt.api.gateway.GatewayContentDTO;
 import org.wso2.carbon.apimgt.api.gateway.GraphQLSchemaDTO;
@@ -330,6 +329,8 @@ private void unDeployAPI(APIGatewayAdmin apiGatewayAdmin, DeployAPIInGatewayEven
                                 gatewayAPIDTO);
                         GatewayUtils.setEndpointsToBeRemoved(apiProductIdentifier, associatedApi.getUuid(),
                                 gatewayAPIDTO);
+                        GatewayUtils.setCustomBackendToBeRemoved(apiProductIdentifier, associatedApi.getUuid(),
+                                gatewayAPIDTO);
                     }
                 } else {
                     API api = new API(new APIIdentifier(gatewayEvent.getProvider(), gatewayEvent.getName(),
@@ -350,6 +351,8 @@ private void unDeployAPI(APIGatewayAdmin apiGatewayAdmin, DeployAPIInGatewayEven
                     }
 
                     GatewayUtils.setCustomSequencesToBeRemoved(api, gatewayAPIDTO);
+                    GatewayUtils.setCustomBackendToBeRemoved(gatewayAPIDTO);
+
                 }
                 gatewayAPIDTO.setLocalEntriesToBeRemove(
                         GatewayUtils

components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/handlers/common/APIMgtLatencyStatsHandler.java

@@ -109,11 +109,12 @@ public boolean handleResponse(MessageContext messageContext) {
         org.apache.axis2.context.MessageContext.setCurrentMessageContext(axis2MC);
         if (messageContext.getProperty(APIMgtGatewayConstants.BACKEND_REQUEST_END_TIME) == null) {
             messageContext.setProperty(APIMgtGatewayConstants.BACKEND_REQUEST_END_TIME, System.currentTimeMillis());
-            if (APIUtil.isAnalyticsEnabled()) {
-                long executionStartTime = Long.parseLong((String) messageContext.getProperty(APIMgtGatewayConstants
-                        .BACKEND_REQUEST_START_TIME));
-                messageContext.setProperty(APIMgtGatewayConstants.BACKEND_LATENCY, System.currentTimeMillis() -
-                        executionStartTime);
+            if (APIUtil.isAnalyticsEnabled()
+                    && messageContext.getProperty(APIMgtGatewayConstants.BACKEND_REQUEST_START_TIME) != null) {
+                long executionStartTime = Long.parseLong(
+                        (String) messageContext.getProperty(APIMgtGatewayConstants.BACKEND_REQUEST_START_TIME));
+                messageContext.setProperty(APIMgtGatewayConstants.BACKEND_LATENCY,
+                        System.currentTimeMillis() - executionStartTime);
             }
         }
         return true;

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

@@ -1783,6 +1783,8 @@ private ConfigParameters() {
     public static final String ENDPOINT_TYPE_SERVICE = "service";
     public static final String ENDPOINT_TYPE_ADDRESS = "address";
     public static final String ENDPOINT_TYPE_AWSLAMBDA = "awslambda";
+    public static final String ENDPOINT_TYPE_SEQUENCE = "sequence_backend";
+    public static final String SEQUENCE_DATA = "sequence";
     public static final String ENDPOINT_PRODUCTION_FAILOVERS = "production_failovers";
     public static final String ENDPOINT_SANDBOX_FAILOVERS = "sandbox_failovers";
     public static final String ENDPOINT_PRODUCTION_ENDPOINTS = "production_endpoints";

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

@@ -72,6 +72,7 @@
 import org.wso2.carbon.apimgt.api.model.BlockConditionsDTO;
 import org.wso2.carbon.apimgt.api.model.Comment;
 import org.wso2.carbon.apimgt.api.model.CommentList;
+import org.wso2.carbon.apimgt.api.model.SequenceBackendData;
 import org.wso2.carbon.apimgt.api.model.DeployedAPIRevision;
 import org.wso2.carbon.apimgt.api.model.Documentation;
 import org.wso2.carbon.apimgt.api.model.Documentation.DocumentSourceType;
@@ -1167,6 +1168,30 @@ private void updateAPIPolicies(API api, String tenantDomain) throws APIManagemen
         apiMgtDAO.updateAPIPoliciesMapping(api.getUuid(), api.getUriTemplates(), api.getApiPolicies(), tenantDomain);
     }
 
+    @Override
+    public void updateCustomBackend(String apiUUID, String type, String sequence, String seqName,
+            String customBackendUUID) throws APIManagementException {
+        apiMgtDAO.updateCustomBackend(apiUUID, seqName, sequence, type, customBackendUUID);
+    }
+
+    @Override
+    public SequenceBackendData getCustomBackendByAPIUUID(String apiUUID, String type) throws APIManagementException {
+        return apiMgtDAO.getCustomBackendByAPIUUID(apiUUID, type);
+    }
+
+    public List<SequenceBackendData> getAllSequenceBackendsByAPIUUID(String apiUUID) throws APIManagementException {
+        return apiMgtDAO.getSequenceBackendsByAPIUUID(apiUUID);
+    }
+
+    @Override
+    public void deleteCustomBackendByAPIID(String apiUUID) throws APIManagementException {
+        apiMgtDAO.deleteCustomBackendByAPIID(apiUUID);
+    }
+    @Override
+    public void deleteCustomBackendByID(String apiUUID, String type) throws APIManagementException {
+        apiMgtDAO.deleteCustomBackend(apiUUID, type);
+    }
+
     private void validateKeyManagers(API api) throws APIManagementException {
 
         Map<String, KeyManagerDto> tenantKeyManagers = KeyManagerHolder.getGlobalAndTenantKeyManagers(tenantDomain);
@@ -2561,6 +2586,8 @@ public void deleteAPI(String apiUuid, String organization) throws APIManagementE
         // DB delete operations
         if (!isError && api != null) {
             try {
+                // Remove Custom Backend entries of the API
+                deleteCustomBackendByAPIID(apiUuid);
                 deleteAPIRevisions(apiUuid, organization);
                 deleteAPIFromDB(api);
                 if (log.isDebugEnabled()) {
@@ -5361,6 +5388,12 @@ public boolean isSubscriptionValidationDisabled(String uuid) throws APIManagemen
         return !"ENABLED".equalsIgnoreCase(status);
     }
 
+    @Override
+    public void deleteSequenceBackendByRevision(String apiUUID, String revisionId)
+            throws APIManagementException {
+        apiMgtDAO.deleteCustomBackendByRevision(apiUUID, "0");
+    }
+
     @Override
     public API getAPIbyUUID(String uuid, String organization) throws APIManagementException {
         Organization org = new Organization(organization);
@@ -5383,6 +5416,7 @@ public API getAPIbyUUID(String uuid, String organization) throws APIManagementEx
                 if (APIConstants.API_SUBTYPE_AI_API.equals(api.getSubtype())) {
                     populateAiConfiguration(api);
                 }
+
                 if (APIUtil.isSequenceDefined(api.getInSequence()) || APIUtil.isSequenceDefined(api.getOutSequence())
                         || APIUtil.isSequenceDefined(api.getFaultSequence())) {
                     if (migrationEnabled == null) {
@@ -6099,6 +6133,7 @@ public String addAPIRevision(APIRevision apiRevision, String organization) throw
                     ExceptionCodes.from(ExceptionCodes.API_REVISION_UUID_NOT_FOUND));
         }
         apiRevision.setRevisionUUID(revisionUUID);
+
         try {
             apiMgtDAO.addAPIRevision(apiRevision);
             AIConfiguration configuration = apiMgtDAO.getAIConfiguration(apiRevision.getApiUUID(), null, organization);
@@ -6302,6 +6337,7 @@ public void deployAPIRevision(String apiId, String apiRevisionUUID,
             }
         }
         apiMgtDAO.addAPIRevisionDeployment(apiRevisionUUID, apiRevisionDeployments);
+
         WorkflowExecutor revisionDeploymentWFExecutor = getWorkflowExecutor(
                 WorkflowConstants.WF_TYPE_AM_REVISION_DEPLOYMENT);