FINERACT-1760: Batch API for datatable query update

fineract-provider/src/main/java/org/apache/fineract/batch/command/CommandStrategyProvider.java

@@ -114,9 +114,14 @@ public class CommandStrategyProvider {
                 "createDatatableEntryCommandStrategy");
         commandStrategies.put(CommandContext.resource("datatables\\/[a-zA-Z0-9_]*\\/\\d+\\/\\d+").method("PUT").build(),
                 "updateDatatableEntryOneToManyCommandStrategy");
+        commandStrategies.put(CommandContext.resource("datatables\\/[a-zA-Z0-9_]*\\/\\d+").method("PUT").build(),
+                "updateDatatableEntryOneToOneCommandStrategy");
         commandStrategies.put(
                 CommandContext.resource("datatables\\/[a-zA-Z0-9_]*\\/\\d+(\\?(\\w+(?:\\=[\\w,]+|&)+)+)").method("GET").build(),
                 "getDatatableEntryByAppTableIdCommandStrategy");
+        commandStrategies.put(
+                CommandContext.resource("datatables\\/[a-zA-Z0-9_]*\\/query(\\?(\\w+(?:\\=[\\w,]+|&)+)+)").method("GET").build(),
+                "getDatatableEntryByQueryCommandStrategy");
     }
 
 }

fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/GetDatatableEntryByQueryCommandStrategy.java

@@ -0,0 +1,99 @@
+/**
+ * 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 entry by query. 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 GetDatatableEntryByQueryCommandStrategy 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?genericResultSet=true)
+        // - Add them to the MutableUriInfo query parameters list
+        // - Call datatablesApiResource.getDatatable(dataTable, appTableId, null, uriInfo)
+        String columnFilter = null;
+        String valueFilter = null;
+        String resultColumns = null;
+        if (relativeUrl.indexOf('?') > 0) {
+            Map<String, String> queryParameters = CommandStrategyUtils.getQueryParameters(relativeUrl);
+            // Add the query parameters sent in the relative URL to MutableUriInfo
+            CommandStrategyUtils.addQueryParametersToUriInfo(parameterizedUriInfo, queryParameters);
+
+            for (Map.Entry<String, String> entry : queryParameters.entrySet()) {
+                switch (entry.getKey()) {
+                    case "columnFilter" -> columnFilter = entry.getValue();
+                    case "valueFilter" -> valueFilter = entry.getValue();
+                    case "resultColumns" -> resultColumns = entry.getValue();
+                }
+            }
+        }
+
+        String dataTableName = relativeUrlSubString.substring(0, relativeUrlSubString.indexOf("/"));
+
+        // Calls 'queryValues' function from 'DatatablesApiResource' to
+        // get the datatable details based on the filters
+        responseBody = dataTablesApiResource.queryValues(dataTableName, columnFilter, valueFilter, resultColumns, parameterizedUriInfo);
+
+        response.setStatusCode(HttpStatus.SC_OK);
+
+        // Sets the response after retrieving the datatable
+        response.setBody(responseBody);
+
+        return response;
+    }
+}

fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/UpdateDatatableEntryOneToManyCommandStrategy.java

@@ -29,9 +29,9 @@ import org.apache.fineract.infrastructure.dataqueries.api.DatatablesApiResource;
 import org.springframework.stereotype.Component;
 
 /**
- * Implements {@link CommandStrategy} and updates a datatable entry for a given loan. 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.
+ * Implements {@link CommandStrategy} and updates a datatable entry for a given entity. 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.
  *
  * @see CommandStrategy
  * @see BatchRequest
@@ -53,14 +53,14 @@ public class UpdateDatatableEntryOneToManyCommandStrategy implements CommandStra
         response.setHeaders(request.getHeaders());
 
         final List<String> pathParameters = Splitter.on('/').splitToList(request.getRelativeUrl());
-        // Pluck out the datatable name, loanId & datatable entry id out of the relative path
+        // Pluck out the datatable name, entity id & datatable entry id out of the relative path
         final String datatableName = pathParameters.get(1);
-        final Long loanId = Long.parseLong(pathParameters.get(2));
+        final Long entityId = Long.parseLong(pathParameters.get(2));
         final Long datatableEntryId = Long.parseLong(pathParameters.get(3));
 
         // Calls 'updateDatatableEntryOneToMany' function from
-        // 'DatatablesApiResource' to update a datatable entry on an existing loan in a one-many relationship
-        responseBody = datatablesApiResource.updateDatatableEntryOneToMany(datatableName, loanId, datatableEntryId, request.getBody());
+        // 'DatatablesApiResource' to update a datatable entry on an existing entity in a one-many relationship
+        responseBody = datatablesApiResource.updateDatatableEntryOneToMany(datatableName, entityId, datatableEntryId, request.getBody());
 
         response.setStatusCode(200);
         // Sets the body of the response after datatable entry is successfully

fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/UpdateDatatableEntryOneToOneCommandStrategy.java

@@ -0,0 +1,71 @@
+/**
+ * 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 com.google.common.base.Splitter;
+import java.util.List;
+import javax.ws.rs.core.UriInfo;
+import lombok.RequiredArgsConstructor;
+import org.apache.fineract.batch.command.CommandStrategy;
+import org.apache.fineract.batch.domain.BatchRequest;
+import org.apache.fineract.batch.domain.BatchResponse;
+import org.apache.fineract.infrastructure.dataqueries.api.DatatablesApiResource;
+import org.springframework.stereotype.Component;
+
+/**
+ * Implements {@link CommandStrategy} and updates a datatable entry for a given entity. 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.
+ *
+ * @see CommandStrategy
+ * @see BatchRequest
+ * @see BatchResponse
+ */
+@Component
+@RequiredArgsConstructor
+public class UpdateDatatableEntryOneToOneCommandStrategy implements CommandStrategy {
+
+    private final DatatablesApiResource datatablesApiResource;
+
+    @Override
+    public BatchResponse execute(BatchRequest request, @SuppressWarnings("unused") UriInfo uriInfo) {
+
+        final BatchResponse response = new BatchResponse();
+        final String responseBody;
+
+        response.setRequestId(request.getRequestId());
+        response.setHeaders(request.getHeaders());
+
+        final List<String> pathParameters = Splitter.on('/').splitToList(request.getRelativeUrl());
+        // Pluck out the datatable name, entity id & datatable entry id out of the relative path
+        final String datatableName = pathParameters.get(1);
+        final Long entityId = Long.parseLong(pathParameters.get(2));
+
+        // Calls 'updateDatatableEntryOneToMany' function from
+        // 'DatatablesApiResource' to update a datatable entry on an existing entity in a one-one relationship
+        responseBody = datatablesApiResource.updateDatatableEntryOnetoOne(datatableName, entityId, request.getBody());
+
+        response.setStatusCode(200);
+        // Sets the body of the response after datatable entry is successfully
+        // updated
+        response.setBody(responseBody);
+
+        return response;
+    }
+}