FINERACT-1724: More batch support for datatables APIs

2023-04-24 14:28:50 +02:00
parent d2082fe2cb
commit 636b33196b
6 changed files with 313 additions and 3 deletions
@@ -50,7 +50,7 @@ public class CommandStrategyProvider {
    /**
     * Regex pattern for specifying query params
     */
-    private static final String MANDATORY_QUERY_PARAM_REGEX = "(\\?(\\w+(?:\\=[\\w,]+|&)+)+)";
+    private static final String MANDATORY_QUERY_PARAM_REGEX = "(\\?(\\w+(?:\\=[\\w\\-,]+|&)+)+)";

    /**
     * Regex pattern for specifying any query param that has key = 'command' or not specific anything.
@@ -202,6 +202,9 @@ public class CommandStrategyProvider {
        commandStrategies.put(CommandContext
                .resource("datatables\\/" + ALPHANUMBERIC_WITH_UNDERSCORE_REGEX + "\\/" + NUMBER_REGEX + OPTIONAL_QUERY_PARAM_REGEX)
                .method(GET).build(), "getDatatableEntryByAppTableIdCommandStrategy");
+        commandStrategies.put(CommandContext.resource("datatables\\/" + ALPHANUMBERIC_WITH_UNDERSCORE_REGEX + "\\/" + NUMBER_REGEX + "\\/"
+                + NUMBER_REGEX + OPTIONAL_QUERY_PARAM_REGEX).method(GET).build(),
+                "getDatatableEntryByAppTableIdAndDataTableIdCommandStrategy");
        commandStrategies.put(CommandContext.resource("loans\\/" + NUMBER_REGEX + OPTIONAL_COMMAND_PARAM_REGEX).method(PUT).build(),
                "modifyLoanApplicationCommandStrategy");
        commandStrategies.put(
@@ -0,0 +1,95 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF 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.apache.fineract.batch.command.internal;
+
+import java.util.Map;
+import javax.ws.rs.core.UriInfo;
+import lombok.RequiredArgsConstructor;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.fineract.batch.command.CommandStrategy;
+import org.apache.fineract.batch.command.CommandStrategyUtils;
+import org.apache.fineract.batch.domain.BatchRequest;
+import org.apache.fineract.batch.domain.BatchResponse;
+import org.apache.fineract.infrastructure.core.api.MutableUriInfo;
+import org.apache.fineract.infrastructure.dataqueries.api.DatatablesApiResource;
+import org.apache.http.HttpStatus;
+import org.springframework.stereotype.Component;
+
+/**
+ * Implements {@link CommandStrategy} and get datatable by appTableId by data table id. It passes the contents of the
+ * body from the BatchRequest to {@link DatatablesApiResource} and gets back the response. This class will also catch
+ * any errors raised by {@link DatatablesApiResource} and map those errors to appropriate status codes in BatchResponse.
+ */
+@Component
+@RequiredArgsConstructor
+public class GetDatatableEntryByAppTableIdAndDataTableIdCommandStrategy implements CommandStrategy {
+
+    /**
+     * Data table api resource {@link DatatablesApiResource}.
+     */
+    private final DatatablesApiResource dataTablesApiResource;
+
+    @Override
+    public BatchResponse execute(final BatchRequest request, @SuppressWarnings("unused") UriInfo uriInfo) {
+        final MutableUriInfo parameterizedUriInfo = new MutableUriInfo(uriInfo);
+        final BatchResponse response = new BatchResponse();
+        final String responseBody;
+
+        response.setRequestId(request.getRequestId());
+        response.setHeaders(request.getHeaders());
+
+        final String relativeUrl = request.getRelativeUrl();
+        final String relativeUrlSubString = StringUtils.substringAfter(relativeUrl, "/");
+
+        // uriInfo will contain the query parameter value(s) that are sent in the actual batch uri.
+        // for example: batches?enclosingTransaction=true
+        // But the query parameters that are sent in the batch relative url has to be sent to
+        // datatablesApiResource.getDatatable
+        // To use the relative url query parameters
+        // - Parse and fetch the query parameters sent in the relative url
+        // (datatables/dt_123/1/2?genericResultSet=false)
+        // - Add them to the MutableUriInfo query parameters list
+        // - Call datatablesApiResource.getDatatableManyEntry(dataTable, appTableId, dataTableId, null, false, generic
+        // resultSet, uriInfo)
+        final String[] resources = StringUtils.split(relativeUrlSubString, "/");
+        final String dataTableName = resources[0];
+        final Long appTableId = Long.parseLong(resources[1]);
+        final Long dataTableId = Long.parseLong(StringUtils.substringBefore(resources[2], "?"));
+        boolean genericResultSet = false;
+        if (relativeUrl.indexOf('?') > 0) {
+            Map<String, String> queryParameters = CommandStrategyUtils.getQueryParameters(relativeUrl);
+            // Add the query parameters sent in the relative URL to MutableUriInfo
+            if (queryParameters.containsKey("genericResultSet")) {
+                genericResultSet = Boolean.parseBoolean(queryParameters.get("genericResultSet"));
+            }
+            CommandStrategyUtils.addQueryParametersToUriInfo(parameterizedUriInfo, queryParameters);
+        }
+        // Calls 'getDatatableManyEntry' function from 'DatatablesApiResource' to
+        // get the datatable details based on the appTableId
+        responseBody = dataTablesApiResource.getDatatableManyEntry(dataTableName, appTableId, dataTableId, null, genericResultSet,
+                parameterizedUriInfo);
+
+        response.setStatusCode(HttpStatus.SC_OK);
+
+        // Sets the response after retrieving the datatable
+        response.setBody(responseBody);
+
+        return response;
+    }
+}